components:
  examples:
    cache_cache_reserve_clear_completed:
      value:
        errors: []
        messages: []
        result:
          end_ts: "2023-10-02T12:00:00.12345Z"
          id: cache_reserve_clear
          start_ts: "2023-10-02T10:00:00.12345Z"
          state: Completed
        success: true
    cache_cache_reserve_clear_in_progress:
      value:
        errors: []
        messages: []
        result:
          id: cache_reserve_clear
          start_ts: "2023-10-02T10:00:00.12345Z"
          state: In-progress
        success: true
    cache_cache_reserve_clear_not_found:
      value:
        errors:
          - code: 1142
            message: Unable to retrieve cache_reserve_clear setting value. The zone setting does not exist because you never performed a Cache Reserve Clear operation.
        messages: []
        result:
        success: false
    cache_cache_reserve_clear_rejected_cr_on:
      value:
        errors:
          - code: 1152
            message: Turn off Cache Reserve sync to proceed with deletion.
        messages: []
        result:
        success: false
    cache_cache_reserve_denied_clearing:
      value:
        errors:
          - code: 1153
            message: Cache Reserve cannot be enabled because a deletion is already in progress.
        messages: []
        result:
        success: false
    cache_cache_reserve_off:
      value:
        errors: []
        messages: []
        result:
          editable: true
          id: cache_reserve
          value: "off"
        success: true
    cache_dummy_automatic_upgrader_disabled_response:
      value:
        errors: []
        messages: []
        result:
          editable: true
          id: ssl_tls_configuration_mode
          modified_on: "2014-01-01T05:20:00.12345Z"
          value: custom
        success: true
    cache_dummy_automatic_upgrader_enabled_response:
      value:
        errors: []
        messages: []
        result:
          editable: true
          id: ssl_tls_configuration_mode
          modified_on: "2014-01-01T05:20:00.12345Z"
          next_scheduled_scan: "2014-02-01T05:20:00.12345Z"
          value: auto
        success: true
    cache_dummy_error_response:
      value:
        errors:
          - code: 1008
            message: Invalid SSL/TLS encryption configuration value, only auto or custom accepted
        messages: []
        result:
        success: false
    cache_origin_max_http_version_2:
      value:
        errors: []
        messages: []
        result:
          editable: true
          id: origin_max_http_version
          value: "2"
        success: true
  parameters:
    api-shield_api_discovery_origin_parameter:
      description: |
        Filter results to only include discovery results sourced from a particular discovery engine
          * `ML` - Discovered operations that were sourced using ML API Discovery
          * `SessionIdentifier` - Discovered operations that were sourced using Session Identifier API Discovery
      in: query
      name: origin
      schema:
        $ref: '#/components/schemas/api-shield_api_discovery_origin'
    api-shield_api_discovery_state_parameter:
      description: |
        Filter results to only include discovery results in a particular state. States are as follows
          * `review` - Discovered operations that are not saved into API Shield Endpoint Management
          * `saved` - Discovered operations that are already saved into API Shield Endpoint Management
          * `ignored` - Discovered operations that have been marked as ignored
      in: query
      name: state
      schema:
        $ref: '#/components/schemas/api-shield_api_discovery_state'
    api-shield_diff_parameter:
      in: query
      name: diff
      schema:
        description: When `true`, only return API Discovery results that are not saved into API Shield Endpoint Management
        type: boolean
    api-shield_direction_parameter:
      in: query
      name: direction
      schema:
        description: Direction to order results.
        enum:
          - asc
          - desc
        example: desc
        type: string
    api-shield_endpoint_parameter:
      in: query
      name: endpoint
      schema:
        description: Filter results to only include endpoints containing this pattern.
        example: /api/v1
        type: string
    api-shield_host_parameter:
      in: query
      name: host
      schema:
        description: Filter results to only include the specified hosts.
        items:
          example: api.cloudflare.com
          type: string
        type: array
        uniqueItems: true
    api-shield_method_parameter:
      in: query
      name: method
      schema:
        description: Filter results to only include the specified HTTP methods.
        items:
          example: GET
          type: string
        type: array
        uniqueItems: true
    api-shield_omit_source:
      description: Omit the source-files of schemas and only retrieve their meta-data.
      in: query
      name: omit_source
      schema:
        default: false
        type: boolean
    api-shield_operation_feature_parameter:
      description: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
      in: query
      name: feature
      schema:
        example:
          - thresholds
        items:
          enum:
            - thresholds
            - parameter_schemas
            - schema_info
          example: thresholds
          type: string
        type: array
        uniqueItems: true
    api-shield_operation_id:
      description: Identifier for the operation
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      in: path
      name: operation_id
      required: true
      schema:
        $ref: '#/components/schemas/api-shield_uuid'
    api-shield_order_parameter:
      in: query
      name: order
      schema:
        description: Field to order by
        enum:
          - host
          - method
          - endpoint
          - traffic_stats.requests
          - traffic_stats.last_updated
        example: method
        type: string
    api-shield_page:
      description: Page number of paginated results.
      in: query
      name: page
      schema:
        default: 1
        minimum: 1
        type: integer
    api-shield_parameters-operation_id:
      description: Identifier for the discovered operation
      in: path
      name: operation_id
      required: true
      schema:
        $ref: '#/components/schemas/api-shield_schemas-uuid'
    api-shield_per_page:
      description: Maximum number of results per page.
      in: query
      name: per_page
      schema:
        default: 20
        maximum: 50
        minimum: 5
        type: integer
    api-shield_schema_id:
      description: Identifier for the schema-ID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      in: path
      name: schema_id
      required: true
      schema:
        format: uuid
        maxLength: 36
        readOnly: true
        type: string
    api-shield_zone_id:
      in: path
      name: zone_id
      required: true
      schema:
        $ref: '#/components/schemas/api-shield_schemas-identifier'
    dls_account_id:
      in: path
      name: account_id
      required: true
      schema:
        $ref: '#/components/schemas/dls_identifier'
    dls_hostname:
      in: path
      name: hostname
      required: true
      schema:
        $ref: '#/components/schemas/dls_hostname'
    dls_zone_id:
      in: path
      name: zone_id
      required: true
      schema:
        $ref: '#/components/schemas/dls_identifier'
    healthchecks_page:
      description: Page number of paginated results.
      in: query
      name: page
      schema:
        default: 1
        minimum: 1
        type: number
    healthchecks_per_page:
      description: Maximum number of results per page. Must be a multiple of 5.
      in: query
      name: per_page
      schema:
        default: 25
        maximum: 1000
        minimum: 5
        type: number
    waitingroom_page:
      description: Page number of paginated results.
      in: query
      name: page
      schema:
        default: 1
        minimum: 1
        type: number
    waitingroom_per_page:
      description: Maximum number of results per page. Must be a multiple of 5.
      in: query
      name: per_page
      schema:
        default: 25
        maximum: 1000
        minimum: 5
        type: number
  requestBodies:
    rulesets_CreateRuleset:
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/rulesets_Ruleset'
              - properties:
                  kind:
                    $ref: '#/components/schemas/rulesets_RulesetKind'
                  phase:
                    $ref: '#/components/schemas/rulesets_RulesetPhase'
                  rules:
                    $ref: '#/components/schemas/rulesets_RequestRules'
                required:
                  - name
                  - kind
                  - phase
                  - rules
      required: true
    rulesets_Rule:
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/rulesets_RequestRule'
              - properties:
                  position:
                    oneOf:
                      - allOf:
                          - $ref: '#/components/schemas/rulesets_RulePosition'
                          - properties:
                              before:
                                description: The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top.
                                example: da5e8e506c8e7877fe06cdf4c41add54
                                pattern: ^(?:[0-9a-f]{32})?$
                                title: Before
                                type: string
                            title: Before position
                      - allOf:
                          - $ref: '#/components/schemas/rulesets_RulePosition'
                          - properties:
                              after:
                                description: The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom.
                                example: 5bccdbb2a5142cd25cad8591255bd209
                                pattern: ^(?:[0-9a-f]{32})?$
                                title: After
                                type: string
                            title: After position
                      - allOf:
                          - $ref: '#/components/schemas/rulesets_RulePosition'
                          - properties:
                              index:
                                description: An index at which to place the rule, where index 1 is the first rule.
                                example: 1
                                minimum: 1
                                title: Index
                                type: number
                            title: Index position
      required: true
    rulesets_UpdateEntrypointRuleset:
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/rulesets_Ruleset'
              - properties:
                  rules:
                    $ref: '#/components/schemas/rulesets_RequestRules'
                required:
                  - rules
      required: true
    rulesets_UpdateRuleset:
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/rulesets_Ruleset'
              - properties:
                  kind:
                    $ref: '#/components/schemas/rulesets_RulesetKind'
                  phase:
                    $ref: '#/components/schemas/rulesets_RulesetPhase'
                  rules:
                    $ref: '#/components/schemas/rulesets_RequestRules'
                required:
                  - rules
      required: true
    workers_script_upload:
      content:
        application/javascript:
          schema:
            description: Raw javascript content comprising a Worker. Must be in service worker syntax.
            example: addEventListener('fetch', (event) => event.respondWith(new Response('OK')))
            type: string
        multipart/form-data:
          encoding:
            <any part name>:
              contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream, application/source-map
          schema:
            oneOf:
              - properties:
                  <any part name>:
                    description: A module comprising a Worker script, often a javascript file. Multiple modules may be provided as separate named parts, but at least one module must be present and referenced in the metadata as `main_module` or `body_part` by part name. Source maps may also be included using the `application/source-map` content type.
                    items:
                      format: binary
                      type: string
                    type: array
                  metadata:
                    description: JSON encoded metadata about the uploaded parts and Worker configuration.
                    properties:
                      bindings:
                        description: List of bindings available to the worker.
                        example:
                          - name: MY_ENV_VAR
                            text: my_data
                            type: plain_text
                        items:
                          additionalProperties:
                            x-stainless-any: true
                          properties:
                            name:
                              description: Name of the binding variable.
                              type: string
                            type:
                              description: 'Type of binding. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.'
                              type: string
                          type: object
                        type: array
                      body_part:
                        description: Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.
                        example: worker.js
                        type: string
                      compatibility_date:
                        description: Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
                        example: "2023-07-25"
                        type: string
                      compatibility_flags:
                        description: Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a `compatibility_date`.
                        items:
                          type: string
                        type: array
                      keep_bindings:
                        description: List of binding types to keep from previous_upload.
                        items:
                          type: string
                        type: array
                      logpush:
                        $ref: '#/components/schemas/workers_logpush'
                      main_module:
                        description: Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
                        example: worker.js
                        type: string
                      migrations:
                        description: Migrations to apply for Durable Objects associated with this Worker.
                        oneOf:
                          - $ref: '#/components/schemas/workers_single_step_migrations'
                          - $ref: '#/components/schemas/workers_stepped_migrations'
                      placement:
                        $ref: '#/components/schemas/workers_placement_config'
                      tags:
                        description: List of strings to use as tags for this Worker
                        items:
                          type: string
                        type: array
                      tail_consumers:
                        $ref: '#/components/schemas/workers_tail_consumers'
                      usage_model:
                        description: Usage model to apply to invocations.
                        enum:
                          - bundled
                          - unbound
                        type: string
                      version_tags:
                        additionalProperties:
                          type: string
                        description: Key-value pairs to use as tags for this version of this Worker
                        type: object
                    type: object
                type: object
              - properties:
                  message:
                    description: Rollback message to be associated with this deployment. Only parsed when query param `"rollback_to"` is present.
                    type: string
                type: object
        text/javascript:
          schema:
            description: Raw javascript content comprising a Worker. Must be in service worker syntax.
            example: addEventListener('fetch', (event) => event.respondWith(new Response('OK')))
            type: string
      required: true
    workers_version-post:
      content:
        multipart/form-data:
          encoding:
            <any part name>:
              contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream
          schema:
            properties:
              <any part name>:
                description: A module comprising a Worker script, often a javascript file. Multiple modules may be provided as separate named parts, but at least one module must be present and referenced in the metadata as `main_module`.
                items:
                  format: binary
                  type: string
                type: array
              metadata:
                description: JSON encoded metadata about the uploaded parts and Worker configuration.
                properties:
                  annotations:
                    properties:
                      workers/message:
                        description: Human-readable message about the version.
                        example: Fixed worker code.
                        maxLength: 50
                        type: string
                      workers/tag:
                        description: User-provided identifier for the version.
                        example: any-identifier-from-external-system
                        maxLength: 25
                        type: string
                    type: object
                  bindings:
                    description: List of bindings available to the worker.
                    example:
                      - name: MY_ENV_VAR
                        text: my_data
                        type: plain_text
                    items:
                      type: object
                    type: array
                  compatibility_date:
                    description: Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
                    example: "2023-07-25"
                    type: string
                  compatibility_flags:
                    description: Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a `compatibility_date`.
                    items:
                      type: string
                    type: array
                  keep_bindings:
                    description: List of binding types to keep from previous_upload.
                    items:
                      type: string
                    type: array
                  main_module:
                    description: Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
                    example: worker.js
                    type: string
                  usage_model:
                    description: Usage model to apply to invocations.
                    enum:
                      - standard
                    type: string
                type: object
            type: object
      required: true
  responses:
    email-security_ClientError:
      content:
        application/json:
          schema:
            properties:
              errors:
                example:
                  - code: 7003
                    message: No route for the URI
                items:
                  $ref: '#/components/schemas/email-security_Message'
                type: array
              messages:
                example: []
                items:
                  $ref: '#/components/schemas/email-security_Message'
                type: array
              result:
                nullable: true
                type: object
              success:
                example: false
                type: boolean
            required:
              - result
              - success
              - errors
              - messages
            type: object
      description: Client Error
    rulesets_Empty:
      description: An empty response.
    rulesets_Failure:
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/rulesets_Response'
              - properties:
                  result:
                    enum:
                      - 
                  success:
                    enum:
                      - false
      description: A failure response.
    rulesets_Ruleset:
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/rulesets_Response'
              - properties:
                  errors:
                    enum:
                      - []
                  result:
                    allOf:
                      - $ref: '#/components/schemas/rulesets_Ruleset'
                      - properties:
                          kind:
                            $ref: '#/components/schemas/rulesets_RulesetKind'
                          phase:
                            $ref: '#/components/schemas/rulesets_RulesetPhase'
                          rules:
                            $ref: '#/components/schemas/rulesets_ResponseRules'
                        required:
                          - name
                          - kind
                          - phase
                          - rules
                  success:
                    enum:
                      - true
      description: A ruleset response.
    rulesets_Rulesets:
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/rulesets_Response'
              - properties:
                  errors:
                    enum:
                      - []
                  result:
                    description: A list of rulesets. The returned information will not include the rules in each ruleset.
                    items:
                      allOf:
                        - $ref: '#/components/schemas/rulesets_Ruleset'
                        - properties:
                            kind:
                              $ref: '#/components/schemas/rulesets_RulesetKind'
                            phase:
                              $ref: '#/components/schemas/rulesets_RulesetPhase'
                          required:
                            - name
                            - kind
                            - phase
                    title: Rulesets
                    type: array
                  success:
                    enum:
                      - true
      description: A rulesets response.
    workers_4XX:
      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
                    logpush: false
                    modified_on: "2022-05-20T19:02:56.446492Z"
                    tail_consumers:
                      - environment: production
                        service: my-log-consumer
                    usage_model: bundled
                  success: true
              - $ref: '#/components/schemas/workers_api-response-common-failure'
      description: Upload Worker Module response failure
    workers_200:
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/workers_script-response-upload-single'
              - example:
                  errors: []
                  messages: []
                  result:
                    created_on: "2022-05-05T05:15:11.602148Z"
                    etag: 777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1
                    handlers:
                      - fetch
                    id: this-is_my_script-01
                    logpush: false
                    modified_on: "2022-05-20T19:02:56.446492Z"
                    placement_mode: smart
                    startup_time_ms: 10
                    tail_consumers:
                      - environment: production
                        service: my-log-consumer
                    usage_model: bundled
                  success: true
      description: Upload Worker Module response
  schemas:
    aaa_account-id:
      description: The account id
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    aaa_alert-types:
      properties:
        description:
          $ref: '#/components/schemas/aaa_description'
        display_name:
          $ref: '#/components/schemas/aaa_display_name'
        filter_options:
          $ref: '#/components/schemas/aaa_filter_options'
        type:
          $ref: '#/components/schemas/aaa_type'
      type: object
    aaa_alert_body:
      description: Message body included in the notification sent.
      example: SSL certificate has expired
      type: string
    aaa_alert_interval:
      description: Optional specification of how often to re-alert from the same incident, not support on all alert types.
      example: 30m
      type: string
    aaa_alert_type:
      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.
      enum:
        - access_custom_certificate_expiration_type
        - advanced_ddos_attack_l4_alert
        - advanced_ddos_attack_l7_alert
        - advanced_http_alert_error
        - bgp_hijack_notification
        - billing_usage_alert
        - block_notification_block_removed
        - block_notification_new_block
        - block_notification_review_rejected
        - brand_protection_alert
        - brand_protection_digest
        - clickhouse_alert_fw_anomaly
        - clickhouse_alert_fw_ent_anomaly
        - cloudforce_one_request_notification
        - custom_analytics
        - custom_ssl_certificate_event_type
        - dedicated_ssl_certificate_event_type
        - device_connectivity_anomaly_alert
        - dos_attack_l4
        - dos_attack_l7
        - expiring_service_token_alert
        - failing_logpush_job_disabled_alert
        - fbm_auto_advertisement
        - fbm_dosd_attack
        - fbm_volumetric_attack
        - health_check_status_notification
        - hostname_aop_custom_certificate_expiration_type
        - http_alert_edge_error
        - http_alert_origin_error
        - incident_alert
        - image_notification
        - load_balancing_health_alert
        - load_balancing_pool_enablement_alert
        - logo_match_alert
        - magic_tunnel_health_check_event
        - magic_wan_tunnel_health
        - maintenance_event_notification
        - mtls_certificate_store_certificate_expiration_type
        - pages_event_alert
        - radar_notification
        - real_origin_monitoring
        - scriptmonitor_alert_new_code_change_detections
        - scriptmonitor_alert_new_hosts
        - scriptmonitor_alert_new_malicious_hosts
        - scriptmonitor_alert_new_malicious_scripts
        - scriptmonitor_alert_new_malicious_url
        - scriptmonitor_alert_new_max_length_resource_url
        - scriptmonitor_alert_new_resources
        - secondary_dns_all_primaries_failing
        - secondary_dns_primaries_failing
        - secondary_dns_warning
        - secondary_dns_zone_successfully_updated
        - secondary_dns_zone_validation_warning
        - sentinel_alert
        - stream_live_notifications
        - synthetic_test_latency_alert
        - synthetic_test_low_availability_alert
        - traffic_anomalies_alert
        - tunnel_health_event
        - tunnel_update_event
        - universal_ssl_event_type
        - web_analytics_metrics_update
        - zone_aop_custom_certificate_expiration_type
      example: universal_ssl_event_type
      type: string
    aaa_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/aaa_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/aaa_result_info'
      type: object
    aaa_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/aaa_messages'
        messages:
          $ref: '#/components/schemas/aaa_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    aaa_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/aaa_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          $ref: '#/components/schemas/aaa_messages'
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    aaa_api-response-single:
      allOf:
        - $ref: '#/components/schemas/aaa_api-response-common'
      type: object
    aaa_audit-logs:
      properties:
        action:
          properties:
            result:
              description: A boolean that indicates if the action attempted was successful.
              example: true
              type: boolean
            type:
              description: A short string that describes the action that was performed.
              example: change_setting
              type: string
          type: object
        actor:
          properties:
            email:
              description: The email of the user that performed the action.
              example: michelle@example.com
              format: email
              type: string
            id:
              description: The ID of the actor that performed the action. If a user performed the action, this will be their User ID.
              example: f6b5de0326bb5182b8a4840ee01ec774
              type: string
            ip:
              description: The IP address of the request that performed the action.
              example: 198.41.129.166
              type: string
            type:
              description: The type of actor, whether a User, Cloudflare Admin, or an Automated System.
              enum:
                - user
                - admin
                - Cloudflare
              example: user
              type: string
          type: object
        id:
          description: A string that uniquely identifies the audit log.
          example: d5b0f326-1232-4452-8858-1089bd7168ef
          type: string
        interface:
          description: The source of the event.
          example: API
          type: string
        metadata:
          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
          type: object
        newValue:
          description: The new value of the resource that was modified.
          example: low
          type: string
        oldValue:
          description: The value of the resource before it was modified.
          example: high
          type: string
        owner:
          properties:
            id:
              $ref: '#/components/schemas/aaa_identifier'
          type: object
        resource:
          properties:
            id:
              description: An identifier for the resource that was affected by the action.
              example: 023e105f4ecef8ad9ca31a8372d0c353
              type: string
            type:
              description: A short string that describes the resource that was affected by the action.
              example: zone
              type: string
          type: object
        when:
          description: A UTC RFC3339 timestamp that specifies when the action being logged occured.
          example: "2017-04-26T17:31:07Z"
          format: date-time
          type: string
      type: object
    aaa_audit_logs_response_collection:
      oneOf:
        - properties:
            errors:
              $ref: '#/components/schemas/aaa_messages'
            messages:
              $ref: '#/components/schemas/aaa_messages'
            result:
              items:
                $ref: '#/components/schemas/aaa_audit-logs'
              type: array
            success:
              example: true
              type: boolean
        - $ref: '#/components/schemas/aaa_api-response-common'
    aaa_before:
      description: Limit the returned results to history records older than the specified date. This must be a timestamp that conforms to RFC3339.
      example: "2022-05-20T20:29:58.679897Z"
      format: date-time
      type: string
    aaa_components-schemas-description:
      description: Description of the notification policy (if present).
      example: Universal Certificate validation status, issuance, renewal, and expiration notices
      type: string
    aaa_components-schemas-name:
      description: The name of the webhook destination. This will be included in the request body when you receive a webhook notification.
      example: Slack Webhook
      type: string
    aaa_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/aaa_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/aaa_pagerduty'
              type: array
    aaa_components-schemas-type:
      description: Type of webhook endpoint.
      enum:
        - slack
        - generic
        - gchat
      example: slack
      type: string
    aaa_created_at:
      description: Timestamp of when the webhook destination was created.
      example: "2020-10-26T18:25:04.532316Z"
      format: date-time
      readOnly: true
      type: string
    aaa_description:
      description: Describes the alert type.
      example: High levels of 5xx HTTP errors at your origin
      type: string
    aaa_display_name:
      description: Alert type name.
      example: Origin Error Rate Alert
      type: string
    aaa_eligibility:
      properties:
        eligible:
          $ref: '#/components/schemas/aaa_eligible'
        ready:
          $ref: '#/components/schemas/aaa_ready'
        type:
          $ref: '#/components/schemas/aaa_schemas-type'
      type: object
    aaa_eligible:
      description: Determines whether or not the account is eligible for the delivery mechanism.
      example: true
      type: boolean
    aaa_enabled:
      default: true
      description: Whether or not the Notification policy is enabled.
      example: true
      type: boolean
    aaa_filter_options:
      description: 'Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings.'
      example:
        - AvailableValues:
          ComparisonOperator: ==
          Key: zones
          Range: 1-n
        - AvailableValues:
            - Description: Service-Level Objective of 99.7
              ID: "99.7"
            - Description: Service-Level Objective of 99.8
              ID: "99.8"
          ComparisonOperator: '>='
          Key: slo
          Range: 0-1
      items: {}
      type: array
    aaa_filters:
      description: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.
      example:
        slo:
          - "99.9"
      properties:
        actions:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        affected_asns:
          description: Used for configuring radar_notification
          items:
            type: string
          type: array
        affected_components:
          description: Used for configuring incident_alert
          example: 4c231tkdlpcl
          items:
            type: string
          type: array
        affected_locations:
          description: Used for configuring radar_notification
          items:
            type: string
          type: array
        airport_code:
          description: Used for configuring maintenance_event_notification
          items:
            type: string
          type: array
        alert_trigger_preferences:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        alert_trigger_preferences_value:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        enabled:
          description: Used for configuring load_balancing_pool_enablement_alert
          items:
            minItems: 1
            type: string
          type: array
        environment:
          description: Used for configuring pages_event_alert
          items:
            minItems: 1
            type: string
          type: array
        event:
          description: Used for configuring pages_event_alert
          items:
            minItems: 1
            type: string
          type: array
        event_source:
          description: Used for configuring load_balancing_health_alert
          items:
            type: string
          type: array
        event_type:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        group_by:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        health_check_id:
          description: Used for configuring health_check_status_notification
          items:
            type: string
          type: array
        incident_impact:
          description: Used for configuring incident_alert
          items:
            enum:
              - INCIDENT_IMPACT_NONE
              - INCIDENT_IMPACT_MINOR
              - INCIDENT_IMPACT_MAJOR
              - INCIDENT_IMPACT_CRITICAL
            type: string
          type: array
        input_id:
          description: Used for configuring stream_live_notifications
          items:
            type: string
          type: array
        limit:
          description: Used for configuring billing_usage_alert
          items:
            minItems: 1
            type: string
          type: array
        logo_tag:
          description: Used for configuring logo_match_alert
          items:
            type: string
          type: array
        megabits_per_second:
          description: Used for configuring advanced_ddos_attack_l4_alert
          items:
            type: string
          type: array
        new_health:
          description: Used for configuring load_balancing_health_alert
          items:
            type: string
          type: array
        new_status:
          description: Used for configuring tunnel_health_event
          items:
            type: string
          type: array
        packets_per_second:
          description: Used for configuring advanced_ddos_attack_l4_alert
          items:
            type: string
          type: array
        pool_id:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        pop_name:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        product:
          description: Used for configuring billing_usage_alert
          items:
            minItems: 1
            type: string
          type: array
        project_id:
          description: Used for configuring pages_event_alert
          items:
            minItems: 1
            type: string
          type: array
        protocol:
          description: Used for configuring advanced_ddos_attack_l4_alert
          items:
            type: string
          type: array
        query_tag:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        requests_per_second:
          description: Used for configuring advanced_ddos_attack_l7_alert
          items:
            type: string
          type: array
        selectors:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        services:
          description: Used for configuring clickhouse_alert_fw_ent_anomaly
          items:
            minItems: 1
            type: string
          type: array
        slo:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        status:
          description: Used for configuring health_check_status_notification
          items:
            minItems: 1
            type: string
          type: array
        target_hostname:
          description: Used for configuring advanced_ddos_attack_l7_alert
          items:
            type: string
          type: array
        target_ip:
          description: Used for configuring advanced_ddos_attack_l4_alert
          items:
            type: string
          type: array
        target_zone_name:
          description: Used for configuring advanced_ddos_attack_l7_alert
          items:
            type: string
          type: array
        traffic_exclusions:
          description: Used for configuring traffic_anomalies_alert
          items:
            enum:
              - security_events
            maxItems: 1
            type: string
          type: array
        tunnel_id:
          description: Used for configuring tunnel_health_event
          items:
            type: string
          type: array
        tunnel_name:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        where:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        zones:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
      type: object
    aaa_history:
      properties:
        alert_body:
          $ref: '#/components/schemas/aaa_alert_body'
        alert_type:
          $ref: '#/components/schemas/aaa_schemas-alert_type'
        description:
          $ref: '#/components/schemas/aaa_components-schemas-description'
        id:
          $ref: '#/components/schemas/aaa_uuid'
        mechanism:
          $ref: '#/components/schemas/aaa_mechanism'
        mechanism_type:
          $ref: '#/components/schemas/aaa_mechanism_type'
        name:
          $ref: '#/components/schemas/aaa_schemas-name'
        policy_id:
          $ref: '#/components/schemas/aaa_policy-id'
        sent:
          $ref: '#/components/schemas/aaa_sent'
      type: object
    aaa_history_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/aaa_api-response-collection'
        - properties:
            result:
              example:
                - alert_body:
                    data:
                      custom_csr_id: ""
                      expires_on:
                      hosts: []
                      id: "11111111111"
                      issuer: ""
                      method: txt
                      serial_number: ""
                      settings:
                      signature: ""
                      status: ""
                      type: ""
                      uploaded_on:
                      validation_errors: []
                      validation_records:
                        - cname: ""
                          cname_target: ""
                          emails: []
                          http_body: ""
                          http_url: ""
                          txt_name: _acme-challenge.example.com
                          txt_value: "11111111111"
                    metadata:
                      account:
                      event:
                        created_at:
                        id: ""
                        type: ssl.certificate.validation.failed
                      zone:
                        id: "11111111111"
                  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
                  policy_id: 35040955-3102-4710-938c-0f4eaf736e25
                  sent: "2021-10-08T17:52:17.571336Z"
              items:
                $ref: '#/components/schemas/aaa_history'
              type: array
            result_info:
              example:
                count: 1
                page: 1
                per_page: 20
              type: object
    aaa_id_response:
      allOf:
        - $ref: '#/components/schemas/aaa_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/aaa_uuid'
              type: object
    aaa_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    aaa_integration-token:
      description: The token integration key
      example: 8c71e667571b4f61b94d9e4b12158038
      maxLength: 32
      readOnly: true
      type: string
    aaa_last_failure:
      description: Timestamp of the last time an attempt to dispatch a notification to this webhook failed.
      example: "2020-10-26T18:25:04.532316Z"
      format: date-time
      readOnly: true
      type: string
    aaa_last_success:
      description: Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook.
      example: "2020-10-26T18:25:04.532316Z"
      format: date-time
      readOnly: true
      type: string
    aaa_mechanism:
      description: The mechanism to which the notification has been dispatched.
      example: test@example.com
      type: string
    aaa_mechanism_type:
      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
      type: string
    aaa_mechanisms:
      additionalProperties:
        items:
          properties:
            id:
              oneOf:
                - $ref: '#/components/schemas/aaa_uuid'
                - description: The email address
                  type: string
          type: object
        type: array
      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
      type: object
    aaa_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    aaa_name:
      description: The name of the pagerduty service.
      example: My PagerDuty Service
      type: string
    aaa_pagerduty:
      properties:
        id:
          $ref: '#/components/schemas/aaa_uuid'
        name:
          $ref: '#/components/schemas/aaa_name'
      type: object
    aaa_per_page:
      default: 25
      description: Number of items per page.
      maximum: 1000
      minimum: 5
      type: number
    aaa_policies:
      properties:
        alert_interval:
          $ref: '#/components/schemas/aaa_alert_interval'
        alert_type:
          $ref: '#/components/schemas/aaa_alert_type'
        created:
          $ref: '#/components/schemas/aaa_timestamp'
        description:
          $ref: '#/components/schemas/aaa_schemas-description'
        enabled:
          $ref: '#/components/schemas/aaa_enabled'
        filters:
          $ref: '#/components/schemas/aaa_filters'
        id:
          $ref: '#/components/schemas/aaa_policy-id'
        mechanisms:
          $ref: '#/components/schemas/aaa_mechanisms'
        modified:
          $ref: '#/components/schemas/aaa_timestamp'
        name:
          $ref: '#/components/schemas/aaa_schemas-name'
      type: object
    aaa_policies_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/aaa_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/aaa_policies'
              type: array
    aaa_policy-id:
      description: The unique identifier of a notification policy
      example: 0da2b59e-f118-439d-8097-bdfb215203c9
      maxLength: 36
      readOnly: true
      type: string
    aaa_ready:
      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
      type: boolean
    aaa_response_collection:
      allOf:
        - $ref: '#/components/schemas/aaa_api-response-collection'
        - properties:
            result:
              additionalProperties:
                items:
                  $ref: '#/components/schemas/aaa_alert-types'
                type: array
              example:
                Origin Monitoring:
                  - description: High levels of 5xx HTTP errors at your origin.
                    display_name: Origin Error Rate Alert
                    filter_options:
                      - AvailableValues:
                        ComparisonOperator: ==
                        Key: zones
                        Range: 1-n
                      - AvailableValues:
                          - Description: Service-Level Objective of 99.7
                            ID: "99.7"
                          - Description: Service-Level Objective of 99.8
                            ID: "99.8"
                        ComparisonOperator: '>='
                        Key: slo
                        Range: 0-1
                    type: http_alert_origin_error
              type: object
    aaa_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    aaa_schemas-alert_type:
      description: Type of notification that has been dispatched.
      example: universal_ssl_event_type
      type: string
    aaa_schemas-api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/aaa_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/aaa_messages'
          example: []
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    aaa_schemas-description:
      description: Optional description for the Notification policy.
      example: Something describing the policy.
      type: string
    aaa_schemas-name:
      description: Name of the policy.
      example: SSL Notification Event Policy
      type: string
    aaa_schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/aaa_api-response-collection'
        - properties:
            result:
              additionalProperties:
                items:
                  $ref: '#/components/schemas/aaa_eligibility'
                type: array
              example:
                email:
                  eligible: true
                  ready: true
                  type: email
              type: object
    aaa_schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/aaa_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/aaa_webhooks'
    aaa_schemas-type:
      description: Determines type of delivery mechanism.
      enum:
        - email
        - pagerduty
        - webhook
      example: email
      type: string
    aaa_secret:
      description: Optional secret that will be passed in the `cf-webhook-auth` header when dispatching generic webhook notifications or formatted for supported destinations. Secrets are not returned in any API response body.
      type: string
    aaa_sensitive_id_response:
      allOf:
        - $ref: '#/components/schemas/aaa_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/aaa_token'
              type: object
    aaa_sent:
      description: Timestamp of when the notification was dispatched in ISO 8601 format.
      example: "2021-10-08T17:52:17.571336Z"
      format: date-time
      type: string
    aaa_single_response:
      allOf:
        - $ref: '#/components/schemas/aaa_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/aaa_policies'
    aaa_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      readOnly: true
      type: string
    aaa_token:
      description: token in form of UUID
      example: a313ba7d-3e46-4c0e-a408-08fafbc3816a
      maxLength: 36
      readOnly: true
      type: string
    aaa_type:
      description: Use this value when creating and updating a notification policy.
      example: http_alert_origin_error
      type: string
    aaa_url:
      description: The POST endpoint to call when dispatching a notification.
      example: https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd
      type: string
    aaa_uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      readOnly: true
      type: string
      x-auditable: true
    aaa_webhook-id:
      description: The unique identifier of a webhook
      example: b115d5ec-15c6-41ee-8b76-92c449b5227b
      maxLength: 36
      readOnly: true
      type: string
    aaa_webhooks:
      properties:
        created_at:
          $ref: '#/components/schemas/aaa_created_at'
        id:
          $ref: '#/components/schemas/aaa_webhook-id'
        last_failure:
          $ref: '#/components/schemas/aaa_last_failure'
        last_success:
          $ref: '#/components/schemas/aaa_last_success'
        name:
          $ref: '#/components/schemas/aaa_components-schemas-name'
        secret:
          $ref: '#/components/schemas/aaa_secret'
        type:
          $ref: '#/components/schemas/aaa_components-schemas-type'
        url:
          $ref: '#/components/schemas/aaa_url'
      type: object
    aaa_webhooks_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/aaa_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/aaa_webhooks'
              type: array
    access_access-requests:
      properties:
        action:
          $ref: '#/components/schemas/access_action'
        allowed:
          $ref: '#/components/schemas/access_allowed'
        app_domain:
          $ref: '#/components/schemas/access_app_domain'
        app_uid:
          $ref: '#/components/schemas/access_app_uid'
        connection:
          $ref: '#/components/schemas/access_connection'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        ip_address:
          $ref: '#/components/schemas/access_ip'
        ray_id:
          $ref: '#/components/schemas/access_ray_id'
        user_email:
          $ref: '#/components/schemas/access_schemas-email'
      type: object
    access_access-requests_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_access-requests'
              type: array
    access_access_group_rule:
      description: Matches an Access group.
      properties:
        group:
          properties:
            id:
              description: The ID of a previously created Access group.
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
              type: string
          required:
            - id
          type: object
      required:
        - group
      title: Access groups
      type: object
    access_access_seat:
      description: True if the seat is part of Access.
      example: false
      type: boolean
    access_action:
      description: The event that occurred, such as a login attempt.
      example: login
      type: string
    access_active_device_count:
      description: The number of active devices registered to the user.
      example: 2
      type: number
    access_active_session_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/access_identity'
                - properties:
                    isActive:
                      example: true
                      type: boolean
                  type: object
              type: object
    access_active_sessions_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                properties:
                  expiration:
                    example: 1.694813506e+09
                    type: integer
                  metadata:
                    properties:
                      apps:
                        additionalProperties:
                          properties:
                            hostname:
                              example: test.example.com
                              type: string
                            name:
                              example: app name
                              type: string
                            type:
                              example: self_hosted
                              type: string
                            uid:
                              example: cc2a8145-0128-4429-87f3-872c4d380c4e
                              type: string
                          type: object
                        type: object
                      expires:
                        example: 1.694813506e+09
                        type: integer
                      iat:
                        example: 1.694791905e+09
                        type: integer
                      nonce:
                        example: X1aXj1lFVcqqyoXF
                        type: string
                      ttl:
                        example: 21600
                        type: integer
                    type: object
                  name:
                    type: string
                type: object
              type: array
    access_allow_all_headers:
      description: Allows all HTTP request headers.
      example: true
      type: boolean
    access_allow_all_methods:
      description: Allows all HTTP request methods.
      type: boolean
    access_allow_all_origins:
      description: Allows all origins.
      type: boolean
    access_allow_authenticate_via_warp:
      description: When set to true, users can authenticate via WARP for any application in your organization. Application settings will take precedence over this value.
      example: "false"
      type: boolean
    access_allow_credentials:
      description: When set to `true`, includes credentials (cookies, authorization headers, or TLS client certificates) with requests.
      type: boolean
    access_allowed:
      default: false
      description: The result of the authentication event.
      type: boolean
    access_allowed_headers:
      description: Allowed HTTP request headers.
      items:
        type: string
      type: array
    access_allowed_idps:
      description: The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account.
      items:
        description: The identity providers selected for application.
        example: 699d98642c564d2e855e9661899b7252
        type: string
      type: array
    access_allowed_methods:
      description: Allowed HTTP request methods.
      example:
        - GET
      items:
        enum:
          - GET
          - POST
          - HEAD
          - PUT
          - DELETE
          - CONNECT
          - OPTIONS
          - TRACE
          - PATCH
        type: string
      type: array
    access_allowed_origins:
      description: Allowed origins.
      example:
        - https://example.com
      items:
        type: string
      type: array
    access_any_valid_service_token_rule:
      description: Matches any valid Access Service Token
      properties:
        any_valid_service_token:
          description: An empty object which matches on all service tokens.
          example: {}
          type: object
      required:
        - any_valid_service_token
      title: Any Valid Service Token
      type: object
    access_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/access_result_info'
      type: object
    access_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/access_messages'
        messages:
          $ref: '#/components/schemas/access_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    access_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/access_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/access_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    access_api-response-single:
      allOf:
        - $ref: '#/components/schemas/access_api-response-common'
      type: object
    access_app-policies_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_app_policy_response'
              type: array
    access_app-policies_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_app_policy_response'
    access_app_count:
      description: Number of access applications currently using this policy.
      example: 2
      type: integer
    access_app_domain:
      description: The URL of the Access application.
      example: test.example.com/admin
      type: string
    access_app_id:
      oneOf:
        - $ref: '#/components/schemas/access_identifier'
        - $ref: '#/components/schemas/access_uuid'
    access_app_launcher_logo_url:
      description: The image URL of the logo shown in the App Launcher header.
      example: https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg
      type: string
    access_app_launcher_props:
      allOf:
        - $ref: '#/components/schemas/access_feature_app_props'
        - properties:
            domain:
              example: authdomain.cloudflareaccess.com
              readOnly: true
            name:
              default: App Launcher
              example: App Launcher
              readOnly: true
            type:
              description: The application type.
              example: app_launcher
              type: string
    access_app_launcher_visible:
      default: true
      description: Displays the application in the App Launcher.
      example: true
      type: boolean
    access_app_policy_link:
      description: A JSON that links a reusable policy to an application.
      properties:
        id:
          $ref: '#/components/schemas/access_schemas-uuid'
        precedence:
          $ref: '#/components/schemas/access_precedence'
      type: object
    access_app_policy_request:
      allOf:
        - properties:
            precedence:
              $ref: '#/components/schemas/access_precedence'
          type: object
        - $ref: '#/components/schemas/access_policy_req'
    access_app_policy_response:
      allOf:
        - $ref: '#/components/schemas/access_policy_resp'
      properties:
        precedence:
          $ref: '#/components/schemas/access_precedence'
      type: object
    access_app_req_embedded_policies:
      properties:
        policies:
          description: The policies that will apply to the application, in ascending order of precedence. Items can reference existing policies or create new policies exclusive to the application.
          items:
            oneOf:
              - $ref: '#/components/schemas/access_app_policy_link'
              - allOf:
                  - description: A policy UID to link to this application.
                  - $ref: '#/components/schemas/access_schemas-uuid'
              - allOf:
                  - type: object
                  - description: An application-scoped policy JSON. If the policy does not yet exist, it will be created.
                    properties:
                      id:
                        $ref: '#/components/schemas/access_schemas-uuid'
                  - $ref: '#/components/schemas/access_app_policy_request'
          type: array
      type: object
    access_app_req_embedded_scim_config:
      properties:
        scim_config:
          $ref: '#/components/schemas/access_scim_config'
      type: object
    access_app_request:
      anyOf:
        - allOf:
            - $ref: '#/components/schemas/access_self_hosted_props'
            - $ref: '#/components/schemas/access_app_req_embedded_policies'
            - $ref: '#/components/schemas/access_app_req_embedded_scim_config'
          title: Self Hosted Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_saas_props'
            - $ref: '#/components/schemas/access_app_req_embedded_policies'
            - $ref: '#/components/schemas/access_app_req_embedded_scim_config'
          title: SaaS Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_ssh_props'
            - $ref: '#/components/schemas/access_app_req_embedded_policies'
            - $ref: '#/components/schemas/access_app_req_embedded_scim_config'
          title: Browser SSH Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_vnc_props'
            - $ref: '#/components/schemas/access_app_req_embedded_policies'
            - $ref: '#/components/schemas/access_app_req_embedded_scim_config'
          title: Browser VNC Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_app_launcher_props'
            - $ref: '#/components/schemas/access_app_req_embedded_policies'
            - $ref: '#/components/schemas/access_app_req_embedded_scim_config'
          title: App Launcher Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_warp_props'
            - $ref: '#/components/schemas/access_app_req_embedded_policies'
            - $ref: '#/components/schemas/access_app_req_embedded_scim_config'
          title: Device Enrollment Permissions Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_biso_props'
            - $ref: '#/components/schemas/access_app_req_embedded_policies'
            - $ref: '#/components/schemas/access_app_req_embedded_scim_config'
          title: Browser Isolation Permissions Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_bookmark_props'
            - $ref: '#/components/schemas/access_app_req_embedded_scim_config'
          title: Bookmark application
          type: object
    access_app_resp_embedded_policies:
      description: The policies that will apply to the application.
      properties:
        policies:
          items:
            $ref: '#/components/schemas/access_app_policy_response'
          type: array
      type: object
    access_app_response:
      anyOf:
        - allOf:
            - $ref: '#/components/schemas/access_basic_app_response_props'
            - $ref: '#/components/schemas/access_self_hosted_props'
            - $ref: '#/components/schemas/access_app_resp_embedded_policies'
          title: Self Hosted Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_basic_app_response_props'
            - $ref: '#/components/schemas/access_saas_props'
            - $ref: '#/components/schemas/access_app_resp_embedded_policies'
          title: SaaS Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_basic_app_response_props'
            - $ref: '#/components/schemas/access_ssh_props'
            - $ref: '#/components/schemas/access_app_resp_embedded_policies'
          title: Browser SSH Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_basic_app_response_props'
            - $ref: '#/components/schemas/access_vnc_props'
            - $ref: '#/components/schemas/access_app_resp_embedded_policies'
          title: Browser VNC Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_basic_app_response_props'
            - $ref: '#/components/schemas/access_app_launcher_props'
            - $ref: '#/components/schemas/access_app_resp_embedded_policies'
          title: App Launcher Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_basic_app_response_props'
            - $ref: '#/components/schemas/access_warp_props'
            - $ref: '#/components/schemas/access_app_resp_embedded_policies'
          title: Device Enrollment Permissions Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_basic_app_response_props'
            - $ref: '#/components/schemas/access_biso_props'
            - $ref: '#/components/schemas/access_app_resp_embedded_policies'
          title: Browser Isolation Permissions Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_basic_app_response_props'
            - $ref: '#/components/schemas/access_bookmark_props'
          title: Bookmark application
          type: object
    access_app_uid:
      description: The unique identifier for the Access application.
      example: df7e2w5f-02b7-4d9d-af26-8d1988fca630
      type: string
    access_approval_group:
      description: A group of email addresses that can approve a temporary authentication request.
      properties:
        approvals_needed:
          description: The number of approvals needed to obtain access.
          example: 1
          minimum: 0
          type: number
        email_addresses:
          description: A list of emails that can approve the access request.
          example:
            - test@cloudflare.com
            - test2@cloudflare.com
          items:
            type: string
          type: array
        email_list_uuid:
          description: The UUID of an re-usable email list.
          type: string
      required:
        - approvals_needed
      type: object
    access_approval_groups:
      description: Administrators who can approve a temporary authentication request.
      example:
        - approvals_needed: 1
          email_addresses:
            - test1@cloudflare.com
            - test2@cloudflare.com
        - approvals_needed: 3
          email_list_uuid: 597147a1-976b-4ef2-9af0-81d5d007fc34
      items:
        $ref: '#/components/schemas/access_approval_group'
      type: array
    access_approval_required:
      default: false
      description: Requires the user to request access from an administrator at the start of each session.
      example: true
      type: boolean
    access_apps:
      anyOf:
        - allOf:
            - $ref: '#/components/schemas/access_schemas-basic_app_response_props'
            - $ref: '#/components/schemas/access_schemas-self_hosted_props'
          title: Self Hosted Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_schemas-basic_app_response_props'
            - $ref: '#/components/schemas/access_schemas-saas_props'
          title: SaaS Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_schemas-basic_app_response_props'
            - $ref: '#/components/schemas/access_schemas-ssh_props'
          title: Browser SSH Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_schemas-basic_app_response_props'
            - $ref: '#/components/schemas/access_schemas-vnc_props'
          title: Browser VNC Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_schemas-basic_app_response_props'
            - $ref: '#/components/schemas/access_schemas-app_launcher_props'
          title: App Launcher Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_schemas-basic_app_response_props'
            - $ref: '#/components/schemas/access_schemas-warp_props'
          title: Device Enrollment Permissions Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_schemas-basic_app_response_props'
            - $ref: '#/components/schemas/access_schemas-biso_props'
          title: Browser Isolation Permissions Application
          type: object
        - allOf:
            - $ref: '#/components/schemas/access_schemas-basic_app_response_props'
            - $ref: '#/components/schemas/access_schemas-bookmark_props'
          title: Bookmark application
          type: object
      type: object
    access_apps_components-schemas-name:
      description: The name of the application.
      example: Admin Site
      type: string
    access_apps_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_app_response'
              type: array
    access_apps_components-schemas-response_collection-2:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_apps'
              type: array
    access_apps_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_app_response'
    access_apps_components-schemas-single_response-2:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_apps'
    access_associated_hostnames:
      description: The hostnames of the applications that will use this certificate.
      items:
        description: A fully-qualified domain name (FQDN).
        example: admin.example.com
        type: string
      type: array
    access_aud:
      description: The Application Audience (AUD) tag. Identifies the application associated with the CA.
      example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893
      maxLength: 64
      readOnly: true
      type: string
    access_auth_domain:
      description: The unique subdomain assigned to your Zero Trust organization.
      example: test.cloudflareaccess.com
      type: string
    access_authentication_method_rule:
      description: Enforce different MFA options
      properties:
        auth_method:
          properties:
            auth_method:
              description: The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176#section-2.
              example: mfa
              type: string
          required:
            - auth_method
          type: object
      required:
        - auth_method
      title: Authentication method
      type: object
    access_auto_redirect_to_identity:
      default: false
      description: When set to `true`, users skip the identity provider selection step during login.
      type: boolean
    access_azure_group_rule:
      description: |-
        Matches an Azure group.
        Requires an Azure identity provider.
      properties:
        azureAD:
          properties:
            id:
              description: The ID of an Azure group.
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
              type: string
            identity_provider_id:
              description: The ID of your Azure identity provider.
              example: ea85612a-29c8-46c2-bacb-669d65136971
              type: string
          required:
            - id
            - identity_provider_id
          type: object
      required:
        - azureAD
      title: Azure group
      type: object
    access_azureAD:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - $ref: '#/components/schemas/access_custom-claims-support'
                - properties:
                    conditional_access_enabled:
                      description: Should Cloudflare try to load authentication contexts from your account
                      type: boolean
                    directory_id:
                      description: Your Azure directory uuid
                      example: <your azure directory uuid>
                      type: string
                    prompt:
                      description: Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether.
                      enum:
                        - login
                        - select_account
                        - none
                      type: string
                    support_groups:
                      description: Should Cloudflare try to load groups from your account
                      type: boolean
                  type: object
          type: object
      title: Azure AD
      type: object
    access_basic_app_response_props:
      properties:
        aud:
          $ref: '#/components/schemas/access_schemas-aud'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        id:
          $ref: '#/components/schemas/access_uuid'
        scim_config:
          $ref: '#/components/schemas/access_scim_config'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_bg_color:
      description: The background color of the App Launcher page.
      example: '#ff0000'
      type: string
    access_biso_props:
      allOf:
        - $ref: '#/components/schemas/access_feature_app_props'
        - properties:
            domain:
              example: authdomain.cloudflareaccess.com/browser
              readOnly: true
            name:
              default: Clientless Web Isolation
              example: Clientless Web Isolation
              readOnly: true
            type:
              description: The application type.
              example: biso
              type: string
    access_bookmark_props:
      properties:
        app_launcher_visible:
          $ref: '#/components/schemas/access_app_launcher_visible'
        domain:
          description: The URL or domain of the bookmark.
          example: https://mybookmark.com
          type: string
        logo_url:
          $ref: '#/components/schemas/access_logo_url'
        name:
          $ref: '#/components/schemas/access_apps_components-schemas-name'
        tags:
          $ref: '#/components/schemas/access_tags'
        type:
          description: The application type.
          example: bookmark
          type: string
      title: Bookmark application
      type: object
    access_bookmarks:
      properties:
        app_launcher_visible:
          $ref: '#/components/schemas/access_schemas-app_launcher_visible'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        domain:
          $ref: '#/components/schemas/access_schemas-domain'
        id:
          description: The unique identifier for the Bookmark application.
          type: string
        logo_url:
          $ref: '#/components/schemas/access_logo_url'
        name:
          $ref: '#/components/schemas/access_bookmarks_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_bookmarks_components-schemas-name:
      description: The name of the Bookmark application.
      example: My Website
      type: string
    access_bookmarks_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_bookmarks'
              type: array
    access_bookmarks_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_bookmarks'
    access_button_color:
      description: The background color of the log in button on the landing page.
      example: '#ff0000'
      type: string
    access_button_text_color:
      description: The color of the text in the log in button on the landing page.
      example: '#ff0000'
      type: string
    access_ca:
      properties:
        aud:
          $ref: '#/components/schemas/access_aud'
        id:
          $ref: '#/components/schemas/access_id'
        public_key:
          $ref: '#/components/schemas/access_public_key'
      type: object
    access_ca_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_ca'
              type: array
    access_ca_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              type: object
    access_centrify:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - $ref: '#/components/schemas/access_custom-claims-support'
                - properties:
                    centrify_account:
                      description: Your centrify account url
                      example: https://abc123.my.centrify.com/
                      type: string
                    centrify_app_id:
                      description: Your centrify app id
                      example: exampleapp
                      type: string
                  type: object
          type: object
      title: Centrify
      type: object
    access_certificate_rule:
      description: Matches any valid client certificate.
      example:
        certificate: {}
      properties:
        certificate:
          example: {}
          type: object
      required:
        - certificate
      title: Valid certificate
      type: object
    access_certificates:
      properties:
        associated_hostnames:
          $ref: '#/components/schemas/access_associated_hostnames'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        expires_on:
          $ref: '#/components/schemas/access_timestamp'
        fingerprint:
          $ref: '#/components/schemas/access_fingerprint'
        id:
          description: The ID of the application that will use this certificate.
          type: string
        name:
          $ref: '#/components/schemas/access_certificates_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_certificates_components-schemas-name:
      description: The name of the certificate.
      example: Allow devs
      type: string
    access_certificates_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_certificates'
              type: array
    access_certificates_components-schemas-response_collection-2:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_schemas-certificates'
              type: array
    access_certificates_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_certificates'
    access_certificates_components-schemas-single_response-2:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_schemas-certificates'
    access_client_id:
      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
      type: string
    access_client_secret:
      description: The Client Secret for the service token. Access will check for this value in the `CF-Access-Client-Secret` request header.
      example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5
      type: string
    access_components-schemas-domain:
      description: The domain and path that Access will secure.
      example: test.example.com/admin
      type: string
    access_components-schemas-id_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-common'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/access_uuid'
              type: object
    access_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
      type: string
    access_components-schemas-name:
      description: The name of the identity provider, shown to users on the login page.
      example: Widget Corps IDP
      type: string
    access_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_service-tokens'
              type: array
    access_components-schemas-session_duration:
      default: 24h
      description: 'The amount of time that tokens issued for the application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.'
      example: 24h
      type: string
    access_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_identity-providers'
    access_connection:
      description: The IdP used to authenticate.
      example: saml
      type: string
    access_cors_headers:
      properties:
        allow_all_headers:
          $ref: '#/components/schemas/access_allow_all_headers'
        allow_all_methods:
          $ref: '#/components/schemas/access_allow_all_methods'
        allow_all_origins:
          $ref: '#/components/schemas/access_allow_all_origins'
        allow_credentials:
          $ref: '#/components/schemas/access_allow_credentials'
        allowed_headers:
          $ref: '#/components/schemas/access_allowed_headers'
        allowed_methods:
          $ref: '#/components/schemas/access_allowed_methods'
        allowed_origins:
          $ref: '#/components/schemas/access_allowed_origins'
        max_age:
          $ref: '#/components/schemas/access_max_age'
      type: object
    access_country_rule:
      description: Matches a specific country
      properties:
        geo:
          properties:
            country_code:
              description: The country code that should be matched.
              example: US
              type: string
          required:
            - country_code
          type: object
      required:
        - geo
      title: Country
      type: object
    access_create_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              properties:
                client_id:
                  $ref: '#/components/schemas/access_client_id'
                client_secret:
                  $ref: '#/components/schemas/access_client_secret'
                created_at:
                  $ref: '#/components/schemas/access_timestamp'
                duration:
                  $ref: '#/components/schemas/access_duration'
                id:
                  description: The ID of the service token.
                  type: string
                name:
                  $ref: '#/components/schemas/access_schemas-name'
                updated_at:
                  $ref: '#/components/schemas/access_timestamp'
    access_custom-claims-support:
      properties:
        claims:
          description: Custom claims
          example:
            - email_verified
            - preferred_username
            - custom_claim_name
          items:
            type: string
          type: array
        email_claim_name:
          description: The claim name for email in the id_token response.
          example: custom_claim_name
          type: string
      type: object
    access_custom-pages_components-schemas-name:
      description: Custom page name.
      type: string
    access_custom-pages_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_custom_page_without_html'
              type: array
    access_custom-pages_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_custom_page'
    access_custom_deny_message:
      description: The custom error message shown to a user when they are denied access to the application.
      type: string
    access_custom_deny_url:
      description: The custom URL a user is redirected to when they are denied access to the application when failing identity-based rules.
      type: string
    access_custom_non_identity_deny_url:
      description: The custom URL a user is redirected to when they are denied access to the application when failing non-identity rules.
      type: string
    access_custom_page:
      properties:
        app_count:
          $ref: '#/components/schemas/access_schemas-app_count'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        custom_html:
          description: Custom page HTML.
          example: <html><body><h1>Access Denied</h1></body></html>
          type: string
        name:
          $ref: '#/components/schemas/access_custom-pages_components-schemas-name'
        type:
          $ref: '#/components/schemas/access_schemas-type'
        uid:
          $ref: '#/components/schemas/access_uuid'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      required:
        - name
        - custom_html
        - type
      type: object
    access_custom_page_without_html:
      properties:
        app_count:
          $ref: '#/components/schemas/access_schemas-app_count'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        name:
          $ref: '#/components/schemas/access_custom-pages_components-schemas-name'
        type:
          $ref: '#/components/schemas/access_schemas-type'
        uid:
          $ref: '#/components/schemas/access_uuid'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      required:
        - name
        - type
      type: object
    access_custom_pages:
      properties:
        forbidden:
          description: The uid of the custom page to use when a user is denied access after failing a non-identity rule.
          example: 699d98642c564d2e855e9661899b7252
          type: string
        identity_denied:
          description: The uid of the custom page to use when a user is denied access.
          example: 699d98642c564d2e855e9661899b7252
          type: string
    access_days_until_next_rotation:
      description: The number of days until the next key rotation.
      example: 1
      readOnly: true
      type: number
    access_decision:
      description: The action Access will take if a user matches this policy.
      enum:
        - allow
        - deny
        - non_identity
        - bypass
      example: allow
      type: string
    access_device_posture_check:
      properties:
        exists:
          type: boolean
        path:
          type: string
      type: object
    access_device_posture_rule:
      description: Enforces a device posture rule has run successfully
      properties:
        device_posture:
          properties:
            integration_uid:
              description: The ID of a device posture integration.
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
              type: string
          required:
            - integration_uid
          type: object
      required:
        - device_posture
      title: Device Posture
      type: object
    access_device_session:
      example:
        last_authenticated: 1.638832687e+09
      properties:
        last_authenticated:
          type: number
      type: object
    access_doh_jwt_duration:
      description: 'The duration the DoH JWT is valid for. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.  Note that the maximum duration for this setting is the same as the key rotation period on the account. Default expiration is 24h'
      example: 800h
      type: string
    access_domain:
      description: The primary hostname and path that Access will secure. If the app is visible in the App Launcher dashboard, this is the domain that will be displayed.
      example: test.example.com/admin
      type: string
    access_domain_rule:
      description: Match an entire email domain.
      properties:
        email_domain:
          properties:
            domain:
              description: The email domain to match.
              example: example.com
              type: string
          required:
            - domain
          type: object
      required:
        - email_domain
      title: Email domain
      type: object
    access_duration:
      default: 8760h
      description: 'The duration for how long the service token will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The default is 1 year in hours (8760h).'
      example: 60m
      type: string
    access_email:
      description: The email of the user.
      example: jdoe@example.com
      format: email
      type: string
    access_email_list_rule:
      description: Matches an email address from a list.
      properties:
        email_list:
          properties:
            id:
              description: The ID of a previously created email list.
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
              type: string
          required:
            - id
          type: object
      required:
        - email_list
      title: Email list
      type: object
    access_email_rule:
      description: Matches a specific email.
      properties:
        email:
          properties:
            email:
              description: The email of the user.
              example: test@example.com
              format: email
              type: string
          required:
            - email
          type: object
      required:
        - email
      title: Email
      type: object
    access_empty_response:
      allOf:
        - properties:
            result:
              enum:
                - true
                - false
              example: true
              type: boolean
            success:
              enum:
                - true
                - false
              example: true
              type: boolean
    access_enable_binding_cookie:
      default: false
      description: Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks.
      type: boolean
    access_everyone_rule:
      description: Matches everyone.
      properties:
        everyone:
          description: An empty object which matches on all users.
          example: {}
          type: object
      required:
        - everyone
      title: Everyone
      type: object
    access_exclude:
      description: Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.
      items:
        $ref: '#/components/schemas/access_rule'
      type: array
    access_external_evaluation_rule:
      description: Create Allow or Block policies which evaluate the user based on custom criteria.
      properties:
        external_evaluation:
          properties:
            evaluate_url:
              description: The API endpoint containing your business logic.
              example: https://eval.example.com
              type: string
            keys_url:
              description: The API endpoint containing the key that Access uses to verify that the response came from your API.
              example: https://eval.example.com/keys
              type: string
          required:
            - evaluate_url
            - keys_url
          type: object
      required:
        - external_evaluation
      title: External Evaluation
      type: object
    access_facebook:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              $ref: '#/components/schemas/access_generic-oauth-config'
          type: object
      title: Facebook
      type: object
    access_failed_login_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                properties:
                  expiration:
                    type: integer
                  metadata:
                    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
                    type: object
                type: object
              type: array
    access_feature_app_props:
      properties:
        allowed_idps:
          $ref: '#/components/schemas/access_allowed_idps'
        app_launcher_logo_url:
          $ref: '#/components/schemas/access_app_launcher_logo_url'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity'
        bg_color:
          $ref: '#/components/schemas/access_bg_color'
        domain:
          $ref: '#/components/schemas/access_domain'
        footer_links:
          $ref: '#/components/schemas/access_footer_links'
        header_bg_color:
          $ref: '#/components/schemas/access_header_bg_color'
        landing_page_design:
          $ref: '#/components/schemas/access_landing_page_design'
        name:
          $ref: '#/components/schemas/access_apps_components-schemas-name'
        session_duration:
          $ref: '#/components/schemas/access_schemas-session_duration'
        skip_app_launcher_login_page:
          $ref: '#/components/schemas/access_skip_app_launcher_login_page'
        type:
          $ref: '#/components/schemas/access_type'
      required:
        - type
      type: object
    access_fingerprint:
      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
      type: string
    access_footer_links:
      description: The links in the App Launcher footer.
      example:
        - name: Cloudflare's Privacy Policy
          url: https://www.cloudflare.com/privacypolicy/
      items:
        properties:
          name:
            description: The hypertext in the footer link.
            example: Cloudflare's Privacy Policy
            type: string
          url:
            description: the hyperlink in the footer link.
            example: https://www.cloudflare.com/privacypolicy/
            type: string
        required:
          - name
          - url
        type: object
      type: array
    access_gateway_seat:
      description: True if the seat is part of Gateway.
      example: false
      type: boolean
    access_generic-oauth-config:
      properties:
        client_id:
          description: Your OAuth Client ID
          example: <your client id>
          type: string
        client_secret:
          description: Your OAuth Client Secret
          example: <your client secret>
          type: string
      type: object
    access_geo:
      example:
        country: US
      properties:
        country:
          type: string
      type: object
    access_github:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              $ref: '#/components/schemas/access_generic-oauth-config'
          type: object
      title: GitHub
      type: object
    access_github_organization_rule:
      description: |-
        Matches a Github organization.
        Requires a Github identity provider.
      properties:
        github-organization:
          properties:
            identity_provider_id:
              description: The ID of your Github identity provider.
              example: ea85612a-29c8-46c2-bacb-669d65136971
              type: string
            name:
              description: The name of the organization.
              example: cloudflare
              type: string
          required:
            - name
            - identity_provider_id
          type: object
      required:
        - github-organization
      title: Github organization
      type: object
    access_google:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - $ref: '#/components/schemas/access_custom-claims-support'
          type: object
      title: Google
      type: object
    access_google-apps:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - $ref: '#/components/schemas/access_custom-claims-support'
                - properties:
                    apps_domain:
                      description: Your companies TLD
                      example: mycompany.com
                      type: string
                  type: object
          type: object
      title: Google Workspace
      type: object
    access_groups:
      properties:
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        exclude:
          $ref: '#/components/schemas/access_exclude'
        id:
          $ref: '#/components/schemas/access_uuid'
        include:
          $ref: '#/components/schemas/access_include'
        is_default:
          $ref: '#/components/schemas/access_require'
        name:
          $ref: '#/components/schemas/access_groups_components-schemas-name'
        require:
          $ref: '#/components/schemas/access_require'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_groups_components-schemas-name:
      description: The name of the Access group.
      example: Allow devs
      type: string
    access_groups_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_schemas-groups'
              type: array
    access_groups_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_groups'
    access_groups_components-schemas-single_response-2:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_schemas-groups'
    access_gsuite_group_rule:
      description: |-
        Matches a group in Google Workspace.
        Requires a Google Workspace identity provider.
      properties:
        gsuite:
          properties:
            email:
              description: The email of the Google Workspace group.
              example: devs@cloudflare.com
              type: string
            identity_provider_id:
              description: The ID of your Google Workspace identity provider.
              example: ea85612a-29c8-46c2-bacb-669d65136971
              type: string
          required:
            - email
            - identity_provider_id
          type: object
      required:
        - gsuite
      title: Google Workspace group
      type: object
    access_header_bg_color:
      description: The background color of the App Launcher header.
      example: '#ff0000'
      type: string
    access_http_only_cookie_attribute:
      default: true
      description: Enables the HttpOnly cookie attribute, which increases security against XSS attacks.
      example: true
      type: boolean
    access_id:
      description: The ID of the CA.
      example: 7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9
      maxLength: 48
      readOnly: true
      type: string
    access_id_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/access_uuid'
              type: object
    access_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    access_identity:
      properties:
        account_id:
          example: "1234567890"
          type: string
        auth_status:
          example: NONE
          type: string
        common_name:
          example: ""
          type: string
        device_id:
          example: ""
          type: string
        device_sessions:
          $ref: '#/components/schemas/access_string_key_map_device_session'
        devicePosture:
          additionalProperties:
            $ref: '#/components/schemas/access_schemas-device_posture_rule'
          type: object
        email:
          example: test@cloudflare.com
          type: string
        geo:
          $ref: '#/components/schemas/access_geo'
        iat:
          example: 1.694791905e+09
          type: number
        idp:
          properties:
            id:
              type: string
            type:
              type: string
          type: object
        ip:
          example: 127.0.0.0
          type: string
        is_gateway:
          example: false
          type: boolean
        is_warp:
          example: false
          type: boolean
        mtls_auth:
          properties:
            auth_status:
              type: string
            cert_issuer_dn:
              type: string
            cert_issuer_ski:
              type: string
            cert_presented:
              type: boolean
            cert_serial:
              type: string
          type: object
        service_token_id:
          example: ""
          type: string
        service_token_status:
          example: false
          type: boolean
        user_uuid:
          example: 57cf8cf2-f55a-4588-9ac9-f5e41e9f09b4
          type: string
        version:
          example: 2
          type: number
      type: object
    access_identity-provider:
      properties:
        config:
          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/).
          type: object
        id:
          $ref: '#/components/schemas/access_uuid'
        name:
          $ref: '#/components/schemas/access_components-schemas-name'
        scim_config:
          description: The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
          properties:
            enabled:
              description: A flag to enable or disable SCIM for the identity provider.
              type: boolean
            group_member_deprovision:
              description: A flag to revoke a user's session in Access and force a reauthentication on the user's Gateway session when they have been added or removed from a group in the Identity Provider.
              type: boolean
            seat_deprovision:
              description: A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider.  This cannot be enabled unless user_deprovision is also enabled.
              type: boolean
            secret:
              description: A read-only token generated when the SCIM integration is enabled for the first time.  It is redacted on subsequent requests.  If you lose this you will need to refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
              type: string
            user_deprovision:
              description: A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider.
              type: boolean
          type: object
        type:
          description: The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
          enum:
            - onetimepin
            - azureAD
            - saml
            - centrify
            - facebook
            - github
            - google-apps
            - google
            - linkedin
            - oidc
            - okta
            - onelogin
            - pingone
            - yandex
          example: onetimepin
          type: string
      required:
        - name
        - type
        - config
      type: object
    access_identity-providers:
      anyOf:
        - $ref: '#/components/schemas/access_azureAD'
        - $ref: '#/components/schemas/access_centrify'
        - $ref: '#/components/schemas/access_facebook'
        - $ref: '#/components/schemas/access_github'
        - $ref: '#/components/schemas/access_google'
        - $ref: '#/components/schemas/access_google-apps'
        - $ref: '#/components/schemas/access_linkedin'
        - $ref: '#/components/schemas/access_oidc'
        - $ref: '#/components/schemas/access_okta'
        - $ref: '#/components/schemas/access_onelogin'
        - $ref: '#/components/schemas/access_pingone'
        - $ref: '#/components/schemas/access_saml'
        - $ref: '#/components/schemas/access_yandex'
        - $ref: '#/components/schemas/access_onetimepin'
    access_identity-providers_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                anyOf:
                  - $ref: '#/components/schemas/access_schemas-azureAD'
                  - $ref: '#/components/schemas/access_schemas-centrify'
                  - $ref: '#/components/schemas/access_schemas-facebook'
                  - $ref: '#/components/schemas/access_schemas-github'
                  - $ref: '#/components/schemas/access_schemas-google'
                  - $ref: '#/components/schemas/access_schemas-google-apps'
                  - $ref: '#/components/schemas/access_schemas-linkedin'
                  - $ref: '#/components/schemas/access_schemas-oidc'
                  - $ref: '#/components/schemas/access_schemas-okta'
                  - $ref: '#/components/schemas/access_schemas-onelogin'
                  - $ref: '#/components/schemas/access_schemas-pingone'
                  - $ref: '#/components/schemas/access_schemas-saml'
                  - $ref: '#/components/schemas/access_schemas-yandex'
                  - $ref: '#/components/schemas/access_schemas-onetimepin'
              type: array
          type: object
      type: object
    access_identity-providers_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_schemas-identity-providers'
    access_image_url:
      description: The URL of the image shown on the landing page.
      example: https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg
      type: string
    access_include:
      description: Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.
      items:
        $ref: '#/components/schemas/access_rule'
      type: array
    access_ip:
      description: The IP address of the authenticating user.
      example: 198.41.129.166
      type: string
    access_ip_list_rule:
      description: Matches an IP address from a list.
      properties:
        ip_list:
          properties:
            id:
              description: The ID of a previously created IP list.
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
              type: string
          required:
            - id
          type: object
      required:
        - ip_list
      title: IP list
      type: object
    access_ip_rule:
      description: Matches an IP address block.
      properties:
        ip:
          properties:
            ip:
              description: An IPv4 or IPv6 CIDR block.
              example: 2400:cb00:21:10a::/64
              type: string
          required:
            - ip
          type: object
      required:
        - ip
      title: IP ranges
      type: object
    access_is_default:
      description: Whether this is the default group
      type: boolean
    access_is_ui_read_only:
      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"
      type: boolean
    access_isolation_required:
      default: false
      description: Require this application to be served in an isolated browser for users matching this policy. 'Client Web Isolation' must be on for the account in order to use this feature.
      example: false
      type: boolean
    access_key_config:
      properties:
        days_until_next_rotation:
          $ref: '#/components/schemas/access_days_until_next_rotation'
        key_rotation_interval_days:
          $ref: '#/components/schemas/access_key_rotation_interval_days'
        last_key_rotation_at:
          $ref: '#/components/schemas/access_last_key_rotation_at'
      type: object
    access_key_rotation_interval_days:
      description: The number of days between key rotations.
      example: 30
      maximum: 365
      minimum: 21
      type: number
    access_keys_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_key_config'
    access_landing_page_design:
      description: The design of the App Launcher landing page shown to users when they log in.
      properties:
        button_color:
          $ref: '#/components/schemas/access_button_color'
        button_text_color:
          $ref: '#/components/schemas/access_button_text_color'
        image_url:
          $ref: '#/components/schemas/access_image_url'
        message:
          $ref: '#/components/schemas/access_message'
        title:
          $ref: '#/components/schemas/access_title'
      type: object
    access_last_key_rotation_at:
      description: The timestamp of the previous key rotation.
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      type: string
    access_last_seen_identity_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/access_identity'
              type: object
    access_last_successful_login:
      description: The time at which the user last successfully logged in.
      example: "2020-07-01T05:20:00Z"
      format: date-time
      type: string
    access_linkedin:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              $ref: '#/components/schemas/access_generic-oauth-config'
          type: object
      title: LinkedIn
      type: object
    access_login_design:
      properties:
        background_color:
          description: The background color on your login page.
          example: '#c5ed1b'
          type: string
        footer_text:
          description: The text at the bottom of your login page.
          example: This is an example description.
          type: string
        header_text:
          description: The text at the top of your login page.
          example: This is an example description.
          type: string
        logo_path:
          description: The URL of the logo on your login page.
          example: https://example.com/logo.png
          type: string
        text_color:
          description: The text color on your login page.
          example: '#c5ed1b'
          type: string
    access_logo_url:
      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
      type: string
    access_max_age:
      description: The maximum number of seconds the results of a preflight request can be cached.
      example: -1
      maximum: 86400
      minimum: -1
      type: number
    access_message:
      description: The message shown on the landing page.
      example: Log in below to reach your applications behind Access.
      type: string
    access_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    access_name:
      description: The name of your Zero Trust organization.
      example: Widget Corps Internal Applications
      type: string
    access_name_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              properties:
                name:
                  $ref: '#/components/schemas/access_tags_components-schemas-name'
              type: object
          type: object
    access_nonce:
      example: X1aXj1lFVcqqyoXF
      type: string
    access_oidc:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - $ref: '#/components/schemas/access_custom-claims-support'
                - properties:
                    auth_url:
                      description: The authorization_endpoint URL of your IdP
                      example: https://accounts.google.com/o/oauth2/auth
                      type: string
                    certs_url:
                      description: The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens
                      example: https://www.googleapis.com/oauth2/v3/certs
                      type: string
                    scopes:
                      description: OAuth scopes
                      example:
                        - openid
                        - email
                        - profile
                      items:
                        type: string
                      type: array
                    token_url:
                      description: The token_endpoint URL of your IdP
                      example: https://accounts.google.com/o/oauth2/token
                      type: string
                  type: object
          type: object
      title: Generic OAuth
      type: object
    access_oidc_saas_app:
      properties:
        access_token_lifetime:
          description: The lifetime of the OIDC Access Token after creation. Valid units are m,h. Must be greater than or equal to 1m and less than or equal to 24h.
          example: 5m
          type: string
        allow_pkce_without_client_secret:
          description: If client secret should be required on the token endpoint when authorization_code_with_pkce grant is used.
          example: true
          type: boolean
        app_launcher_url:
          description: The URL where this applications tile redirects users
          example: https://example.com/login
          type: string
        auth_type:
          description: Identifier of the authentication protocol used for the saas app. Required for OIDC.
          enum:
            - saml
            - oidc
          example: oidc
          type: string
        client_id:
          description: The application client id
          example: oidc client id
          type: string
        client_secret:
          description: The application client secret, only returned on POST request.
          example: oidc client secret
          type: string
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        custom_claims:
          properties:
            name:
              description: The name of the claim.
              example: family_name
              type: string
            required:
              description: If the claim is required when building an OIDC token.
              example: true
              type: boolean
            scope:
              description: The scope of the claim.
              enum:
                - groups
                - profile
                - email
                - openid
              example: profile
              type: string
            source:
              properties:
                name:
                  description: The name of the IdP claim.
                  example: last_name
                  type: string
                name_by_idp:
                  additionalProperties:
                    type: string
                  description: A mapping from IdP ID to claim name.
                  example:
                    exampleIdPID1: ClaimName1
                    exampleIdPID2: ClaimName2
                  type: object
              type: object
          type: object
        grant_types:
          description: The OIDC flows supported by this application
          example:
            - authorization_code
          items:
            enum:
              - authorization_code
              - authorization_code_with_pkce
              - refresh_tokens
              - hybrid
              - implicit
            type: string
          type: array
        group_filter_regex:
          description: A regex to filter Cloudflare groups returned in ID token and userinfo endpoint
          example: ^GROUP_FILTER-*$
          type: string
        hybrid_and_implicit_options:
          properties:
            return_access_token_from_authorization_endpoint:
              description: If an Access Token should be returned from the OIDC Authorization endpoint
              type: boolean
            return_id_token_from_authorization_endpoint:
              description: If an ID Token should be returned from the OIDC Authorization endpoint
              type: boolean
          type: object
        public_key:
          description: The Access public certificate that will be used to verify your identity.
          example: example unique name
          type: string
        redirect_uris:
          description: The permitted URL's for Cloudflare to return Authorization codes and Access/ID tokens
          example:
            - https://example.com
          items:
            type: string
          type: array
        refresh_token_options:
          properties:
            lifetime:
              description: How long a refresh token will be valid for after creation. Valid units are m,h,d. Must be longer than 1m.
              example: 30d
              type: string
          type: object
        scopes:
          description: Define the user information shared with access, "offline_access" scope will be automatically enabled if refresh tokens are enabled
          example:
            - openid
            - groups
            - email
            - profile
          items:
            enum:
              - openid
              - groups
              - email
              - profile
            type: string
          type: array
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      title: OIDC SaaS App
      type: object
    access_okta:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - $ref: '#/components/schemas/access_custom-claims-support'
                - properties:
                    authorization_server_id:
                      description: Your okta authorization server id
                      example: aus9o8wzkhckw9TLa0h7z
                      type: string
                    okta_account:
                      description: Your okta account url
                      example: https://dev-abc123.oktapreview.com
                      type: string
                  type: object
          type: object
      title: Okta
      type: object
    access_okta_group_rule:
      description: |-
        Matches an Okta group.
        Requires an Okta identity provider.
      properties:
        okta:
          properties:
            identity_provider_id:
              description: The ID of your Okta identity provider.
              example: ea85612a-29c8-46c2-bacb-669d65136971
              type: string
            name:
              description: The name of the Okta group.
              example: devs
              type: string
          required:
            - name
            - identity_provider_id
          type: object
      required:
        - okta
      title: Okta group
      type: object
    access_onelogin:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - $ref: '#/components/schemas/access_custom-claims-support'
                - properties:
                    onelogin_account:
                      description: Your OneLogin account url
                      example: https://mycompany.onelogin.com
                      type: string
                  type: object
          type: object
      title: OneLogin
      type: object
    access_onetimepin:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              type: object
            type:
              enum:
                - onetimepin
      title: One Time Pin
      type: object
    access_options_preflight_bypass:
      description: Allows options preflight requests to bypass Access authentication and go directly to the origin. Cannot turn on if cors_headers is set.
      example: true
      type: boolean
    access_organizations:
      properties:
        allow_authenticate_via_warp:
          $ref: '#/components/schemas/access_allow_authenticate_via_warp'
        auth_domain:
          $ref: '#/components/schemas/access_auth_domain'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/access_auto_redirect_to_identity'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        custom_pages:
          $ref: '#/components/schemas/access_custom_pages'
        is_ui_read_only:
          $ref: '#/components/schemas/access_is_ui_read_only'
        login_design:
          $ref: '#/components/schemas/access_login_design'
        name:
          $ref: '#/components/schemas/access_name'
        session_duration:
          $ref: '#/components/schemas/access_session_duration'
        ui_read_only_toggle_reason:
          $ref: '#/components/schemas/access_ui_read_only_toggle_reason'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
        user_seat_expiration_inactive_time:
          $ref: '#/components/schemas/access_user_seat_expiration_inactive_time'
        warp_auth_session_duration:
          $ref: '#/components/schemas/access_warp_auth_session_duration'
      type: object
    access_organizations_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    access_organizations_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_schemas-organizations'
    access_pages_processed:
      description: The number of pages of (processed) users.
      example: 2
      type: integer
    access_path_cookie_attribute:
      default: false
      description: Enables cookie paths to scope an application's JWT to the application path. If disabled, the JWT will scope to the hostname by default
      example: true
      type: boolean
    access_percent_approved:
      description: The percentage of (processed) users approved based on policy evaluation results.
      example: 25
      type: integer
    access_percent_blocked:
      description: The percentage of (processed) users blocked based on policy evaluation results.
      example: 25
      type: integer
    access_percent_users_processed:
      description: The percentage of users processed so far (of the entire user base).
      example: 50
      type: integer
    access_pingone:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - $ref: '#/components/schemas/access_custom-claims-support'
                - properties:
                    ping_env_id:
                      description: Your PingOne environment identifier
                      example: 342b5660-0c32-4936-a5a4-ce21fae57b0a
                      type: string
                  type: object
          type: object
      title: PingOne
      type: object
    access_policies:
      properties:
        approval_groups:
          $ref: '#/components/schemas/access_schemas-approval_groups'
        approval_required:
          $ref: '#/components/schemas/access_approval_required'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        decision:
          $ref: '#/components/schemas/access_decision'
        exclude:
          $ref: '#/components/schemas/access_schemas-exclude'
        id:
          $ref: '#/components/schemas/access_uuid'
        include:
          $ref: '#/components/schemas/access_include'
        isolation_required:
          $ref: '#/components/schemas/access_schemas-isolation_required'
        name:
          $ref: '#/components/schemas/access_policies_components-schemas-name'
        precedence:
          $ref: '#/components/schemas/access_schemas-precedence'
        purpose_justification_prompt:
          $ref: '#/components/schemas/access_purpose_justification_prompt'
        purpose_justification_required:
          $ref: '#/components/schemas/access_purpose_justification_required'
        require:
          $ref: '#/components/schemas/access_schemas-require'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_policies_components-schemas-name:
      description: The name of the Access policy.
      example: Allow devs
      type: string
    access_policies_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_policies'
              type: array
    access_policies_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_policies'
    access_policy_check_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              properties:
                app_state:
                  properties:
                    app_uid:
                      $ref: '#/components/schemas/access_uuid'
                    aud:
                      example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389
                      type: string
                    hostname:
                      example: test.com
                      type: string
                    name:
                      example: Test App
                      type: string
                    policies:
                      example:
                        - decision: allow
                          exclude: []
                          include:
                            - _type: email
                              email: testuser@gmail.com
                          precedence: 0
                          require: []
                          status: Success
                      items:
                        type: object
                      type: array
                    status:
                      example: Success
                      type: string
                  type: object
                user_identity:
                  properties:
                    account_id:
                      example: 41ecfbb341f033e52b46742756aabb8b
                      type: string
                    device_sessions:
                      example: {}
                      type: object
                    email:
                      example: testuser@gmail.com
                      type: string
                    geo:
                      properties:
                        country:
                          example: US
                          type: string
                      type: object
                    iat:
                      type: integer
                    id:
                      example: "1164449231815010287495"
                      type: string
                    is_gateway:
                      example: false
                      type: boolean
                    is_warp:
                      example: false
                      type: boolean
                    name:
                      example: Test User
                      type: string
                    user_uuid:
                      $ref: '#/components/schemas/access_uuid'
                    version:
                      type: integer
                  type: object
              type: object
    access_policy_components-schemas-name:
      description: The name of the Access policy.
      example: Allow devs
      type: string
    access_policy_init_resp:
      properties:
        id:
          $ref: '#/components/schemas/access_policy_test_id'
        status:
          $ref: '#/components/schemas/access_status'
      type: object
    access_policy_req:
      properties:
        approval_groups:
          $ref: '#/components/schemas/access_approval_groups'
        approval_required:
          $ref: '#/components/schemas/access_approval_required'
        decision:
          $ref: '#/components/schemas/access_decision'
        exclude:
          $ref: '#/components/schemas/access_schemas-exclude'
        include:
          $ref: '#/components/schemas/access_include'
        isolation_required:
          $ref: '#/components/schemas/access_isolation_required'
        name:
          $ref: '#/components/schemas/access_policy_components-schemas-name'
        purpose_justification_prompt:
          $ref: '#/components/schemas/access_purpose_justification_prompt'
        purpose_justification_required:
          $ref: '#/components/schemas/access_purpose_justification_required'
        require:
          $ref: '#/components/schemas/access_schemas-require'
        session_duration:
          $ref: '#/components/schemas/access_components-schemas-session_duration'
      required:
        - name
        - decision
        - include
      type: object
    access_policy_resp:
      properties:
        approval_groups:
          $ref: '#/components/schemas/access_approval_groups'
        approval_required:
          $ref: '#/components/schemas/access_approval_required'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        decision:
          $ref: '#/components/schemas/access_decision'
        exclude:
          $ref: '#/components/schemas/access_schemas-exclude'
        id:
          $ref: '#/components/schemas/access_schemas-uuid'
        include:
          $ref: '#/components/schemas/access_include'
        isolation_required:
          $ref: '#/components/schemas/access_isolation_required'
        name:
          $ref: '#/components/schemas/access_policy_components-schemas-name'
        purpose_justification_prompt:
          $ref: '#/components/schemas/access_purpose_justification_prompt'
        purpose_justification_required:
          $ref: '#/components/schemas/access_purpose_justification_required'
        require:
          $ref: '#/components/schemas/access_schemas-require'
        session_duration:
          $ref: '#/components/schemas/access_components-schemas-session_duration'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_policy_test_id:
      description: The UUID of the policy test.
      example: f1a8b3c9d4e5f6789a0b1c2d3e4f5678a9b0c1d2e3f4a5b67890c1d2e3f4b5a6
      maxLength: 64
      type: string
    access_policy_update_resp:
      properties:
        id:
          $ref: '#/components/schemas/access_policy_test_id'
        pages_processed:
          $ref: '#/components/schemas/access_pages_processed'
        percent_approved:
          $ref: '#/components/schemas/access_percent_approved'
        percent_blocked:
          $ref: '#/components/schemas/access_percent_blocked'
        percent_users_processed:
          $ref: '#/components/schemas/access_percent_users_processed'
        status:
          $ref: '#/components/schemas/access_update_status'
        total_users:
          $ref: '#/components/schemas/access_total_users'
        users_approved:
          $ref: '#/components/schemas/access_users_approved'
        users_blocked:
          $ref: '#/components/schemas/access_users_blocked'
      type: object
    access_policy_users:
      properties:
        email:
          $ref: '#/components/schemas/access_email'
        id:
          $ref: '#/components/schemas/access_uuid'
        name:
          $ref: '#/components/schemas/access_users_components-schemas-name'
        status:
          $ref: '#/components/schemas/access_user_result'
      type: object
    access_policy_users_resp:
      description: Page of processed users.
      items:
        $ref: '#/components/schemas/access_policy_users'
      type: array
    access_precedence:
      description: The order of execution for this policy. Must be unique for each policy within an app.
      type: integer
    access_public_key:
      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
      type: string
    access_purpose_justification_prompt:
      description: A custom message that will appear on the purpose justification screen.
      example: Please enter a justification for entering this protected domain.
      type: string
    access_purpose_justification_required:
      default: false
      description: Require users to enter a justification when they log in to the application.
      example: true
      type: boolean
    access_ray_id:
      description: The unique identifier for the request to Cloudflare.
      example: 187d944c61940c77
      maxLength: 16
      type: string
    access_require:
      description: Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.
      items:
        $ref: '#/components/schemas/access_rule'
      type: array
    access_response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                anyOf:
                  - $ref: '#/components/schemas/access_azureAD'
                  - $ref: '#/components/schemas/access_centrify'
                  - $ref: '#/components/schemas/access_facebook'
                  - $ref: '#/components/schemas/access_github'
                  - $ref: '#/components/schemas/access_google'
                  - $ref: '#/components/schemas/access_google-apps'
                  - $ref: '#/components/schemas/access_linkedin'
                  - $ref: '#/components/schemas/access_oidc'
                  - $ref: '#/components/schemas/access_okta'
                  - $ref: '#/components/schemas/access_onelogin'
                  - $ref: '#/components/schemas/access_pingone'
                  - $ref: '#/components/schemas/access_saml'
                  - $ref: '#/components/schemas/access_yandex'
              type: array
          type: object
      type: object
    access_response_collection_hostnames:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_settings'
              type: array
    access_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    access_reusable-policies_components-schemas-id_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/access_schemas-uuid'
              type: object
    access_reusable-policies_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_reusable_policy_resp'
              type: array
    access_reusable-policies_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_reusable_policy_resp'
    access_reusable_policy_resp:
      allOf:
        - $ref: '#/components/schemas/access_policy_resp'
        - properties:
            app_count:
              $ref: '#/components/schemas/access_app_count'
            reusable:
              enum:
                - true
              type: boolean
    access_rule:
      oneOf:
        - $ref: '#/components/schemas/access_email_rule'
        - $ref: '#/components/schemas/access_email_list_rule'
        - $ref: '#/components/schemas/access_domain_rule'
        - $ref: '#/components/schemas/access_everyone_rule'
        - $ref: '#/components/schemas/access_ip_rule'
        - $ref: '#/components/schemas/access_ip_list_rule'
        - $ref: '#/components/schemas/access_certificate_rule'
        - $ref: '#/components/schemas/access_access_group_rule'
        - $ref: '#/components/schemas/access_azure_group_rule'
        - $ref: '#/components/schemas/access_github_organization_rule'
        - $ref: '#/components/schemas/access_gsuite_group_rule'
        - $ref: '#/components/schemas/access_okta_group_rule'
        - $ref: '#/components/schemas/access_saml_group_rule'
        - $ref: '#/components/schemas/access_service_token_rule'
        - $ref: '#/components/schemas/access_any_valid_service_token_rule'
        - $ref: '#/components/schemas/access_external_evaluation_rule'
        - $ref: '#/components/schemas/access_country_rule'
        - $ref: '#/components/schemas/access_authentication_method_rule'
        - $ref: '#/components/schemas/access_device_posture_rule'
      type: object
    access_saas_props:
      properties:
        allowed_idps:
          $ref: '#/components/schemas/access_allowed_idps'
        app_launcher_visible:
          $ref: '#/components/schemas/access_app_launcher_visible'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity'
        custom_pages:
          $ref: '#/components/schemas/access_schemas-custom_pages'
        logo_url:
          $ref: '#/components/schemas/access_logo_url'
        name:
          $ref: '#/components/schemas/access_apps_components-schemas-name'
        saas_app:
          oneOf:
            - $ref: '#/components/schemas/access_saml_saas_app'
            - $ref: '#/components/schemas/access_oidc_saas_app'
          type: object
        tags:
          $ref: '#/components/schemas/access_tags'
        type:
          description: The application type.
          example: saas
          type: string
      title: SaaS Application
      type: object
    access_same_site_cookie_attribute:
      description: Sets the SameSite cookie setting, which provides increased security against CSRF attacks.
      example: strict
      type: string
    access_saml:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              properties:
                attributes:
                  description: A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules.
                  example:
                    - group
                    - department_code
                    - divison
                  items:
                    type: string
                  type: array
                email_attribute_name:
                  description: The attribute name for email in the SAML response.
                  example: Email
                  type: string
                header_attributes:
                  description: Add a list of attribute names that will be returned in the response header from the Access callback.
                  items:
                    properties:
                      attribute_name:
                        description: attribute name from the IDP
                        type: string
                      header_name:
                        description: header that will be added on the request to the origin
                        type: string
                    type: object
                  type: array
                idp_public_certs:
                  description: X509 certificate to verify the signature in the SAML authentication response
                  items:
                    type: string
                  type: array
                issuer_url:
                  description: IdP Entity ID or Issuer URL
                  example: https://whoami.com
                  type: string
                sign_request:
                  description: Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints.
                  type: boolean
                sso_target_url:
                  description: URL to send the SAML authentication requests to
                  example: https://edgeaccess.org/idp/saml/login
                  type: string
              type: object
          type: object
      title: Generic SAML
      type: object
    access_saml_group_rule:
      description: |-
        Matches a SAML group.
        Requires a SAML identity provider.
      properties:
        saml:
          properties:
            attribute_name:
              description: The name of the SAML attribute.
              example: group
              type: string
            attribute_value:
              description: The SAML attribute value to look for.
              example: devs@cloudflare.com
              type: string
            identity_provider_id:
              description: The ID of your SAML identity provider.
              example: ea85612a-29c8-46c2-bacb-669d65136971
              type: string
          required:
            - attribute_name
            - attribute_value
            - identity_provider_id
          type: object
      required:
        - saml
      title: SAML group
      type: object
    access_saml_saas_app:
      properties:
        auth_type:
          description: Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is "saml"
          enum:
            - saml
            - oidc
          example: saml
          type: string
        consumer_service_url:
          description: The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.
          example: https://example.com
          type: string
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        custom_attributes:
          properties:
            friendly_name:
              description: The SAML FriendlyName of the attribute.
              example: Last Name
              type: string
            name:
              description: The name of the attribute.
              example: family_name
              type: string
            name_format:
              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
              type: string
            required:
              description: If the attribute is required when building a SAML assertion.
              example: true
              type: boolean
            source:
              properties:
                name:
                  description: The name of the IdP attribute.
                  example: last_name
                  type: string
                name_by_idp:
                  additionalProperties:
                    type: string
                  description: A mapping from IdP ID to attribute name.
                  example:
                    exampleIdPID1: AttributeName1
                    exampleIdPID2: AttributeName2
                  type: object
              type: object
          type: object
        default_relay_state:
          description: The URL that the user will be redirected to after a successful login for IDP initiated logins.
          example: https://example.com
          type: string
        idp_entity_id:
          description: The unique identifier for your SaaS application.
          example: https://example.cloudflareaccess.com
          type: string
        name_id_format:
          description: The format of the name identifier sent to the SaaS application.
          enum:
            - id
            - email
          example: id
          type: string
        name_id_transform_jsonata:
          description: |
            A [JSONata](https://jsonata.org/) expression that transforms an application's user identities into a NameID value for its SAML assertion. This expression should evaluate to a singular string. The output of this expression can override the `name_id_format` setting.
          example: $substringBefore(email, '@') & '+sandbox@' & $substringAfter(email, '@')
          type: string
        public_key:
          description: The Access public certificate that will be used to verify your identity.
          example: example unique name
          type: string
        saml_attribute_transform_jsonata:
          description: |
            A [JSONata] (https://jsonata.org/) expression that transforms an application's user identities into attribute assertions in the SAML response. The expression can transform id, email, name, and groups values. It can also transform fields listed in the saml_attributes or oidc_fields of the identity provider used to authenticate. The output of this expression must be a JSON object.
          example: '$ ~>| groups | {''group_name'': name} |'
          type: string
        sp_entity_id:
          description: A globally unique name for an identity or service provider.
          example: example unique name
          type: string
        sso_endpoint:
          description: The endpoint where your SaaS application will send login requests.
          example: https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd
          type: string
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      title: SAML SaaS App
      type: object
    access_schemas-access_seat:
      description: True if the user has authenticated with Cloudflare Access.
      example: false
      type: boolean
    access_schemas-allow_authenticate_via_warp:
      description: When set to true, users can authenticate to this application using their WARP session.  When set to false this application will always require direct IdP authentication. This setting always overrides the organization setting for WARP authentication.
      example: true
      type: boolean
    access_schemas-allowed_headers:
      description: Allowed HTTP request headers.
      items: {}
      type: array
    access_schemas-allowed_origins:
      description: Allowed origins.
      example:
        - https://example.com
      items: {}
      type: array
    access_schemas-app_count:
      description: Number of apps the custom page is assigned to.
      type: integer
    access_schemas-app_launcher_props:
      allOf:
        - $ref: '#/components/schemas/access_schemas-feature_app_props'
        - properties:
            domain:
              example: authdomain.cloudflareaccess.com
              readOnly: true
            name:
              default: App Launcher
              example: App Launcher
              readOnly: true
            type:
              description: The application type.
              example: app_launcher
              type: string
    access_schemas-app_launcher_visible:
      description: Displays the application in the App Launcher.
      example: true
      type: boolean
    access_schemas-approval_group:
      description: A group of email addresses that can approve a temporary authentication request.
      properties:
        approvals_needed:
          description: The number of approvals needed to obtain access.
          example: 1
          minimum: 0
          type: number
        email_addresses:
          description: A list of emails that can approve the access request.
          example:
            - test@cloudflare.com
            - test2@cloudflare.com
          items: {}
          type: array
        email_list_uuid:
          description: The UUID of an re-usable email list.
          type: string
      required:
        - approvals_needed
      type: object
    access_schemas-approval_groups:
      description: Administrators who can approve a temporary authentication request.
      example:
        - approvals_needed: 1
          email_addresses:
            - test1@cloudflare.com
            - test2@cloudflare.com
        - approvals_needed: 3
          email_list_uuid: 597147a1-976b-4ef2-9af0-81d5d007fc34
      items:
        $ref: '#/components/schemas/access_schemas-approval_group'
      type: array
    access_schemas-aud:
      description: Audience tag.
      example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893
      maxLength: 64
      readOnly: true
      type: string
    access_schemas-auto_redirect_to_identity:
      default: false
      description: When set to `true`, users skip the identity provider selection step during login. You must specify only one identity provider in allowed_idps.
      type: boolean
    access_schemas-azureAD:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - properties:
                    conditional_access_enabled:
                      description: Should Cloudflare try to load authentication contexts from your account
                      type: boolean
                    directory_id:
                      description: Your Azure directory uuid
                      example: <your azure directory uuid>
                      type: string
                    prompt:
                      description: Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether.
                      enum:
                        - login
                        - select_account
                        - none
                      type: string
                    support_groups:
                      description: Should Cloudflare try to load groups from your account
                      type: boolean
                  type: object
          type: object
      title: Azure AD
      type: object
    access_schemas-basic_app_response_props:
      properties:
        aud:
          $ref: '#/components/schemas/access_schemas-aud'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        id:
          $ref: '#/components/schemas/access_uuid'
        scim_config:
          $ref: '#/components/schemas/access_schemas-scim_config'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_schemas-biso_props:
      allOf:
        - $ref: '#/components/schemas/access_schemas-feature_app_props'
        - properties:
            domain:
              example: authdomain.cloudflareaccess.com/browser
              readOnly: true
            name:
              default: Clientless Web Isolation
              example: Clientless Web Isolation
              readOnly: true
            type:
              description: The application type.
              example: biso
              type: string
    access_schemas-bookmark_props:
      properties:
        app_launcher_visible:
          default: true
        domain:
          description: The URL or domain of the bookmark.
          example: https://mybookmark.com
        logo_url:
          $ref: '#/components/schemas/access_logo_url'
        name:
          $ref: '#/components/schemas/access_apps_components-schemas-name'
        type:
          description: The application type.
          example: bookmark
          type: string
      required:
        - type
        - domain
      title: Bookmark Application
      type: object
    access_schemas-centrify:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - properties:
                    centrify_account:
                      description: Your centrify account url
                      example: https://abc123.my.centrify.com/
                      type: string
                    centrify_app_id:
                      description: Your centrify app id
                      example: exampleapp
                      type: string
                  type: object
          type: object
      title: Centrify
      type: object
    access_schemas-certificates:
      properties:
        associated_hostnames:
          $ref: '#/components/schemas/access_associated_hostnames'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        expires_on:
          $ref: '#/components/schemas/access_timestamp'
        fingerprint:
          $ref: '#/components/schemas/access_fingerprint'
        id:
          description: The ID of the application that will use this certificate.
        name:
          $ref: '#/components/schemas/access_certificates_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_schemas-cors_headers:
      properties:
        allow_all_headers:
          $ref: '#/components/schemas/access_allow_all_headers'
        allow_all_methods:
          $ref: '#/components/schemas/access_allow_all_methods'
        allow_all_origins:
          $ref: '#/components/schemas/access_allow_all_origins'
        allow_credentials:
          $ref: '#/components/schemas/access_allow_credentials'
        allowed_headers:
          $ref: '#/components/schemas/access_schemas-allowed_headers'
        allowed_methods:
          $ref: '#/components/schemas/access_allowed_methods'
        allowed_origins:
          $ref: '#/components/schemas/access_schemas-allowed_origins'
        max_age:
          $ref: '#/components/schemas/access_max_age'
      type: object
    access_schemas-custom_deny_url:
      description: The custom URL a user is redirected to when they are denied access to the application.
      type: string
    access_schemas-custom_pages:
      description: The custom pages that will be displayed when applicable for this application
      items:
        description: The custom pages selected for application.
        example: 699d98642c564d2e855e9661899b7252
        type: string
      type: array
    access_schemas-device_posture_rule:
      properties:
        check:
          $ref: '#/components/schemas/access_device_posture_check'
        data:
          type: object
        description:
          type: string
        error:
          type: string
        id:
          type: string
        rule_name:
          type: string
        success:
          type: boolean
        timestamp:
          type: string
        type:
          type: string
      type: object
    access_schemas-domain:
      description: The domain of the Bookmark application.
      example: example.com
      type: string
    access_schemas-email:
      description: The email address of the authenticating user.
      example: user@example.com
      format: email
      type: string
    access_schemas-empty_response:
      allOf:
        - properties:
            result:
              nullable: true
              type: object
            success:
              enum:
                - true
                - false
              example: true
              type: boolean
    access_schemas-exclude:
      description: Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.
      items:
        $ref: '#/components/schemas/access_rule'
      type: array
    access_schemas-facebook:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              $ref: '#/components/schemas/access_generic-oauth-config'
          type: object
      title: Facebook
      type: object
    access_schemas-feature_app_props:
      properties:
        allowed_idps:
          $ref: '#/components/schemas/access_allowed_idps'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity'
        domain:
          $ref: '#/components/schemas/access_components-schemas-domain'
        name:
          $ref: '#/components/schemas/access_apps_components-schemas-name'
        session_duration:
          $ref: '#/components/schemas/access_schemas-session_duration'
        type:
          $ref: '#/components/schemas/access_type'
      required:
        - type
      type: object
    access_schemas-gateway_seat:
      description: True if the user has logged into the WARP client.
      example: false
      type: boolean
    access_schemas-github:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              $ref: '#/components/schemas/access_generic-oauth-config'
          type: object
      title: GitHub
      type: object
    access_schemas-google:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              $ref: '#/components/schemas/access_generic-oauth-config'
          type: object
      title: Google
      type: object
    access_schemas-google-apps:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - properties:
                    apps_domain:
                      description: Your companies TLD
                      example: mycompany.com
                      type: string
                  type: object
          type: object
      title: Google Workspace
      type: object
    access_schemas-groups:
      properties:
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        exclude:
          $ref: '#/components/schemas/access_exclude'
        id:
          $ref: '#/components/schemas/access_uuid'
        include:
          $ref: '#/components/schemas/access_include'
        name:
          $ref: '#/components/schemas/access_groups_components-schemas-name'
        require:
          $ref: '#/components/schemas/access_require'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_schemas-id_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/access_id'
              type: object
    access_schemas-identifier:
      allOf:
        - $ref: '#/components/schemas/access_identifier'
        - example: 699d98642c564d2e855e9661899b7252
    access_schemas-identity-provider:
      properties:
        config:
          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/).
          type: object
        id:
          $ref: '#/components/schemas/access_uuid'
        name:
          $ref: '#/components/schemas/access_components-schemas-name'
        scim_config:
          description: The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
          properties:
            enabled:
              description: A flag to enable or disable SCIM for the identity provider.
              type: boolean
            group_member_deprovision:
              description: A flag to revoke a user's session in Access and force a reauthentication on the user's Gateway session when they have been added or removed from a group in the Identity Provider.
              type: boolean
            seat_deprovision:
              description: A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider.  This cannot be enabled unless user_deprovision is also enabled.
              type: boolean
            secret:
              description: A read-only token generated when the SCIM integration is enabled for the first time.  It is redacted on subsequent requests. If you lose this you will need to refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
              type: string
            user_deprovision:
              description: A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider.
              type: boolean
          type: object
        type:
          description: The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
          enum:
            - onetimepin
            - azureAD
            - saml
            - centrify
            - facebook
            - github
            - google-apps
            - google
            - linkedin
            - oidc
            - okta
            - onelogin
            - pingone
            - yandex
          example: onetimepin
          type: string
      required:
        - name
        - type
        - config
      type: object
    access_schemas-identity-providers:
      anyOf:
        - $ref: '#/components/schemas/access_schemas-azureAD'
        - $ref: '#/components/schemas/access_schemas-centrify'
        - $ref: '#/components/schemas/access_schemas-facebook'
        - $ref: '#/components/schemas/access_schemas-github'
        - $ref: '#/components/schemas/access_schemas-google'
        - $ref: '#/components/schemas/access_schemas-google-apps'
        - $ref: '#/components/schemas/access_schemas-linkedin'
        - $ref: '#/components/schemas/access_schemas-oidc'
        - $ref: '#/components/schemas/access_schemas-okta'
        - $ref: '#/components/schemas/access_schemas-onelogin'
        - $ref: '#/components/schemas/access_schemas-pingone'
        - $ref: '#/components/schemas/access_schemas-saml'
        - $ref: '#/components/schemas/access_schemas-yandex'
    access_schemas-isolation_required:
      default: false
      description: Require this application to be served in an isolated browser for users matching this policy.
      example: false
      type: boolean
    access_schemas-linkedin:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              $ref: '#/components/schemas/access_generic-oauth-config'
          type: object
      title: LinkedIn
      type: object
    access_schemas-name:
      description: The name of the service token.
      example: CI/CD token
      type: string
    access_schemas-oidc:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - properties:
                    auth_url:
                      description: The authorization_endpoint URL of your IdP
                      example: https://accounts.google.com/o/oauth2/auth
                      type: string
                    certs_url:
                      description: The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens
                      example: https://www.googleapis.com/oauth2/v3/certs
                      type: string
                    claims:
                      description: List of custom claims that will be pulled from your id_token and added to your signed Access JWT token.
                      example:
                        - given_name
                        - locale
                      items:
                        type: string
                      type: array
                    scopes:
                      description: OAuth scopes
                      example:
                        - openid
                        - email
                        - profile
                      items:
                        type: string
                      type: array
                    token_url:
                      description: The token_endpoint URL of your IdP
                      example: https://accounts.google.com/o/oauth2/token
                      type: string
                  type: object
          type: object
      title: Generic OAuth
      type: object
    access_schemas-oidc_saas_app:
      properties:
        access_token_lifetime:
          description: The lifetime of the OIDC Access Token after creation. Valid units are m,h. Must be greater than or equal to 1m and less than or equal to 24h.
          example: 5m
          type: string
        allow_pkce_without_client_secret:
          description: If client secret should be required on the token endpoint when authorization_code_with_pkce grant is used.
          example: true
          type: boolean
        app_launcher_url:
          description: The URL where this applications tile redirects users
          example: https://example.com/login
          type: string
        auth_type:
          description: Identifier of the authentication protocol used for the saas app. Required for OIDC.
          enum:
            - saml
            - oidc
          example: oidc
          type: string
        client_id:
          description: The application client id
          example: oidc client id
          type: string
        client_secret:
          description: The application client secret, only returned on POST request.
          example: oidc client secret
          type: string
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        custom_claims:
          properties:
            name:
              description: The name of the claim.
              example: family_name
              type: string
            required:
              description: If the claim is required when building an OIDC token.
              example: true
              type: boolean
            scope:
              description: The scope of the claim.
              enum:
                - groups
                - profile
                - email
                - openid
              example: profile
              type: string
            source:
              properties:
                name:
                  description: The name of the IdP claim.
                  example: last_name
                  type: string
                name_by_idp:
                  additionalProperties:
                    type: string
                  description: A mapping from IdP ID to claim name.
                  example:
                    exampleIdPID1: ClaimName1
                    exampleIdPID2: ClaimName2
                  type: object
              type: object
          type: object
        grant_types:
          description: The OIDC flows supported by this application
          example:
            - authorization_code
          items:
            enum:
              - authorization_code
              - authorization_code_with_pkce
              - refresh_tokens
              - hybrid
              - implicit
            type: string
          type: array
        group_filter_regex:
          description: A regex to filter Cloudflare groups returned in ID token and userinfo endpoint.
          example: ^GROUP_FILTER-*$
          type: string
        hybrid_and_implicit_options:
          properties:
            return_access_token_from_authorization_endpoint:
              description: If an Access Token should be returned from the OIDC Authorization endpoint
              type: boolean
            return_id_token_from_authorization_endpoint:
              description: If an ID Token should be returned from the OIDC Authorization endpoint
              type: boolean
          type: object
        public_key:
          description: The Access public certificate that will be used to verify your identity.
          example: example unique name
          type: string
        redirect_uris:
          description: The permitted URL's for Cloudflare to return Authorization codes and Access/ID tokens
          example:
            - https://example.com
          items:
            type: string
          type: array
        refresh_token_options:
          properties:
            lifetime:
              description: How long a refresh token will be valid for after creation. Valid units are m,h,d. Must be longer than 1m.
              example: 30d
              type: string
          type: object
        scopes:
          description: Define the user information shared with access, "offline_access" scope will be automatically enabled if refresh tokens are enabled
          example:
            - openid
            - groups
            - email
            - profile
          items:
            enum:
              - openid
              - groups
              - email
              - profile
            type: string
          type: array
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      title: OIDC SaaS App
      type: object
    access_schemas-okta:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - properties:
                    okta_account:
                      description: Your okta account url
                      example: https://dev-abc123.oktapreview.com
                      type: string
                  type: object
          type: object
      title: Okta
      type: object
    access_schemas-onelogin:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - properties:
                    onelogin_account:
                      description: Your OneLogin account url
                      example: https://mycompany.onelogin.com
                      type: string
                  type: object
          type: object
      title: OneLogin
      type: object
    access_schemas-onetimepin:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              type: object
            type:
              enum:
                - onetimepin
      title: One Time Pin
      type: object
    access_schemas-organizations:
      properties:
        auth_domain:
          $ref: '#/components/schemas/access_auth_domain'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        is_ui_read_only:
          $ref: '#/components/schemas/access_is_ui_read_only'
        login_design:
          $ref: '#/components/schemas/access_login_design'
        name:
          $ref: '#/components/schemas/access_name'
        ui_read_only_toggle_reason:
          $ref: '#/components/schemas/access_ui_read_only_toggle_reason'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
        user_seat_expiration_inactive_time:
          $ref: '#/components/schemas/access_schemas-user_seat_expiration_inactive_time'
      type: object
    access_schemas-pingone:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              allOf:
                - $ref: '#/components/schemas/access_generic-oauth-config'
                - properties:
                    ping_env_id:
                      description: Your PingOne environment identifier
                      example: 342b5660-0c32-4936-a5a4-ce21fae57b0a
                      type: string
                  type: object
          type: object
      title: PingOne
      type: object
    access_schemas-policy_check_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              properties:
                app_state:
                  properties:
                    app_uid:
                      $ref: '#/components/schemas/access_uuid'
                    aud:
                      example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389
                      type: string
                    hostname:
                      example: test.com
                      type: string
                    name:
                      example: Test App
                      type: string
                    policies:
                      example:
                        - decision: allow
                          exclude: []
                          include:
                            - _type: email
                              email: testuser@gmail.com
                          precedence: 0
                          require: []
                          status: Success
                      items: {}
                      type: array
                    status:
                      example: Success
                      type: string
                  type: object
                user_identity:
                  properties:
                    account_id:
                      example: 41ecfbb341f033e52b46742756aabb8b
                      type: string
                    device_sessions:
                      example: {}
                      type: object
                    email:
                      example: testuser@gmail.com
                      type: string
                    geo:
                      properties:
                        country:
                          example: US
                          type: string
                      type: object
                    iat:
                      type: integer
                    id:
                      example: "1164449231815010287495"
                      type: string
                    is_gateway:
                      example: false
                      type: boolean
                    is_warp:
                      example: false
                      type: boolean
                    name:
                      example: Test User
                      type: string
                    user_uuid:
                      $ref: '#/components/schemas/access_uuid'
                    version:
                      type: integer
                  type: object
              type: object
    access_schemas-precedence:
      description: The order of execution for this policy. Must be unique for each policy.
      type: integer
    access_schemas-require:
      description: Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.
      items:
        $ref: '#/components/schemas/access_rule'
      type: array
    access_schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_groups'
              type: array
    access_schemas-saas_props:
      properties:
        allowed_idps:
          $ref: '#/components/schemas/access_allowed_idps'
        app_launcher_visible:
          $ref: '#/components/schemas/access_app_launcher_visible'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity'
        logo_url:
          $ref: '#/components/schemas/access_logo_url'
        name:
          $ref: '#/components/schemas/access_apps_components-schemas-name'
        saas_app:
          oneOf:
            - $ref: '#/components/schemas/access_schemas-saml_saas_app'
            - $ref: '#/components/schemas/access_schemas-oidc_saas_app'
          type: object
        type:
          description: The application type.
          example: saas
          type: string
      title: SaaS Application
      type: object
    access_schemas-saml:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              properties:
                attributes:
                  description: A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules.
                  example:
                    - group
                    - department_code
                    - divison
                  items:
                    type: string
                  type: array
                email_attribute_name:
                  description: The attribute name for email in the SAML response.
                  example: Email
                  type: string
                header_attributes:
                  description: Add a list of attribute names that will be returned in the response header from the Access callback.
                  items:
                    properties:
                      attribute_name:
                        description: attribute name from the IDP
                        type: string
                      header_name:
                        description: header that will be added on the request to the origin
                        type: string
                    type: object
                  type: array
                idp_public_certs:
                  description: X509 certificate to verify the signature in the SAML authentication response
                  items:
                    type: string
                  type: array
                issuer_url:
                  description: IdP Entity ID or Issuer URL
                  example: https://whoami.com
                  type: string
                sign_request:
                  description: Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints.
                  type: boolean
                sso_target_url:
                  description: URL to send the SAML authentication requests to
                  example: https://edgeaccess.org/idp/saml/login
                  type: string
              type: object
          type: object
      title: Generic SAML
      type: object
    access_schemas-saml_saas_app:
      properties:
        auth_type:
          description: Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is "saml"
          enum:
            - saml
            - oidc
          example: saml
          type: string
        consumer_service_url:
          description: The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.
          example: https://example.com
          type: string
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        custom_attributes:
          properties:
            friendly_name:
              description: The SAML FriendlyName of the attribute.
              example: Last Name
              type: string
            name:
              description: The name of the attribute.
              example: family_name
              type: string
            name_format:
              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
              type: string
            required:
              description: If the attribute is required when building a SAML assertion.
              example: true
              type: boolean
            source:
              properties:
                name:
                  description: The name of the IdP attribute.
                  example: last_name
                  type: string
                name_by_idp:
                  additionalProperties:
                    type: string
                  description: A mapping from IdP ID to attribute name.
                  example:
                    exampleIdPID1: AttributeName1
                    exampleIdPID2: AttributeName2
                  type: object
              type: object
          type: object
        idp_entity_id:
          description: The unique identifier for your SaaS application.
          example: https://example.cloudflareaccess.com
          type: string
        name_id_format:
          description: The format of the name identifier sent to the SaaS application.
          enum:
            - id
            - email
          example: id
          type: string
        name_id_transform_jsonata:
          description: |
            A [JSONata](https://jsonata.org/) expression that transforms an application's user identities into a NameID value for its SAML assertion. This expression should evaluate to a singular string. The output of this expression can override the `name_id_format` setting.
          example: $substringBefore(email, '@') & '+sandbox@' & $substringAfter(email, '@')
          type: string
        public_key:
          description: The Access public certificate that will be used to verify your identity.
          example: example unique name
          type: string
        sp_entity_id:
          description: A globally unique name for an identity or service provider.
          example: example unique name
          type: string
        sso_endpoint:
          description: The endpoint where your SaaS application will send login requests.
          example: https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd
          type: string
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      title: SAML SaaS App
      type: object
    access_schemas-scim_config:
      description: Configuration for provisioning to this application via SCIM. This is currently in closed beta.
      properties:
        authentication:
          oneOf:
            - $ref: '#/components/schemas/access_scim_config_authentication_http_basic'
            - $ref: '#/components/schemas/access_scim_config_authentication_oauth_bearer_token'
            - $ref: '#/components/schemas/access_scim_config_authentication_oauth2'
        deactivate_on_delete:
          description: If false, we propagate DELETE requests to the target application for SCIM resources. If true, we only set `active` to false on the SCIM resource. This is useful because some targets do not support DELETE operations.
          type: boolean
        enabled:
          description: Whether SCIM provisioning is turned on for this application.
          type: boolean
        idp_uid:
          description: The UID of the IdP to use as the source for SCIM resources to provision to this application.
          type: string
        mappings:
          description: A list of mappings to apply to SCIM resources before provisioning them in this application. These can transform or filter the resources to be provisioned.
          items:
            $ref: '#/components/schemas/access_scim_config_mapping'
          type: array
        remote_uri:
          description: The base URI for the application's SCIM-compatible API.
          type: string
      required:
        - remote_uri
        - idp_uid
      type: object
    access_schemas-seat_uid:
      description: The unique API identifier for the Zero Trust seat.
      type: string
    access_schemas-self_hosted_props:
      properties:
        allowed_idps:
          $ref: '#/components/schemas/access_allowed_idps'
        app_launcher_visible:
          $ref: '#/components/schemas/access_app_launcher_visible'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity'
        cors_headers:
          $ref: '#/components/schemas/access_schemas-cors_headers'
        custom_deny_message:
          $ref: '#/components/schemas/access_custom_deny_message'
        custom_deny_url:
          $ref: '#/components/schemas/access_schemas-custom_deny_url'
        domain:
          $ref: '#/components/schemas/access_components-schemas-domain'
        enable_binding_cookie:
          $ref: '#/components/schemas/access_enable_binding_cookie'
        http_only_cookie_attribute:
          $ref: '#/components/schemas/access_http_only_cookie_attribute'
        logo_url:
          $ref: '#/components/schemas/access_logo_url'
        name:
          $ref: '#/components/schemas/access_apps_components-schemas-name'
        options_preflight_bypass:
          $ref: '#/components/schemas/access_options_preflight_bypass'
        same_site_cookie_attribute:
          $ref: '#/components/schemas/access_same_site_cookie_attribute'
        service_auth_401_redirect:
          $ref: '#/components/schemas/access_service_auth_401_redirect'
        session_duration:
          $ref: '#/components/schemas/access_schemas-session_duration'
        skip_interstitial:
          $ref: '#/components/schemas/access_skip_interstitial'
        type:
          description: The application type.
          example: self_hosted
          type: string
      required:
        - type
        - domain
      title: Self Hosted Application
      type: object
    access_schemas-session_duration:
      default: 24h
      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.'
      example: 24h
      type: string
    access_schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_service-tokens'
    access_schemas-ssh_props:
      allOf:
        - $ref: '#/components/schemas/access_schemas-self_hosted_props'
        - properties:
            type:
              description: The application type.
              example: ssh
              type: string
    access_schemas-type:
      description: Custom page type.
      enum:
        - identity_denied
        - forbidden
      type: string
    access_schemas-user_seat_expiration_inactive_time:
      description: 'The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Must be in the format `300ms` or `2h45m`. Valid time units are: `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.'
      example: 720h
      type: string
    access_schemas-uuid:
      description: The UUID of the policy
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    access_schemas-vnc_props:
      allOf:
        - $ref: '#/components/schemas/access_schemas-self_hosted_props'
        - properties:
            type:
              description: The application type.
              example: vnc
              type: string
    access_schemas-warp_props:
      allOf:
        - $ref: '#/components/schemas/access_schemas-feature_app_props'
        - properties:
            domain:
              example: authdomain.cloudflareaccess.com/warp
              readOnly: true
            name:
              default: Warp Login App
              example: Warp Login App
              readOnly: true
            type:
              description: The application type.
              example: warp
              type: string
    access_schemas-yandex:
      allOf:
        - $ref: '#/components/schemas/access_schemas-identity-provider'
        - properties:
            config:
              $ref: '#/components/schemas/access_generic-oauth-config'
          type: object
      title: Yandex
      type: object
    access_scim_config:
      description: Configuration for provisioning to this application via SCIM. This is currently in closed beta.
      properties:
        authentication:
          oneOf:
            - $ref: '#/components/schemas/access_scim_config_authentication_http_basic'
            - $ref: '#/components/schemas/access_scim_config_authentication_oauth_bearer_token'
            - $ref: '#/components/schemas/access_scim_config_authentication_oauth2'
        deactivate_on_delete:
          description: 'If false, propagates DELETE requests to the target application for SCIM resources. If true, sets ''active'' to false on the SCIM resource. Note: Some targets do not support DELETE operations.'
          type: boolean
        enabled:
          description: Whether SCIM provisioning is turned on for this application.
          type: boolean
        idp_uid:
          description: The UID of the IdP to use as the source for SCIM resources to provision to this application.
          type: string
        mappings:
          description: A list of mappings to apply to SCIM resources before provisioning them in this application. These can transform or filter the resources to be provisioned.
          items:
            $ref: '#/components/schemas/access_scim_config_mapping'
          type: array
        remote_uri:
          description: The base URI for the application's SCIM-compatible API.
          type: string
      required:
        - remote_uri
        - idp_uid
      type: object
    access_scim_config_authentication_http_basic:
      description: Attributes for configuring HTTP Basic authentication scheme for SCIM provisioning to an application.
      properties:
        password:
          description: Password used to authenticate with the remote SCIM service.
          type: string
        scheme:
          description: The authentication scheme to use when making SCIM requests to this application.
          enum:
            - httpbasic
          type: string
        user:
          description: User name used to authenticate with the remote SCIM service.
          type: string
      required:
        - scheme
        - user
        - password
      title: HTTP Basic
      type: object
    access_scim_config_authentication_oauth_bearer_token:
      description: Attributes for configuring OAuth Bearer Token authentication scheme for SCIM provisioning to an application.
      properties:
        scheme:
          description: The authentication scheme to use when making SCIM requests to this application.
          enum:
            - oauthbearertoken
          type: string
        token:
          description: Token used to authenticate with the remote SCIM service.
          type: string
      required:
        - scheme
        - token
      title: OAuth Bearer Token
      type: object
    access_scim_config_authentication_oauth2:
      description: Attributes for configuring OAuth 2 authentication scheme for SCIM provisioning to an application.
      properties:
        authorization_url:
          description: URL used to generate the auth code used during token generation.
          type: string
        client_id:
          description: Client ID used to authenticate when generating a token for authenticating with the remote SCIM service.
          type: string
        client_secret:
          description: Secret used to authenticate when generating a token for authenticating with the remove SCIM service.
          type: string
        scheme:
          description: The authentication scheme to use when making SCIM requests to this application.
          enum:
            - oauth2
          type: string
        scopes:
          description: The authorization scopes to request when generating the token used to authenticate with the remove SCIM service.
          items:
            type: string
          type: array
        token_url:
          description: URL used to generate the token used to authenticate with the remote SCIM service.
          type: string
      required:
        - scheme
        - client_id
        - client_secret
        - authorization_url
        - token_url
      title: OAuth 2
      type: object
    access_scim_config_mapping:
      description: Transformations and filters applied to resources before they are provisioned in the remote SCIM service.
      properties:
        enabled:
          description: Whether or not this mapping is enabled.
          type: boolean
        filter:
          description: A [SCIM filter expression](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2) that matches resources that should be provisioned to this application.
          example: title pr or userType eq "Intern"
          type: string
        operations:
          description: Whether or not this mapping applies to creates, updates, or deletes.
          properties:
            create:
              description: Whether or not this mapping applies to create (POST) operations.
              type: boolean
            delete:
              description: Whether or not this mapping applies to DELETE operations.
              type: boolean
            update:
              description: Whether or not this mapping applies to update (PATCH/PUT) operations.
              type: boolean
          type: object
        schema:
          description: Which SCIM resource type this mapping applies to.
          example: urn:ietf:params:scim:schemas:core:2.0:User
          type: string
        transform_jsonata:
          description: A [JSONata](https://jsonata.org/) expression that transforms the resource before provisioning it in the application.
          example: '$merge([$, {''userName'': $substringBefore($.userName, ''@'') & ''+test@'' & $substringAfter($.userName, ''@'')}])'
          type: string
      required:
        - schema
      type: object
    access_seat:
      properties:
        access_seat:
          $ref: '#/components/schemas/access_access_seat'
        gateway_seat:
          $ref: '#/components/schemas/access_gateway_seat'
        seat_uid:
          $ref: '#/components/schemas/access_seat_uid'
      required:
        - seat_uid
        - gateway_seat
        - access_seat
      type: object
    access_seat_uid:
      description: The unique API identifier for the Zero Trust seat.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    access_seats:
      properties:
        access_seat:
          $ref: '#/components/schemas/access_access_seat'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        gateway_seat:
          $ref: '#/components/schemas/access_gateway_seat'
        seat_uid:
          $ref: '#/components/schemas/access_seat_uid'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_seats_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_seats'
              type: array
    access_seats_definition:
      items:
        $ref: '#/components/schemas/access_seat'
      required:
        - seat_uid
        - gateway_seat
        - access_seat
      type: array
    access_self_hosted_domains:
      description: List of domains that Access will secure.
      example:
        - test.example.com/admin
        - test.anotherexample.com/staff
      items:
        description: A domain that Access will secure.
        type: string
      type: array
    access_self_hosted_props:
      properties:
        allow_authenticate_via_warp:
          $ref: '#/components/schemas/access_schemas-allow_authenticate_via_warp'
        allowed_idps:
          $ref: '#/components/schemas/access_allowed_idps'
        app_launcher_visible:
          $ref: '#/components/schemas/access_app_launcher_visible'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity'
        cors_headers:
          $ref: '#/components/schemas/access_cors_headers'
        custom_deny_message:
          $ref: '#/components/schemas/access_custom_deny_message'
        custom_deny_url:
          $ref: '#/components/schemas/access_custom_deny_url'
        custom_non_identity_deny_url:
          $ref: '#/components/schemas/access_custom_non_identity_deny_url'
        custom_pages:
          $ref: '#/components/schemas/access_schemas-custom_pages'
        domain:
          $ref: '#/components/schemas/access_domain'
        enable_binding_cookie:
          $ref: '#/components/schemas/access_enable_binding_cookie'
        http_only_cookie_attribute:
          $ref: '#/components/schemas/access_http_only_cookie_attribute'
        logo_url:
          $ref: '#/components/schemas/access_logo_url'
        name:
          $ref: '#/components/schemas/access_apps_components-schemas-name'
        options_preflight_bypass:
          $ref: '#/components/schemas/access_options_preflight_bypass'
        path_cookie_attribute:
          $ref: '#/components/schemas/access_path_cookie_attribute'
        same_site_cookie_attribute:
          $ref: '#/components/schemas/access_same_site_cookie_attribute'
        self_hosted_domains:
          $ref: '#/components/schemas/access_self_hosted_domains'
        service_auth_401_redirect:
          $ref: '#/components/schemas/access_service_auth_401_redirect'
        session_duration:
          $ref: '#/components/schemas/access_schemas-session_duration'
        skip_interstitial:
          $ref: '#/components/schemas/access_skip_interstitial'
        tags:
          $ref: '#/components/schemas/access_tags'
        type:
          description: The application type.
          example: self_hosted
          type: string
      required:
        - type
        - domain
      title: Self Hosted Application
      type: object
    access_service-tokens:
      properties:
        client_id:
          $ref: '#/components/schemas/access_client_id'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        duration:
          $ref: '#/components/schemas/access_duration'
        expires_at:
          $ref: '#/components/schemas/access_timestamp'
        id:
          allOf:
            - description: The ID of the service token.
            - $ref: '#/components/schemas/access_uuid'
        name:
          $ref: '#/components/schemas/access_schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_service_auth_401_redirect:
      description: Returns a 401 status code when the request is blocked by a Service Auth policy.
      example: true
      type: boolean
    access_service_token_rule:
      description: Matches a specific Access Service Token
      properties:
        service_token:
          properties:
            token_id:
              description: The ID of a Service Token.
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
              type: string
          required:
            - token_id
          type: object
      required:
        - service_token
      title: Service Token
      type: object
    access_session_duration:
      description: 'The amount of time that tokens issued for applications will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.'
      example: 24h
      type: string
    access_settings:
      additionalProperties: false
      properties:
        china_network:
          description: Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.
          example: false
          type: boolean
        client_certificate_forwarding:
          description: Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.
          example: true
          type: boolean
        hostname:
          description: The hostname that these settings apply to.
          example: admin.example.com
          type: string
      required:
        - hostname
        - china_network
        - client_certificate_forwarding
      title: Hostname Settings
      type: object
    access_single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_organizations'
    access_single_response_without_html:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_custom_page_without_html'
    access_skip_app_launcher_login_page:
      default: false
      description: Determines when to skip the App Launcher landing page.
      example: true
      type: boolean
    access_skip_interstitial:
      description: Enables automatic authentication through cloudflared.
      example: true
      type: boolean
    access_ssh_props:
      allOf:
        - $ref: '#/components/schemas/access_self_hosted_props'
        - properties:
            type:
              description: The application type.
              example: ssh
              type: string
    access_status:
      description: The status of the policy test request.
      enum:
        - success
      example: success
      type: string
    access_string_key_map_device_session:
      additionalProperties:
        $ref: '#/components/schemas/access_device_session'
      type: object
    access_tag:
      description: A tag
      properties:
        app_count:
          description: The number of applications that have this tag
          example: 1
          type: integer
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        name:
          $ref: '#/components/schemas/access_tags_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      required:
        - name
      type: object
    access_tag_without_app_count:
      description: A tag
      properties:
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        name:
          $ref: '#/components/schemas/access_tags_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      required:
        - name
      type: object
    access_tags:
      description: The tags you want assigned to an application. Tags are used to filter applications in the App Launcher dashboard.
      items:
        description: The tag associated with an application.
        example: engineers
        type: string
      type: array
    access_tags_components-schemas-name:
      description: The name of the tag
      example: engineers
      type: string
    access_tags_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_tag'
              type: array
          type: object
    access_tags_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/access_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/access_tag'
          type: object
    access_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      type: string
    access_title:
      default: Welcome!
      description: The title shown on the landing page.
      example: Welcome back!
      type: string
    access_total_users:
      description: The total number of users in the user base.
      example: 20
      type: integer
    access_type:
      description: The application type.
      enum:
        - self_hosted
        - saas
        - ssh
        - vnc
        - app_launcher
        - warp
        - biso
        - bookmark
        - dash_sso
      example: self_hosted
      type: string
    access_ui_read_only_toggle_reason:
      description: A description of the reason why the UI read only field is being toggled.
      example: Temporarily turn off the UI read only lock to make a change via the UI
      type: string
    access_uid:
      description: The unique API identifier for the user.
      type: string
    access_update_status:
      description: The status of the policy test.
      enum:
        - blocked
        - processing
        - complete
      example: complete
      type: string
    access_user_result:
      description: Policy evaluation result for an individual user.
      enum:
        - approved
        - blocked
      example: approved
      type: string
    access_user_seat_expiration_inactive_time:
      description: 'The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count.  Minimum value for this setting is 1 month (730h). Must be in the format `300ms` or `2h45m`. Valid time units are: `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.'
      example: 730h
      type: string
    access_users:
      properties:
        access_seat:
          $ref: '#/components/schemas/access_schemas-access_seat'
        active_device_count:
          $ref: '#/components/schemas/access_active_device_count'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        email:
          $ref: '#/components/schemas/access_email'
        gateway_seat:
          $ref: '#/components/schemas/access_schemas-gateway_seat'
        id:
          $ref: '#/components/schemas/access_uuid'
        last_successful_login:
          $ref: '#/components/schemas/access_last_successful_login'
        name:
          $ref: '#/components/schemas/access_users_components-schemas-name'
        seat_uid:
          $ref: '#/components/schemas/access_schemas-seat_uid'
        uid:
          $ref: '#/components/schemas/access_uid'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_users_approved:
      description: The number of (processed) users approved based on policy evaluation results.
      example: 5
      type: integer
    access_users_blocked:
      description: The number of (processed) users blocked based on policy evaluation results.
      example: 5
      type: integer
    access_users_components-schemas-name:
      description: The name of the user.
      example: Jane Doe
      type: string
    access_users_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/access_api-response-collection'
        - properties:
            result_info:
              properties:
                count:
                  example: 1
                page:
                  example: 1
                per_page:
                  example: 100
                total_count:
                  example: 1
              type: object
        - properties:
            result:
              items:
                $ref: '#/components/schemas/access_users'
              type: array
    access_uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    access_vnc_props:
      allOf:
        - $ref: '#/components/schemas/access_self_hosted_props'
        - properties:
            type:
              description: The application type.
              example: vnc
              type: string
    access_warp_auth_session_duration:
      description: 'The amount of time that tokens issued for applications will be valid. Must be in the format `30m` or `2h45m`. Valid time units are: m, h.'
      example: 24h
      type: string
    access_warp_props:
      allOf:
        - $ref: '#/components/schemas/access_feature_app_props'
        - properties:
            domain:
              example: authdomain.cloudflareaccess.com/warp
              readOnly: true
            name:
              default: Warp Login App
              example: Warp Login App
              readOnly: true
            type:
              description: The application type.
              example: warp
              type: string
    access_yandex:
      allOf:
        - $ref: '#/components/schemas/access_identity-provider'
        - properties:
            config:
              $ref: '#/components/schemas/access_generic-oauth-config'
          type: object
      title: Yandex
      type: object
    addressing_address-maps:
      properties:
        can_delete:
          $ref: '#/components/schemas/addressing_can_delete'
        can_modify_ips:
          $ref: '#/components/schemas/addressing_can_modify_ips'
        created_at:
          $ref: '#/components/schemas/addressing_timestamp'
        default_sni:
          $ref: '#/components/schemas/addressing_default_sni'
        description:
          $ref: '#/components/schemas/addressing_schemas-description'
        enabled:
          $ref: '#/components/schemas/addressing_enabled'
        id:
          $ref: '#/components/schemas/addressing_identifier'
        modified_at:
          $ref: '#/components/schemas/addressing_timestamp'
      type: object
    addressing_address-maps-ip:
      properties:
        created_at:
          $ref: '#/components/schemas/addressing_timestamp'
        ip:
          $ref: '#/components/schemas/addressing_ip'
      type: object
    addressing_address-maps-membership:
      properties:
        can_delete:
          $ref: '#/components/schemas/addressing_schemas-can_delete'
        created_at:
          $ref: '#/components/schemas/addressing_timestamp'
        identifier:
          $ref: '#/components/schemas/addressing_schemas-identifier'
        kind:
          $ref: '#/components/schemas/addressing_kind'
      type: object
    addressing_advertised:
      description: Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
      example: true
      nullable: true
      type: boolean
    addressing_advertised_response:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-single'
        - properties:
            result:
              properties:
                advertised:
                  $ref: '#/components/schemas/addressing_schemas-advertised'
                advertised_modified_at:
                  $ref: '#/components/schemas/addressing_modified_at_nullable'
              type: object
    addressing_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/addressing_result_info'
      type: object
    addressing_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/addressing_messages'
        messages:
          $ref: '#/components/schemas/addressing_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    addressing_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/addressing_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/addressing_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    addressing_api-response-single:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-common'
      type: object
    addressing_approved:
      description: Approval state of the prefix (P = pending, V = active).
      example: P
      type: string
    addressing_asn:
      description: Autonomous System Number (ASN) the prefix will be advertised under.
      example: 209242
      nullable: true
      type: integer
    addressing_bgp_on_demand:
      properties:
        advertised:
          $ref: '#/components/schemas/addressing_advertised'
        advertised_modified_at:
          $ref: '#/components/schemas/addressing_modified_at_nullable'
        on_demand_enabled:
          $ref: '#/components/schemas/addressing_on_demand_enabled'
        on_demand_locked:
          $ref: '#/components/schemas/addressing_on_demand_locked'
      type: object
    addressing_bgp_prefix_update_advertisement:
      properties:
        on_demand:
          properties:
            advertised:
              type: boolean
          type: object
      type: object
    addressing_bgp_signal_opts:
      properties:
        enabled:
          $ref: '#/components/schemas/addressing_bgp_signaling_enabled'
        modified_at:
          $ref: '#/components/schemas/addressing_bgp_signaling_modified_at'
      type: object
    addressing_bgp_signaling_enabled:
      description: Whether control of advertisement of the prefix to the Internet is enabled to be performed via BGP signal
      example: false
      type: boolean
    addressing_bgp_signaling_modified_at:
      description: Last time BGP signaling control was toggled. This field is null if BGP signaling has never been enabled.
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      nullable: true
      type: string
    addressing_can_delete:
      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
      type: boolean
    addressing_can_modify_ips:
      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
      type: boolean
    addressing_cidr:
      description: IP Prefix in Classless Inter-Domain Routing format.
      example: 192.0.2.0/24
      type: string
    addressing_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/addressing_address-maps'
              type: array
    addressing_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/addressing_address-maps'
    addressing_create_binding_request:
      properties:
        cidr:
          $ref: '#/components/schemas/addressing_cidr'
        service_id:
          $ref: '#/components/schemas/addressing_service_identifier'
      type: object
    addressing_default_sni:
      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
      type: string
    addressing_delegated_account_identifier:
      description: Account identifier for the account to which prefix is being delegated.
      example: b1946ac92492d2347c6235b4d2611184
      maxLength: 32
      type: string
    addressing_delegation_identifier:
      description: Delegation identifier tag.
      example: d933b1530bc56c9953cf8ce166da8004
      maxLength: 32
      readOnly: true
      type: string
    addressing_description:
      description: Description of the prefix.
      example: Internal test prefix
      maxLength: 1000
      type: string
    addressing_enabled:
      default: false
      description: Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.
      example: true
      nullable: true
      type: boolean
    addressing_etag:
      description: A digest of the IP data. Useful for determining if the data has changed.
      example: a8e453d9d129a3769407127936edfdb0
      type: string
    addressing_full_response:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/addressing_address-maps'
                - properties:
                    ips:
                      $ref: '#/components/schemas/addressing_schemas-ips'
                    memberships:
                      $ref: '#/components/schemas/addressing_memberships'
                  type: object
          type: object
    addressing_id_response:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/addressing_delegation_identifier'
              type: object
    addressing_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    addressing_ip:
      description: An IPv4 or IPv6 address.
      example: 192.0.2.1
      type: string
    addressing_ip_address:
      description: An IPv4 or IPv6 address.
      example: 192.0.2.1
      type: string
    addressing_ipam-bgp-prefixes:
      properties:
        asn:
          $ref: '#/components/schemas/addressing_asn'
        bgp_signal_opts:
          $ref: '#/components/schemas/addressing_bgp_signal_opts'
        cidr:
          $ref: '#/components/schemas/addressing_cidr'
        created_at:
          $ref: '#/components/schemas/addressing_timestamp'
        id:
          $ref: '#/components/schemas/addressing_identifier'
        modified_at:
          $ref: '#/components/schemas/addressing_timestamp'
        on_demand:
          $ref: '#/components/schemas/addressing_bgp_on_demand'
      type: object
    addressing_ipam-delegations:
      properties:
        cidr:
          $ref: '#/components/schemas/addressing_cidr'
        created_at:
          $ref: '#/components/schemas/addressing_timestamp'
        delegated_account_id:
          $ref: '#/components/schemas/addressing_delegated_account_identifier'
        id:
          $ref: '#/components/schemas/addressing_delegation_identifier'
        modified_at:
          $ref: '#/components/schemas/addressing_timestamp'
        parent_prefix_id:
          $ref: '#/components/schemas/addressing_identifier'
      type: object
    addressing_ipam-prefixes:
      properties:
        account_id:
          $ref: '#/components/schemas/addressing_identifier'
        advertised:
          $ref: '#/components/schemas/addressing_advertised'
        advertised_modified_at:
          $ref: '#/components/schemas/addressing_modified_at_nullable'
        approved:
          $ref: '#/components/schemas/addressing_approved'
        asn:
          $ref: '#/components/schemas/addressing_asn'
        cidr:
          $ref: '#/components/schemas/addressing_cidr'
        created_at:
          $ref: '#/components/schemas/addressing_timestamp'
        description:
          $ref: '#/components/schemas/addressing_description'
        id:
          $ref: '#/components/schemas/addressing_identifier'
        loa_document_id:
          $ref: '#/components/schemas/addressing_loa_document_identifier'
        modified_at:
          $ref: '#/components/schemas/addressing_timestamp'
        on_demand_enabled:
          $ref: '#/components/schemas/addressing_on_demand_enabled'
        on_demand_locked:
          $ref: '#/components/schemas/addressing_on_demand_locked'
      type: object
    addressing_ips:
      properties:
        etag:
          $ref: '#/components/schemas/addressing_etag'
        ipv4_cidrs:
          $ref: '#/components/schemas/addressing_ipv4_cidrs'
        ipv6_cidrs:
          $ref: '#/components/schemas/addressing_ipv6_cidrs'
      type: object
    addressing_ips_jdcloud:
      properties:
        etag:
          $ref: '#/components/schemas/addressing_etag'
        ipv4_cidrs:
          $ref: '#/components/schemas/addressing_ipv4_cidrs'
        ipv6_cidrs:
          $ref: '#/components/schemas/addressing_ipv6_cidrs'
        jdcloud_cidrs:
          $ref: '#/components/schemas/addressing_jdcloud_cidrs'
      type: object
    addressing_ipv4_cidrs:
      description: List of Cloudflare IPv4 CIDR addresses.
      items:
        description: IPv4 CIDR.
        example: 199.27.128.0/21
        type: string
      type: array
    addressing_ipv6_cidrs:
      description: List of Cloudflare IPv6 CIDR addresses.
      items:
        description: IPv6 CIDR.
        example: 2400:cb00::/32
        type: string
      type: array
    addressing_jdcloud_cidrs:
      description: List IPv4 and IPv6 CIDRs, only populated if `?networks=jdcloud` is used.
      items:
        description: IPv4 or IPv6 CIDR.
        example: 199.27.128.0/21
        type: string
      type: array
    addressing_kind:
      description: The type of the membership.
      enum:
        - zone
        - account
      example: zone
      type: string
    addressing_loa_document_identifier:
      description: Identifier for the uploaded LOA document.
      example: d933b1530bc56c9953cf8ce166da8004
      maxLength: 32
      nullable: true
      type: string
    addressing_loa_upload_response:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-single'
        - properties:
            result:
              properties:
                filename:
                  description: Name of LOA document.
                  example: document.pdf
                  type: string
              type: object
    addressing_memberships:
      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/addressing_address-maps-membership'
      type: array
    addressing_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    addressing_modified_at_nullable:
      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"
      format: date-time
      nullable: true
      type: string
    addressing_on_demand_enabled:
      description: Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
      example: true
      type: boolean
    addressing_on_demand_locked:
      description: Whether advertisement status of the prefix is locked, meaning it cannot be changed.
      example: false
      type: boolean
    addressing_provisioning:
      description: Status of a Service Binding's deployment to the Cloudflare network
      properties:
        state:
          description: |
            When a binding has been deployed to a majority of Cloudflare datacenters, the binding will become active and can be used with its associated service.
          enum:
            - provisioning
            - active
          example: provisioning
          type: string
      type: object
    addressing_response_collection:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/addressing_ipam-prefixes'
              type: array
    addressing_response_collection_bgp:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/addressing_ipam-bgp-prefixes'
              type: array
    addressing_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    addressing_schemas-advertised:
      description: Enablement of prefix advertisement to the Internet.
      example: true
      type: boolean
    addressing_schemas-can_delete:
      description: Controls whether the membership can be deleted via the API or not.
      example: true
      readOnly: true
      type: boolean
    addressing_schemas-description:
      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
      type: string
    addressing_schemas-identifier:
      description: The identifier for the membership (eg. a zone or account tag).
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    addressing_schemas-ips:
      description: The set of IPs on the Address Map.
      items:
        $ref: '#/components/schemas/addressing_address-maps-ip'
      type: array
    addressing_schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/addressing_ipam-delegations'
              type: array
    addressing_schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/addressing_ipam-delegations'
    addressing_service_binding:
      properties:
        cidr:
          $ref: '#/components/schemas/addressing_cidr'
        id:
          $ref: '#/components/schemas/addressing_identifier'
        provisioning:
          $ref: '#/components/schemas/addressing_provisioning'
        service_id:
          $ref: '#/components/schemas/addressing_service_identifier'
        service_name:
          $ref: '#/components/schemas/addressing_service_name'
      type: object
    addressing_service_identifier:
      description: Identifier
      example: 2db684ee7ca04e159946fd05b99e1bcd
      maxLength: 32
      type: string
    addressing_service_name:
      description: Name of a service running on the Cloudflare network
      example: Magic Transit
      type: string
    addressing_single_response:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/addressing_ipam-prefixes'
    addressing_single_response_bgp:
      allOf:
        - $ref: '#/components/schemas/addressing_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/addressing_ipam-bgp-prefixes'
    addressing_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      type: string
    api-shield_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/api-shield_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/api-shield_result_info'
      type: object
    api-shield_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/api-shield_messages'
        messages:
          $ref: '#/components/schemas/api-shield_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    api-shield_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/api-shield_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/api-shield_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    api-shield_api-response-single:
      allOf:
        - $ref: '#/components/schemas/api-shield_api-response-common'
      type: object
    api-shield_api_discovery_origin:
      description: |
        * `ML` - Discovered operation was sourced using ML API Discovery * `SessionIdentifier` - Discovered operation was sourced using Session Identifier API Discovery
      enum:
        - ML
        - SessionIdentifier
      type: string
    api-shield_api_discovery_patch_multiple_request:
      additionalProperties:
        $ref: '#/components/schemas/api-shield_api_discovery_patch_multiple_request_entry'
      example:
        3818d821-5901-4147-a474-f5f5aec1d54e:
          state: ignored
        b17c8043-99a0-4202-b7d9-8f7cdbee02cd:
          state: review
      type: object
    api-shield_api_discovery_patch_multiple_request_entry:
      description: Mappings of discovered operations (keys) to objects describing their state
      properties:
        state:
          $ref: '#/components/schemas/api-shield_api_discovery_state_patch'
      type: object
    api-shield_api_discovery_state:
      description: |
        State of operation in API Discovery
          * `review` - Operation is not saved into API Shield Endpoint Management
          * `saved` - Operation is saved into API Shield Endpoint Management
          * `ignored` - Operation is marked as ignored
      enum:
        - review
        - saved
        - ignored
      type: string
    api-shield_api_discovery_state_patch:
      description: |
        Mark state of operation in API Discovery
          * `review` - Mark operation as for review
          * `ignored` - Mark operation as ignored
      enum:
        - review
        - ignored
      type: string
    api-shield_auth_id_characteristic:
      description: Auth ID Characteristic
      properties:
        name:
          description: The name of the characteristic field, i.e., the header or cookie name.
          example: authorization
          maxLength: 128
          type: string
        type:
          description: The type of characteristic.
          enum:
            - header
            - cookie
          example: header
          type: string
      required:
        - type
        - name
    api-shield_auth_id_characteristic_jwt_claim:
      description: Auth ID Characteristic extracted from JWT Token Claims
      properties:
        name:
          description: "Claim location expressed as `$(token_config_id):$(json_path)`, where `token_config_id` \nis the ID of the token configuration used in validating the JWT, and `json_path` is a RFC 9535 \nJSONPath (https://goessner.net/articles/JsonPath/, https://www.rfc-editor.org/rfc/rfc9535.html).\nThe JSONPath expression may be in dot or bracket notation, may only specify literal keys\nor array indexes, and must return a singleton value, which will be interpreted as a string.\n"
          example: e0de1a3a-8c2c-4f90-98d8-cbdf0a3f2cb5:$.foo.bar[0].baz
          maxLength: 128
          pattern: ^(?<token_config_id>[a-z0-9\-]{32,36}):\$(?<json_path>.*?)$
          type: string
        type:
          description: The type of characteristic.
          enum:
            - jwt
          example: jwt
          type: string
      required:
        - type
        - name
      type: object
    api-shield_auth_id_characteristics:
      items:
        anyOf:
          - $ref: '#/components/schemas/api-shield_auth_id_characteristic'
          - $ref: '#/components/schemas/api-shield_auth_id_characteristic_jwt_claim'
      maxItems: 10
      type: array
      uniqueItems: true
    api-shield_auth_id_tokens:
      description: The total number of auth-ids seen across this calculation.
      readOnly: true
      type: integer
    api-shield_basic_operation:
      properties:
        endpoint:
          $ref: '#/components/schemas/api-shield_endpoint'
        host:
          $ref: '#/components/schemas/api-shield_host'
        method:
          $ref: '#/components/schemas/api-shield_method'
      required:
        - method
        - host
        - endpoint
      type: object
    api-shield_confidence_intervals_bounds:
      description: Upper and lower bound for percentile estimate
      properties:
        lower:
          description: Lower bound for percentile estimate
          example: 20.5
          type: number
        upper:
          description: Upper bound for percentile estimate
          example: 30.4
          type: number
      readOnly: true
      type: object
    api-shield_configuration:
      properties:
        auth_id_characteristics:
          $ref: '#/components/schemas/api-shield_auth_id_characteristics'
      required:
        - auth_id_characteristics
      type: object
    api-shield_configuration-single-response:
      allOf:
        - $ref: '#/components/schemas/api-shield_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/api-shield_configuration'
          required:
            - result
          type: object
    api-shield_data_points:
      description: The number of data points used for the threshold suggestion calculation.
      readOnly: true
      type: integer
    api-shield_discovery_operation:
      allOf:
        - properties:
            features:
              $ref: '#/components/schemas/api-shield_traffic_stats'
            id:
              $ref: '#/components/schemas/api-shield_schemas-uuid'
            last_updated:
              $ref: '#/components/schemas/api-shield_schemas-timestamp'
            origin:
              description: API discovery engine(s) that discovered this operation
              items:
                $ref: '#/components/schemas/api-shield_api_discovery_origin'
              type: array
            state:
              $ref: '#/components/schemas/api-shield_api_discovery_state'
          required:
            - id
            - last_updated
            - state
            - origin
          type: object
        - $ref: '#/components/schemas/api-shield_basic_operation'
    api-shield_endpoint:
      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}
      format: uri-template
      maxLength: 4096
      pattern: ^/.*$
      type: string
    api-shield_host:
      description: RFC3986-compliant host.
      example: www.example.com
      format: hostname
      maxLength: 255
      type: string
    api-shield_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    api-shield_kind:
      description: Kind of schema
      enum:
        - openapi_v3
      example: openapi_v3
      type: string
    api-shield_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    api-shield_method:
      description: The HTTP method used to access the endpoint.
      enum:
        - GET
        - POST
        - HEAD
        - OPTIONS
        - PUT
        - DELETE
        - CONNECT
        - PATCH
        - TRACE
      example: GET
      type: string
    api-shield_multiple-operation-response:
      allOf:
        - $ref: '#/components/schemas/api-shield_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/api-shield_operation'
              type: array
          required:
            - result
          type: object
    api-shield_multiple-operation-response-paginated:
      allOf:
        - $ref: '#/components/schemas/api-shield_api-response-collection'
        - properties:
            result:
              items:
                allOf:
                  - $ref: '#/components/schemas/api-shield_operation'
                  - properties:
                      features: {}
                    type: object
              type: array
          required:
            - result
          type: object
    api-shield_object-with-operation-id:
      properties:
        operation_id:
          allOf:
            - description: The ID of the operation
              type: string
            - $ref: '#/components/schemas/api-shield_schemas-uuid'
      required:
        - operation_id
      type: object
    api-shield_openapi:
      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
      type: object
    api-shield_openapi-with-thresholds:
      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
      type: object
    api-shield_operation:
      allOf:
        - $ref: '#/components/schemas/api-shield_standard_operation'
        - properties:
            features:
              $ref: '#/components/schemas/api-shield_operation_features'
          type: object
    api-shield_operation_feature_api_routing:
      example:
        api_routing:
          last_updated: "2014-01-01T05:20:00.12345Z"
          route: https://api.example.com/api/service
      properties:
        api_routing:
          description: API Routing settings on endpoint.
          properties:
            last_updated:
              $ref: '#/components/schemas/api-shield_timestamp'
            route:
              description: Target route.
              example: https://api.example.com/api/service
              type: string
          type: object
      readOnly: true
      type: object
    api-shield_operation_feature_confidence_intervals:
      example:
        confidence_intervals:
          last_updated: "2014-01-01T05:20:00.12345Z"
          suggested_threshold:
            confidence_intervals:
              p90:
                lower: 23.1
                upper: 23.9
              p95:
                lower: 22
                upper: 24.1
              p99:
                lower: 20.2
                upper: 30
            mean: 23.5
      properties:
        confidence_intervals:
          properties:
            last_updated:
              $ref: '#/components/schemas/api-shield_timestamp'
            suggested_threshold:
              properties:
                confidence_intervals:
                  properties:
                    p90:
                      $ref: '#/components/schemas/api-shield_confidence_intervals_bounds'
                    p95:
                      $ref: '#/components/schemas/api-shield_confidence_intervals_bounds'
                    p99:
                      $ref: '#/components/schemas/api-shield_confidence_intervals_bounds'
                  type: object
                mean:
                  description: Suggested threshold.
                  example: 25.5
                  type: number
              type: object
          type: object
      readOnly: true
      type: object
    api-shield_operation_feature_parameter_schemas:
      properties:
        parameter_schemas:
          properties:
            last_updated:
              $ref: '#/components/schemas/api-shield_timestamp'
            parameter_schemas:
              $ref: '#/components/schemas/api-shield_parameter_schemas_definition'
          type: object
      readOnly: true
      required:
        - parameter_schemas
        - last_updated
      type: object
    api-shield_operation_feature_schema_info:
      properties:
        schema_info:
          properties:
            active_schema:
              description: Schema active on endpoint.
              properties:
                created_at:
                  $ref: '#/components/schemas/api-shield_timestamp'
                id:
                  $ref: '#/components/schemas/api-shield_schemas-uuid'
                is_learned:
                  description: True if schema is Cloudflare-provided.
                  example: true
                  type: boolean
                name:
                  description: Schema file name.
                  example: api-endpoints-8694824bf5c04d019edcbf399c03c103-api-discovery.example.com-thresholds.json
                  type: string
              type: object
            learned_available:
              description: True if a Cloudflare-provided learned schema is available for this endpoint.
              example: true
              type: boolean
            mitigation_action:
              description: Action taken on requests failing validation.
              enum:
                - none
                - log
                - block
              example: block
              nullable: true
              type: string
          type: object
      readOnly: true
      type: object
    api-shield_operation_feature_thresholds:
      properties:
        thresholds:
          properties:
            auth_id_tokens:
              $ref: '#/components/schemas/api-shield_auth_id_tokens'
            data_points:
              $ref: '#/components/schemas/api-shield_data_points'
            last_updated:
              $ref: '#/components/schemas/api-shield_timestamp'
            p50:
              $ref: '#/components/schemas/api-shield_p50'
            p90:
              $ref: '#/components/schemas/api-shield_p90'
            p99:
              $ref: '#/components/schemas/api-shield_p99'
            period_seconds:
              $ref: '#/components/schemas/api-shield_period_seconds'
            requests:
              $ref: '#/components/schemas/api-shield_requests'
            suggested_threshold:
              $ref: '#/components/schemas/api-shield_suggested_threshold'
          type: object
      readOnly: true
      required:
        - period_seconds
        - suggested_threshold
        - p50
        - p90
        - p99
        - requests
        - auth_id_tokens
        - data_points
        - last_updated
      type: object
    api-shield_operation_features:
      anyOf:
        - $ref: '#/components/schemas/api-shield_operation_feature_thresholds'
        - $ref: '#/components/schemas/api-shield_operation_feature_parameter_schemas'
        - $ref: '#/components/schemas/api-shield_operation_feature_api_routing'
        - $ref: '#/components/schemas/api-shield_operation_feature_confidence_intervals'
        - $ref: '#/components/schemas/api-shield_operation_feature_schema_info'
      readOnly: true
      type: object
    api-shield_operation_mitigation_action:
      description: |
        When set, this applies a mitigation action to this operation

          - `log` log request when request does not conform to schema for this operation
          - `block` deny access to the site when request does not conform to schema for this operation
          - `none` will skip mitigation for this operation
          - `null` indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied
      enum:
        - log
        - block
        - none
        - 
      example: block
      nullable: true
      type: string
    api-shield_operation_schema_validation_settings:
      properties:
        mitigation_action:
          $ref: '#/components/schemas/api-shield_operation_mitigation_action'
      type: object
    api-shield_operation_schema_validation_settings_multiple_request:
      additionalProperties:
        $ref: '#/components/schemas/api-shield_operation_schema_validation_settings_multiple_request_entry'
      example:
        3818d821-5901-4147-a474-f5f5aec1d54e:
          mitigation_action: log
        b17c8043-99a0-4202-b7d9-8f7cdbee02cd:
          mitigation_action: block
      type: object
    api-shield_operation_schema_validation_settings_multiple_request_entry:
      description: Operation ID to mitigation action mappings
      properties:
        mitigation_action:
          $ref: '#/components/schemas/api-shield_operation_mitigation_action'
      type: object
    api-shield_p50:
      description: The p50 quantile of requests (in period_seconds).
      readOnly: true
      type: integer
    api-shield_p90:
      description: The p90 quantile of requests (in period_seconds).
      readOnly: true
      type: integer
    api-shield_p99:
      description: The p99 quantile of requests (in period_seconds).
      readOnly: true
      type: integer
    api-shield_parameter_schemas_definition:
      description: An operation schema object containing a response.
      example:
        parameters:
          - description: Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema.
            in: path
            name: var1
            required: true
            schema:
              maximum: 10
              minimum: 1
              type: integer
        responses:
      properties:
        parameters:
          description: An array containing the learned parameter schemas.
          example:
            - description: Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema.
              in: path
              name: var1
              required: true
              schema:
                maximum: 10
                minimum: 1
                type: integer
          items:
            type: object
          readOnly: true
          type: array
        responses:
          description: An empty response object. This field is required to yield a valid operation schema.
          nullable: true
          readOnly: true
          type: object
      readOnly: true
      type: object
    api-shield_patch_discoveries_response:
      allOf:
        - $ref: '#/components/schemas/api-shield_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/api-shield_api_discovery_patch_multiple_request'
          required:
            - result
          type: object
    api-shield_patch_discovery_response:
      allOf:
        - $ref: '#/components/schemas/api-shield_api-response-common'
        - properties:
            result:
              properties:
                state:
                  $ref: '#/components/schemas/api-shield_api_discovery_state'
              type: object
          required:
            - result
          type: object
    api-shield_period_seconds:
      description: The period over which this threshold is suggested.
      readOnly: true
      type: integer
    api-shield_properties:
      description: Requests information about certain properties.
      example:
        - auth_id_characteristics
      items:
        enum:
          - auth_id_characteristics
        example: auth_id_characteristics
        type: string
      type: array
      uniqueItems: true
    api-shield_public_schema:
      properties:
        created_at:
          $ref: '#/components/schemas/api-shield_schemas-timestamp'
        kind:
          $ref: '#/components/schemas/api-shield_kind'
        name:
          description: Name of the schema
          example: petstore schema
          type: string
        schema_id:
          $ref: '#/components/schemas/api-shield_schemas-uuid'
        source:
          description: Source of the schema
          example: <schema file bytes>
          type: string
        validation_enabled:
          $ref: '#/components/schemas/api-shield_validation_enabled'
      required:
        - schema_id
        - name
        - kind
        - created_at
      type: object
    api-shield_requests:
      description: The estimated number of requests covered by these calculations.
      readOnly: true
      type: integer
    api-shield_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    api-shield_schema-response-with-thresholds:
      allOf:
        - $ref: '#/components/schemas/api-shield_api-response-common'
        - properties:
            result:
              properties:
                schemas:
                  items:
                    $ref: '#/components/schemas/api-shield_openapi-with-thresholds'
                  type: array
                timestamp:
                  type: string
              type: object
          required:
            - result
          type: object
    api-shield_schema_response_discovery:
      allOf:
        - $ref: '#/components/schemas/api-shield_api-response-common'
        - properties:
            result:
              properties:
                schemas:
                  items:
                    $ref: '#/components/schemas/api-shield_openapi'
                  type: array
                timestamp:
                  $ref: '#/components/schemas/api-shield_schemas-timestamp'
              required:
                - timestamp
                - schemas
              type: object
          required:
            - result
          type: object
    api-shield_schema_upload_details_errors_critical:
      properties:
        critical:
          description: Diagnostic critical error events that occurred during processing.
          items:
            $ref: '#/components/schemas/api-shield_schema_upload_log_event'
          type: array
        errors:
          description: Diagnostic error events that occurred during processing.
          items:
            $ref: '#/components/schemas/api-shield_schema_upload_log_event'
          type: array
      type: object
    api-shield_schema_upload_details_warnings_only:
      properties:
        warnings:
          description: Diagnostic warning events that occurred during processing. These events are non-critical errors found within the schema.
          items:
            $ref: '#/components/schemas/api-shield_schema_upload_log_event'
          type: array
      type: object
    api-shield_schema_upload_failure:
      allOf:
        - $ref: '#/components/schemas/api-shield_api-response-common-failure'
        - properties:
            upload_details:
              $ref: '#/components/schemas/api-shield_schema_upload_details_errors_critical'
          type: object
    api-shield_schema_upload_log_event:
      properties:
        code:
          description: Code that identifies the event that occurred.
          example: 28
          type: integer
        locations:
          description: JSONPath location(s) in the schema where these events were encountered.  See [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) for JSONPath specification.
          items:
            description: JSONPath location in the schema where these events were encountered.  See [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) for JSONPath specification.
            example: .paths["/user/{username}"].put
            type: string
          type: array
        message:
          description: Diagnostic message that describes the event.
          example: 'unsupported media type: application/octet-stream'
          type: string
      required:
        - code
      type: object
    api-shield_schema_upload_response:
      properties:
        schema:
          $ref: '#/components/schemas/api-shield_public_schema'
        upload_details:
          $ref: '#/components/schemas/api-shield_schema_upload_details_warnings_only'
      required:
        - schema
      type: object
    api-shield_schemas-identifier:
      allOf:
        - $ref: '#/components/schemas/api-shield_identifier'
        - readOnly: true
          type: string
    api-shield_schemas-timestamp:
      allOf:
        - $ref: '#/components/schemas/api-shield_timestamp'
        - readOnly: true
          type: string
    api-shield_schemas-uuid:
      allOf:
        - minLength: 36
          type: string
        - $ref: '#/components/schemas/api-shield_uuid'
    api-shield_single-operation-response:
      allOf:
        - $ref: '#/components/schemas/api-shield_api-response-common'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/api-shield_operation'
                - properties:
                    features: {}
                  type: object
          required:
            - result
          type: object
    api-shield_standard_operation:
      allOf:
        - $ref: '#/components/schemas/api-shield_basic_operation'
        - properties:
            last_updated:
              $ref: '#/components/schemas/api-shield_schemas-timestamp'
            operation_id:
              $ref: '#/components/schemas/api-shield_schemas-uuid'
          required:
            - operation_id
            - last_updated
          type: object
    api-shield_suggested_threshold:
      description: The suggested threshold in requests done by the same auth_id or period_seconds.
      readOnly: true
      type: integer
    api-shield_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      type: string
    api-shield_traffic_stats:
      properties:
        traffic_stats:
          properties:
            last_updated:
              $ref: '#/components/schemas/api-shield_schemas-timestamp'
            period_seconds:
              description: The period in seconds these statistics were computed over
              example: 3600
              readOnly: true
              type: integer
            requests:
              description: The average number of requests seen during this period
              example: 1987.06
              format: float
              readOnly: true
              type: number
          required:
            - period_seconds
            - requests
            - last_updated
          type: object
      readOnly: true
      type: object
    api-shield_uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    api-shield_validation_default_mitigation_action:
      description: |
        The default mitigation action used when there is no mitigation action defined on the operation

        Mitigation actions are as follows:

          * `log` - log request when request does not conform to schema
          * `block` - deny access to the site when request does not conform to schema

        A special value of of `none` will skip running schema validation entirely for the request when there is no mitigation action defined on the operation
      enum:
        - none
        - log
        - block
      example: block
      type: string
    api-shield_validation_default_mitigation_action_patch:
      description: |
        The default mitigation action used when there is no mitigation action defined on the operation
        Mitigation actions are as follows:

          * `log` - log request when request does not conform to schema
          * `block` - deny access to the site when request does not conform to schema

        A special value of of `none` will skip running schema validation entirely for the request when there is no mitigation action defined on the operation

        `null` will have no effect.
      enum:
        - none
        - log
        - block
        - 
      example: block
      nullable: true
      type: string
    api-shield_validation_enabled:
      description: Flag whether schema is enabled for validation.
      type: boolean
    api-shield_validation_override_mitigation_action:
      description: |
        When set, this overrides both zone level and operation level mitigation actions.

          - `none` will skip running schema validation entirely for the request
          - `null` indicates that no override is in place
      enum:
        - none
        - 
      example: disable_override
      nullable: true
      type: string
    api-shield_validation_override_mitigation_action_patch:
      description: |
        When set, this overrides both zone level and operation level mitigation actions.

          - `none` will skip running schema validation entirely for the request

        To clear any override, use the special value `disable_override`

        `null` will have no effect.
      enum:
        - none
        - disable_override
        - 
      example: none
      nullable: true
      type: string
    api-shield_validation_override_mitigation_action_write:
      description: |
        When set, this overrides both zone level and operation level mitigation actions.

          - `none` will skip running schema validation entirely for the request
          - `null` indicates that no override is in place

        To clear any override, use the special value `disable_override` or `null`
      enum:
        - none
        - disable_override
        - 
      example: none
      nullable: true
      type: string
    api-shield_zone_schema_validation_settings:
      properties:
        validation_default_mitigation_action:
          $ref: '#/components/schemas/api-shield_validation_default_mitigation_action'
        validation_override_mitigation_action:
          $ref: '#/components/schemas/api-shield_validation_override_mitigation_action'
      type: object
    api-shield_zone_schema_validation_settings_patch:
      properties:
        validation_default_mitigation_action:
          $ref: '#/components/schemas/api-shield_validation_default_mitigation_action_patch'
        validation_override_mitigation_action:
          $ref: '#/components/schemas/api-shield_validation_override_mitigation_action_patch'
      type: object
    api-shield_zone_schema_validation_settings_put:
      properties:
        validation_default_mitigation_action:
          $ref: '#/components/schemas/api-shield_validation_default_mitigation_action'
        validation_override_mitigation_action:
          $ref: '#/components/schemas/api-shield_validation_override_mitigation_action_write'
      required:
        - validation_default_mitigation_action
      type: object
    argo-analytics_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/argo-analytics_messages'
        messages:
          $ref: '#/components/schemas/argo-analytics_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    argo-analytics_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/argo-analytics_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/argo-analytics_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    argo-analytics_api-response-single:
      allOf:
        - $ref: '#/components/schemas/argo-analytics_api-response-common'
        - properties:
            result:
              anyOf:
                - nullable: true
                  type: object
                - nullable: true
                  type: string
      type: object
    argo-analytics_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    argo-analytics_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    argo-analytics_response_single:
      allOf:
        - $ref: '#/components/schemas/argo-analytics_api-response-single'
        - properties:
            result:
              type: object
          type: object
    argo-config_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/argo-config_messages'
        messages:
          $ref: '#/components/schemas/argo-config_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    argo-config_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/argo-config_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/argo-config_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    argo-config_api-response-single:
      allOf:
        - $ref: '#/components/schemas/argo-config_api-response-common'
        - properties:
            result:
              anyOf:
                - nullable: true
                  type: object
                - nullable: true
                  type: string
      type: object
    argo-config_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    argo-config_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    argo-config_patch:
      description: Update enablement of Argo Smart Routing
      properties:
        value:
          $ref: '#/components/schemas/argo-config_value'
      required:
        - value
      type: object
    argo-config_response_single:
      allOf:
        - $ref: '#/components/schemas/argo-config_api-response-single'
        - properties:
            result:
              type: object
          type: object
    argo-config_value:
      description: Enables Argo Smart Routing.
      enum:
        - "on"
        - "off"
      example: "on"
      type: string
    bill-subs-api_account_subscription_response_collection:
      allOf:
        - $ref: '#/components/schemas/bill-subs-api_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/bill-subs-api_subscription'
              type: array
          type: object
    bill-subs-api_account_subscription_response_single:
      allOf:
        - $ref: '#/components/schemas/bill-subs-api_api-response-single'
        - properties:
            result:
              type: object
          type: object
    bill-subs-api_action:
      description: The billing item action.
      example: subscription
      maxLength: 30
      readOnly: true
      type: string
    bill-subs-api_amount:
      description: The amount associated with this billing item.
      example: 20.99
      readOnly: true
      type: number
    bill-subs-api_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/bill-subs-api_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/bill-subs-api_result_info'
      type: object
    bill-subs-api_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/bill-subs-api_messages'
        messages:
          $ref: '#/components/schemas/bill-subs-api_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    bill-subs-api_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/bill-subs-api_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/bill-subs-api_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    bill-subs-api_api-response-single:
      allOf:
        - $ref: '#/components/schemas/bill-subs-api_api-response-common'
        - properties:
            result:
              anyOf:
                - nullable: true
                  type: object
                - nullable: true
                  type: string
      type: object
    bill-subs-api_available-rate-plan:
      properties:
        can_subscribe:
          $ref: '#/components/schemas/bill-subs-api_can_subscribe'
        currency:
          $ref: '#/components/schemas/bill-subs-api_currency'
        externally_managed:
          $ref: '#/components/schemas/bill-subs-api_externally_managed'
        frequency:
          $ref: '#/components/schemas/bill-subs-api_schemas-frequency'
        id:
          $ref: '#/components/schemas/bill-subs-api_identifier'
        is_subscribed:
          $ref: '#/components/schemas/bill-subs-api_is_subscribed'
        legacy_discount:
          $ref: '#/components/schemas/bill-subs-api_legacy_discount'
        legacy_id:
          $ref: '#/components/schemas/bill-subs-api_legacy_id'
        name:
          $ref: '#/components/schemas/bill-subs-api_schemas-name'
        price:
          $ref: '#/components/schemas/bill-subs-api_schemas-price'
      type: object
    bill-subs-api_billing-history:
      properties:
        action:
          $ref: '#/components/schemas/bill-subs-api_action'
        amount:
          $ref: '#/components/schemas/bill-subs-api_amount'
        currency:
          $ref: '#/components/schemas/bill-subs-api_currency'
        description:
          $ref: '#/components/schemas/bill-subs-api_description'
        id:
          $ref: '#/components/schemas/bill-subs-api_components-schemas-identifier'
        occurred_at:
          $ref: '#/components/schemas/bill-subs-api_occurred_at'
        type:
          $ref: '#/components/schemas/bill-subs-api_type'
        zone:
          $ref: '#/components/schemas/bill-subs-api_schemas-zone'
      required:
        - id
        - type
        - action
        - description
        - occurred_at
        - amount
        - currency
        - zone
      type: object
    bill-subs-api_billing_history_collection:
      allOf:
        - $ref: '#/components/schemas/bill-subs-api_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/bill-subs-api_billing-history'
              type: array
    bill-subs-api_billing_response_single:
      allOf:
        - $ref: '#/components/schemas/bill-subs-api_api-response-single'
        - properties:
            result:
              properties:
                account_type:
                  example: type
                  type: string
                address:
                  example: 123 Main Street
                  type: string
                address2:
                  example: Apt 1
                  type: string
                balance:
                  example: 0
                  type: string
                card_expiry_month:
                  example: 12
                  type: integer
                card_expiry_year:
                  example: 2099
                  type: integer
                card_number:
                  example: 4.242424242424242e+15
                  type: string
                city:
                  example: Anytown
                  type: string
                company:
                  example: Company
                  type: string
                country:
                  example: Anycountry
                  type: string
                created_on:
                  example: "2014-03-01T12:21:59.3456Z"
                  format: date-time
                  type: string
                device_data:
                  example: sample_data
                  type: string
                edited_on:
                  example: "2014-03-01T12:21:59.3456Z"
                  format: date-time
                  type: string
                enterprise_billing_email:
                  example: johndoe@gmail.com
                  type: string
                enterprise_primary_email:
                  example: johndoe@gmail.com
                  type: string
                first_name:
                  example: John
                  type: string
                id:
                  $ref: '#/components/schemas/bill-subs-api_components-schemas-identifier'
                is_partner:
                  example: false
                  type: boolean
                last_name:
                  example: Doe
                  type: string
                next_bill_date:
                  example: "2014-03-01T12:21:59.3456Z"
                  format: date-time
                  type: string
                payment_address:
                  example: 123 Main Street
                  type: string
                payment_address2:
                  example: Apt 1
                  type: string
                payment_city:
                  example: Anytown
                  type: string
                payment_country:
                  example: Anycountry
                  type: string
                payment_email:
                  example: johndoe@gmail.com
                  type: string
                payment_first_name:
                  example: John
                  type: string
                payment_gateway:
                  example: gateway
                  type: string
                payment_last_name:
                  example: Doe
                  type: string
                payment_nonce:
                  example: abc123
                  type: string
                payment_state:
                  example: state
                  type: string
                payment_zipcode:
                  example: 12345
                  type: string
                primary_email:
                  example: johndoe@gmail.com
                  type: string
                state:
                  example: AnyState
                  type: string
                tax_id_type:
                  example: type
                  type: string
                telephone:
                  example: 1.234567899e+09
                  type: string
                use_legacy:
                  example: false
                  type: boolean
                validation_code:
                  example: 1111
                  type: string
                vat:
                  example: GB123456789
                  type: string
                zipcode:
                  example: 12345
                  type: string
              type: object
          type: object
    bill-subs-api_can_subscribe:
      default: false
      description: Indicates whether you can subscribe to this plan.
      example: true
      type: boolean
    bill-subs-api_component-value:
      properties:
        default:
          $ref: '#/components/schemas/bill-subs-api_default'
        name:
          $ref: '#/components/schemas/bill-subs-api_components-schemas-name'
        unit_price:
          $ref: '#/components/schemas/bill-subs-api_unit_price'
      type: object
    bill-subs-api_component_value:
      description: A component value for a subscription.
      properties:
        default:
          description: The default amount assigned.
          example: 5
          type: number
        name:
          description: The name of the component value.
          example: page_rules
          type: string
        price:
          description: The unit price for the component value.
          example: 5
          type: number
        value:
          description: The amount of the component value assigned.
          example: 20
          type: number
      type: object
    bill-subs-api_component_values:
      description: The list of add-ons subscribed to.
      items:
        $ref: '#/components/schemas/bill-subs-api_component_value'
      type: array
    bill-subs-api_components-schemas-identifier:
      description: Billing item identifier tag.
      example: b69a9f3492637782896352daae219e7d
      maxLength: 32
      readOnly: true
      type: string
    bill-subs-api_components-schemas-name:
      description: The unique component.
      enum:
        - zones
        - page_rules
        - dedicated_certificates
        - dedicated_certificates_custom
      example: page_rules
    bill-subs-api_currency:
      description: The monetary unit in which pricing information is displayed.
      example: USD
      readOnly: true
      type: string
    bill-subs-api_current_period_end:
      description: The end of the current period and also when the next billing is due.
      example: "2014-03-31T12:20:00Z"
      format: date-time
      readOnly: true
      type: string
    bill-subs-api_current_period_start:
      description: When the current billing period started. May match initial_period_start if this is the first period.
      example: "2014-05-11T12:20:00Z"
      format: date-time
      readOnly: true
      type: string
    bill-subs-api_default:
      description: The default amount allocated.
      example: 5
      type: number
    bill-subs-api_description:
      description: The billing item description.
      example: The billing item description
      maxLength: 255
      readOnly: true
      type: string
    bill-subs-api_duration:
      description: The duration of the plan subscription.
      example: 1
      type: number
    bill-subs-api_externally_managed:
      default: false
      description: Indicates whether this plan is managed externally.
      example: false
      type: boolean
    bill-subs-api_frequency:
      description: How often the subscription is renewed automatically.
      enum:
        - weekly
        - monthly
        - quarterly
        - yearly
      example: monthly
      type: string
    bill-subs-api_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    bill-subs-api_install_id:
      description: app install id.
      type: string
    bill-subs-api_is_subscribed:
      default: false
      description: Indicates whether you are currently subscribed to this plan.
      example: false
      type: boolean
    bill-subs-api_legacy_discount:
      default: false
      description: Indicates whether this plan has a legacy discount applied.
      example: false
      type: boolean
    bill-subs-api_legacy_id:
      description: The legacy identifier for this rate plan, if any.
      example: free
      readOnly: true
      type: string
    bill-subs-api_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    bill-subs-api_name:
      description: The domain name
      example: example.com
      maxLength: 253
      pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$
      readOnly: true
      type: string
    bill-subs-api_occurred_at:
      description: When the billing item was created.
      example: "2014-03-01T12:21:59.3456Z"
      format: date-time
      readOnly: true
      type: string
    bill-subs-api_plan_response_collection:
      allOf:
        - $ref: '#/components/schemas/bill-subs-api_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/bill-subs-api_schemas-rate-plan'
              type: array
          type: object
    bill-subs-api_price:
      description: The price of the subscription that will be billed, in US dollars.
      example: 20
      readOnly: true
      type: number
    bill-subs-api_rate-plan:
      properties:
        components:
          $ref: '#/components/schemas/bill-subs-api_schemas-component_values'
        currency:
          $ref: '#/components/schemas/bill-subs-api_currency'
        duration:
          $ref: '#/components/schemas/bill-subs-api_duration'
        frequency:
          $ref: '#/components/schemas/bill-subs-api_schemas-frequency'
        id:
          $ref: '#/components/schemas/bill-subs-api_rate-plan_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/bill-subs-api_schemas-name'
      type: object
    bill-subs-api_rate-plan_components-schemas-identifier:
      description: Plan identifier tag.
      example: free
      readOnly: true
      type: string
    bill-subs-api_rate_plan:
      description: The rate plan applied to the subscription.
      properties:
        currency:
          description: The currency applied to the rate plan subscription.
          example: USD
          type: string
        externally_managed:
          description: Whether this rate plan is managed externally from Cloudflare.
          example: false
          type: boolean
        id:
          description: The ID of the rate plan.
          example: free
          type: string
        is_contract:
          description: Whether a rate plan is enterprise-based (or newly adopted term contract).
          example: false
          type: boolean
        public_name:
          description: The full name of the rate plan.
          example: Business Plan
          type: string
        scope:
          description: The scope that this rate plan applies to.
          example: zone
          type: string
        sets:
          description: The list of sets this rate plan applies to.
          items:
            type: string
          type: array
      type: object
    bill-subs-api_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    bill-subs-api_schemas-component_values:
      description: Array of available components values for the plan.
      items:
        $ref: '#/components/schemas/bill-subs-api_component-value'
      type: array
    bill-subs-api_schemas-frequency:
      description: The frequency at which you will be billed for this plan.
      enum:
        - weekly
        - monthly
        - quarterly
        - yearly
      example: monthly
      readOnly: true
      type: string
    bill-subs-api_schemas-identifier:
      description: Subscription identifier tag.
      example: 506e3185e9c882d175a2d0cb0093d9f2
      maxLength: 32
      readOnly: true
      type: string
    bill-subs-api_schemas-name:
      description: The plan name.
      example: Free Plan
      maxLength: 80
      readOnly: true
      type: string
    bill-subs-api_schemas-price:
      description: The amount you will be billed for this plan.
      example: 0
      type: number
    bill-subs-api_schemas-rate-plan:
      allOf:
        - $ref: '#/components/schemas/bill-subs-api_rate-plan'
      type: object
    bill-subs-api_schemas-zone:
      properties:
        name:
          readOnly: true
          type: string
      type: object
    bill-subs-api_state:
      description: The state that the subscription is in.
      enum:
        - Trial
        - Provisioned
        - Paid
        - AwaitingPayment
        - Cancelled
        - Failed
        - Expired
      example: Paid
      readOnly: true
      type: string
    bill-subs-api_subscription:
      allOf:
        - $ref: '#/components/schemas/bill-subs-api_subscription-v2'
      type: object
    bill-subs-api_subscription-v2:
      properties:
        app:
          properties:
            install_id:
              $ref: '#/components/schemas/bill-subs-api_install_id'
        component_values:
          $ref: '#/components/schemas/bill-subs-api_component_values'
        currency:
          $ref: '#/components/schemas/bill-subs-api_currency'
        current_period_end:
          $ref: '#/components/schemas/bill-subs-api_current_period_end'
        current_period_start:
          $ref: '#/components/schemas/bill-subs-api_current_period_start'
        frequency:
          $ref: '#/components/schemas/bill-subs-api_frequency'
        id:
          $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
        price:
          $ref: '#/components/schemas/bill-subs-api_price'
        rate_plan:
          $ref: '#/components/schemas/bill-subs-api_rate_plan'
        state:
          $ref: '#/components/schemas/bill-subs-api_state'
        zone:
          $ref: '#/components/schemas/bill-subs-api_zone'
      type: object
    bill-subs-api_type:
      description: The billing item type.
      example: charge
      maxLength: 30
      readOnly: true
      type: string
    bill-subs-api_unit_price:
      description: The unit price of the addon.
      example: 1
      readOnly: true
      type: number
    bill-subs-api_user_subscription_response_collection:
      allOf:
        - $ref: '#/components/schemas/bill-subs-api_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/bill-subs-api_subscription'
              type: array
          type: object
    bill-subs-api_user_subscription_response_single:
      allOf:
        - $ref: '#/components/schemas/bill-subs-api_api-response-single'
        - properties:
            result:
              type: object
          type: object
    bill-subs-api_zone:
      description: A simple zone object. May have null properties if not a zone subscription.
      properties:
        id:
          $ref: '#/components/schemas/bill-subs-api_identifier'
        name:
          $ref: '#/components/schemas/bill-subs-api_name'
      type: object
    bill-subs-api_zone_subscription_response_single:
      allOf:
        - $ref: '#/components/schemas/bill-subs-api_api-response-single'
        - properties:
            result:
              type: object
          type: object
    bot-management_ai_bots_protection:
      description: Enable rule to block AI Scrapers and Crawlers.
      enum:
        - block
        - disabled
      example: block
      type: string
    bot-management_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/bot-management_messages'
        messages:
          $ref: '#/components/schemas/bot-management_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    bot-management_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/bot-management_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/bot-management_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    bot-management_api-response-single:
      allOf:
        - $ref: '#/components/schemas/bot-management_api-response-common'
      type: object
    bot-management_auto_update_model:
      description: Automatically update to the newest bot detection models created by Cloudflare as they are released. [Learn more.](https://developers.cloudflare.com/bots/reference/machine-learning-models#model-versions-and-release-notes)
      example: true
      type: boolean
    bot-management_base_config:
      allOf:
        - properties:
            ai_bots_protection:
              $ref: '#/components/schemas/bot-management_ai_bots_protection'
            enable_js:
              $ref: '#/components/schemas/bot-management_enable_js'
            using_latest_model:
              $ref: '#/components/schemas/bot-management_using_latest_model'
      title: Shared Config
    bot-management_bm_subscription_config:
      allOf:
        - $ref: '#/components/schemas/bot-management_base_config'
        - properties:
            auto_update_model:
              $ref: '#/components/schemas/bot-management_auto_update_model'
            suppress_session_score:
              $ref: '#/components/schemas/bot-management_suppress_session_score'
      title: BM Enterprise Subscription
    bot-management_bot_fight_mode_config:
      allOf:
        - $ref: '#/components/schemas/bot-management_base_config'
        - properties:
            fight_mode:
              $ref: '#/components/schemas/bot-management_fight_mode'
      title: Bot Fight Mode
    bot-management_bot_management_response_body:
      allOf:
        - $ref: '#/components/schemas/bot-management_api-response-single'
        - properties:
            result:
              oneOf:
                - $ref: '#/components/schemas/bot-management_bot_fight_mode_config'
                - $ref: '#/components/schemas/bot-management_sbfm_definitely_config'
                - $ref: '#/components/schemas/bot-management_sbfm_likely_config'
                - $ref: '#/components/schemas/bot-management_bm_subscription_config'
          type: object
    bot-management_config_single:
      oneOf:
        - $ref: '#/components/schemas/bot-management_bot_fight_mode_config'
        - $ref: '#/components/schemas/bot-management_sbfm_definitely_config'
        - $ref: '#/components/schemas/bot-management_sbfm_likely_config'
        - $ref: '#/components/schemas/bot-management_bm_subscription_config'
      type: object
    bot-management_enable_js:
      description: Use lightweight, invisible JavaScript detections to improve Bot Management. [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/).
      example: true
      type: boolean
    bot-management_fight_mode:
      description: Whether to enable Bot Fight Mode.
      example: true
      type: boolean
    bot-management_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    bot-management_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    bot-management_optimize_wordpress:
      description: Whether to optimize Super Bot Fight Mode protections for Wordpress.
      example: true
      type: boolean
    bot-management_sbfm_definitely_automated:
      description: Super Bot Fight Mode (SBFM) action to take on definitely automated requests.
      enum:
        - allow
        - block
        - managed_challenge
      example: allow
      type: string
    bot-management_sbfm_definitely_config:
      allOf:
        - $ref: '#/components/schemas/bot-management_base_config'
        - properties:
            optimize_wordpress:
              $ref: '#/components/schemas/bot-management_optimize_wordpress'
            sbfm_definitely_automated:
              $ref: '#/components/schemas/bot-management_sbfm_definitely_automated'
            sbfm_static_resource_protection:
              $ref: '#/components/schemas/bot-management_sbfm_static_resource_protection'
            sbfm_verified_bots:
              $ref: '#/components/schemas/bot-management_sbfm_verified_bots'
      title: SBFM Pro Plan
    bot-management_sbfm_likely_automated:
      description: Super Bot Fight Mode (SBFM) action to take on likely automated requests.
      enum:
        - allow
        - block
        - managed_challenge
      example: allow
      type: string
    bot-management_sbfm_likely_config:
      allOf:
        - $ref: '#/components/schemas/bot-management_sbfm_definitely_config'
        - properties:
            sbfm_likely_automated:
              $ref: '#/components/schemas/bot-management_sbfm_likely_automated'
      title: SBFM Biz Plan
    bot-management_sbfm_static_resource_protection:
      description: |
        Super Bot Fight Mode (SBFM) to enable static resource protection.
        Enable if static resources on your application need bot protection.
        Note: Static resource protection can also result in legitimate traffic being blocked.
      example: true
      type: boolean
    bot-management_sbfm_verified_bots:
      description: Super Bot Fight Mode (SBFM) action to take on verified bots requests.
      enum:
        - allow
        - block
      example: allow
      type: string
    bot-management_suppress_session_score:
      default: false
      description: Whether to disable tracking the highest bot score for a session in the Bot Management cookie.
      example: false
      type: boolean
    bot-management_using_latest_model:
      description: |
        A read-only field that indicates whether the zone currently is running the latest ML model.
      example: true
      readOnly: true
      type: boolean
    cache-purge_Everything:
      properties:
        purge_everything:
          description: For more information, please refer to [purge everything documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-everything/).
          example: true
          type: boolean
      title: Purge everything
      type: object
    cache-purge_FlexPurgeByHostnames:
      properties:
        hosts:
          description: For more information purging by hostnames, please refer to [purge by hostname documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-hostname/).
          example:
            - www.example.com
            - images.example.com
          items:
            type: string
          type: array
      title: Purge by hostnames
      type: object
    cache-purge_FlexPurgeByPrefixes:
      properties:
        prefixes:
          description: For more information on purging by prefixes, please refer to [purge by prefix documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge_by_prefix/).
          example:
            - www.example.com/foo
            - images.example.com/bar/baz
          items:
            type: string
          type: array
      title: Purge by prefixes
      type: object
    cache-purge_FlexPurgeByTags:
      properties:
        tags:
          description: For more information on cache tags and purging by tags, please refer to [purge by cache-tags documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/#purge-cache-by-cache-tags-enterprise-only).
          example:
            - a-cache-tag
            - another-cache-tag
          items:
            type: string
          type: array
      title: Purge by tags
      type: object
    cache-purge_SingleFile:
      properties:
        files:
          description: For more information on purging files, please refer to [purge by single-file documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
          example:
            - http://www.example.com/css/styles.css
            - http://www.example.com/js/index.js
          items:
            type: string
          type: array
      title: Purge files
      type: object
    cache-purge_SingleFileWithUrlAndHeaders:
      properties:
        files:
          description: For more information on purging files with URL and headers, please refer to [purge by single-file documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
          example:
            - headers:
                Accept-Language: zh-CN
                CF-Device-Type: desktop
                CF-IPCountry: US
              url: http://www.example.com/cat_picture.jpg
            - headers:
                Accept-Language: en-US
                CF-Device-Type: mobile
                CF-IPCountry: EU
              url: http://www.example.com/dog_picture.jpg
          items:
            properties:
              headers:
                example: <HTTP header object>
                type: object
              url:
                example: http://www.example.com/cat_picture.jpg
                type: string
            type: object
          type: array
      title: Purge files with URL and headers
      type: object
    cache-purge_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/cache-purge_messages'
        messages:
          $ref: '#/components/schemas/cache-purge_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    cache-purge_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/cache-purge_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/cache-purge_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    cache-purge_api-response-single-id:
      allOf:
        - $ref: '#/components/schemas/cache-purge_api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                id:
                  $ref: '#/components/schemas/cache-purge_schemas-identifier'
              required:
                - id
              type: object
      type: object
    cache-purge_identifier:
      type: string
    cache-purge_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    cache-purge_schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    cache_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/cache_messages'
        messages:
          $ref: '#/components/schemas/cache_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    cache_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/cache_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/cache_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    cache_api-response-single:
      allOf:
        - $ref: '#/components/schemas/cache_api-response-common'
      type: object
    cache_automatic_upgrader_response:
      allOf:
        - $ref: '#/components/schemas/cache_api-response-single'
        - properties:
            result:
              oneOf:
                - $ref: '#/components/schemas/cache_response_base'
    cache_base:
      properties:
        id:
          description: Identifier of the zone setting.
          type: string
        modified_on:
          description: last time this setting was modified.
          example: "2014-01-01T05:20:00.12345Z"
          format: date-time
          nullable: true
          readOnly: true
          type: string
      required:
        - id
        - modified_on
    cache_cache_reserve:
      allOf:
        - $ref: '#/components/schemas/cache_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - cache_reserve
              example: 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.'
      title: Cache Reserve
    cache_cache_reserve_clear:
      allOf:
        - $ref: '#/components/schemas/cache_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - cache_reserve_clear
              example: cache_reserve_clear
      description: You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.
      title: Cache Reserve Clear
    cache_cache_reserve_clear_end_ts:
      description: The time that the latest Cache Reserve Clear operation completed.
      example: "2023-10-02T12:00:00.12345Z"
      format: date-time
      type: string
    cache_cache_reserve_clear_post_request_body:
      description: The POST request body does not carry any information.
      example: '{}'
      type: string
    cache_cache_reserve_clear_response_value:
      properties:
        result:
          allOf:
            - $ref: '#/components/schemas/cache_cache_reserve_clear'
            - properties:
                end_ts:
                  $ref: '#/components/schemas/cache_cache_reserve_clear_end_ts'
                start_ts:
                  $ref: '#/components/schemas/cache_cache_reserve_clear_start_ts'
                state:
                  $ref: '#/components/schemas/cache_cache_reserve_clear_state'
              required:
                - state
                - start_ts
    cache_cache_reserve_clear_start_ts:
      description: The time that the latest Cache Reserve Clear operation started.
      example: "2023-10-02T10:00:00.12345Z"
      format: date-time
      type: string
    cache_cache_reserve_clear_state:
      description: The current state of the Cache Reserve Clear operation.
      enum:
        - In-progress
        - Completed
      example: In-progress
      type: string
    cache_cache_reserve_response_value:
      properties:
        result:
          allOf:
            - $ref: '#/components/schemas/cache_cache_reserve'
            - properties:
                value:
                  $ref: '#/components/schemas/cache_cache_reserve_value'
              required:
                - value
    cache_cache_reserve_value:
      default: "off"
      description: Value of the Cache Reserve zone setting.
      enum:
        - "on"
        - "off"
      type: string
    cache_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    cache_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    cache_origin_max_http_version:
      allOf:
        - $ref: '#/components/schemas/cache_base'
        - properties:
            id:
              description: Value of the zone setting.
              enum:
                - origin_max_http_version
              example: origin_max_http_version
      description: Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except ENT where it is "1"
      title: Origin Max HTTP Version
    cache_origin_max_http_version_response_value:
      properties:
        result:
          allOf:
            - $ref: '#/components/schemas/cache_origin_max_http_version'
            - properties:
                value:
                  $ref: '#/components/schemas/cache_origin_max_http_version_value'
              required:
                - value
    cache_origin_max_http_version_value:
      description: Value of the Origin Max HTTP Version Setting.
      enum:
        - "2"
        - "1"
      type: string
    cache_origin_post_quantum_encryption:
      allOf:
        - $ref: '#/components/schemas/cache_base'
        - properties:
            id:
              description: Value of the zone setting.
              enum:
                - origin_pqe
              example: origin_pqe
      description: Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised
      title: Origin Post-Quantum Encryption
    cache_origin_post_quantum_encryption_response_value:
      properties:
        result:
          allOf:
            - $ref: '#/components/schemas/cache_origin_post_quantum_encryption'
            - properties:
                value:
                  $ref: '#/components/schemas/cache_origin_post_quantum_encryption'
              required:
                - value
    cache_origin_post_quantum_encryption_value:
      default: supported
      description: Value of the Origin Post Quantum Encryption Setting.
      enum:
        - preferred
        - supported
        - "off"
      type: string
    cache_patch:
      description: Update enablement of Tiered Caching
      properties:
        value:
          $ref: '#/components/schemas/cache_value'
      required:
        - value
      type: object
    cache_regional_tiered_cache:
      allOf:
        - $ref: '#/components/schemas/cache_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - tc_regional
              example: tc_regional
      description: Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.
      title: Regional Tiered Cache
    cache_regional_tiered_cache_response_value:
      properties:
        result:
          allOf:
            - $ref: '#/components/schemas/cache_regional_tiered_cache'
            - properties:
                value:
                  $ref: '#/components/schemas/cache_regional_tiered_cache'
              required:
                - value
    cache_regional_tiered_cache_value:
      default: "off"
      description: Value of the Regional Tiered Cache zone setting.
      enum:
        - "on"
        - "off"
      type: string
    cache_response_base:
      properties:
        editable:
          description: Whether this setting can be updated or not.
          readOnly: true
          type: boolean
        id:
          example: ssl_tls_configuration_mode
          readOnly: true
          type: string
        modified_on:
          description: Last time this setting was modified.
          example: "2014-01-01T05:20:00.12345Z"
          format: date-time
          readOnly: true
          type: string
        next_scheduled_scan:
          description: next time this zone will be scanned by the Automatic SSL/TLS.
          example: "2014-01-01T05:20:00.12345Z"
          format: date-time
          nullable: true
          readOnly: true
          type: string
        value:
          description: Current setting of the automatic SSL/TLS.
          enum:
            - auto
            - custom
          example: auto
          readOnly: true
          type: string
      required:
        - id
        - modified_on
        - value
        - editable
      type: object
    cache_response_single:
      allOf:
        - $ref: '#/components/schemas/cache_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/cache_result-object'
          type: object
    cache_result-object:
      properties:
        editable:
          description: Whether the setting is editable
          type: boolean
        id:
          description: The identifier of the caching setting
          type: string
        modified_on:
          description: The time when the setting was last modified
          format: date-time
          type: string
        value:
          description: The status of the feature being on / off
          enum:
            - "on"
            - "off"
          type: string
      required:
        - id
        - value
        - modified_on
        - editable
      type: object
    cache_schemas_patch:
      description: Update enablement of Automatic SSL/TLS.
      properties:
        value:
          $ref: '#/components/schemas/cache_schemas_value'
      required:
        - value
      type: object
    cache_schemas_value:
      description: Controls enablement of Automatic SSL/TLS.
      enum:
        - auto
        - custom
      example: auto
      type: string
    cache_smart_tiered_cache_patch:
      description: Update enablement of Smart Tiered Cache
      properties:
        value:
          description: Enable or disable the Smart Tiered Cache
          enum:
            - "on"
            - "off"
          example: "on"
          type: string
      required:
        - value
      type: object
    cache_value:
      description: Enables Tiered Caching.
      enum:
        - "on"
        - "off"
      example: "on"
      type: string
    cache_variants:
      allOf:
        - $ref: '#/components/schemas/cache_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - variants
              example: variants
      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.'
      title: Variants Caching
    cache_variants_response_value:
      properties:
        result:
          allOf:
            - $ref: '#/components/schemas/cache_variants'
            - properties:
                value:
                  $ref: '#/components/schemas/cache_variants_value'
              required:
                - value
    cache_variants_value:
      description: Value of the zone setting.
      properties:
        avif:
          description: List of strings with the MIME types of all the variants that should be served for avif.
          example:
            - image/webp
            - image/jpeg
          items:
            type: string
          type: array
          uniqueItems: true
        bmp:
          description: List of strings with the MIME types of all the variants that should be served for bmp.
          example:
            - image/webp
            - image/jpeg
          items:
            type: string
          type: array
          uniqueItems: true
        gif:
          description: List of strings with the MIME types of all the variants that should be served for gif.
          example:
            - image/webp
            - image/jpeg
          items:
            type: string
          type: array
          uniqueItems: true
        jp2:
          description: List of strings with the MIME types of all the variants that should be served for jp2.
          example:
            - image/webp
            - image/avif
          items:
            type: string
          type: array
          uniqueItems: true
        jpeg:
          description: List of strings with the MIME types of all the variants that should be served for jpeg.
          example:
            - image/webp
            - image/avif
          items:
            type: string
          type: array
          uniqueItems: true
        jpg:
          description: List of strings with the MIME types of all the variants that should be served for jpg.
          example:
            - image/webp
            - image/avif
          items:
            type: string
          type: array
          uniqueItems: true
        jpg2:
          description: List of strings with the MIME types of all the variants that should be served for jpg2.
          example:
            - image/webp
            - image/avif
          items:
            type: string
          type: array
          uniqueItems: true
        png:
          description: List of strings with the MIME types of all the variants that should be served for png.
          example:
            - image/webp
            - image/avif
          items:
            type: string
          type: array
          uniqueItems: true
        tif:
          description: List of strings with the MIME types of all the variants that should be served for tif.
          example:
            - image/webp
            - image/avif
          items:
            type: string
          type: array
          uniqueItems: true
        tiff:
          description: List of strings with the MIME types of all the variants that should be served for tiff.
          example:
            - image/webp
            - image/avif
          items:
            type: string
          type: array
          uniqueItems: true
        webp:
          description: List of strings with the MIME types of all the variants that should be served for webp.
          example:
            - image/jpeg
            - image/avif
          items:
            type: string
          type: array
          uniqueItems: true
      type: object
    cache_zone_cache_settings_response_single:
      allOf:
        - $ref: '#/components/schemas/cache_api-response-single'
        - properties:
            result:
              type: object
    cache_zone_identifier:
      allOf:
        - description: Zone identifier.
        - readOnly: true
        - $ref: '#/components/schemas/cache_identifier'
    calls_account_identifier:
      description: The account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    calls_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/calls_messages'
        messages:
          $ref: '#/components/schemas/calls_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    calls_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/calls_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/calls_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    calls_api-response-single:
      allOf:
        - $ref: '#/components/schemas/calls_api-response-common'
      type: object
    calls_app:
      properties:
        created:
          $ref: '#/components/schemas/calls_created'
        modified:
          $ref: '#/components/schemas/calls_modified'
        name:
          $ref: '#/components/schemas/calls_name'
        uid:
          $ref: '#/components/schemas/calls_identifier'
      type: object
    calls_app_editable_fields:
      properties:
        name:
          $ref: '#/components/schemas/calls_name'
      type: object
    calls_app_response_collection:
      allOf:
        - $ref: '#/components/schemas/calls_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/calls_turn_key'
              type: array
    calls_app_response_single:
      allOf:
        - $ref: '#/components/schemas/calls_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/calls_app'
    calls_app_response_single_with_secret:
      allOf:
        - $ref: '#/components/schemas/calls_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/calls_app_with_secret'
    calls_app_with_secret:
      properties:
        created:
          $ref: '#/components/schemas/calls_created'
        modified:
          $ref: '#/components/schemas/calls_modified'
        name:
          $ref: '#/components/schemas/calls_name'
        secret:
          $ref: '#/components/schemas/calls_secret'
        uid:
          $ref: '#/components/schemas/calls_identifier'
      type: object
    calls_created:
      description: The date and time the item was created.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    calls_identifier:
      description: A Cloudflare-generated unique identifier for a item.
      example: 2a95132c15732412d22c1476fa83f27a
      maxLength: 32
      minLength: 32
      type: string
    calls_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    calls_modified:
      description: The date and time the item was last modified.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    calls_name:
      default: ""
      description: A short description of Calls app, not shown to end users.
      example: production-realtime-app
      type: string
    calls_secret:
      description: Bearer token
      example: 66bcf64aa8907b9f9d90ac17746a77ce394c393b92b3916633dc02846e608ad4
      maxLength: 64
      minLength: 64
      type: string
    calls_turn_key:
      description: Bearer token
      example: 66bcf64aa8907b9f9d90ac17746a77ce394c393b92b3916633dc02846e608ad4
      maxLength: 64
      minLength: 64
      type: string
    calls_turn_key_collection:
      allOf:
        - $ref: '#/components/schemas/calls_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/calls_turn_key'
              type: array
    calls_turn_key_editable_fields:
      properties:
        name:
          $ref: '#/components/schemas/calls_turn_key_name'
      type: object
    calls_turn_key_name:
      default: ""
      description: A short description of a TURN key, not shown to end users.
      example: my-turn-key
      type: string
    calls_turn_key_response_collection:
      allOf:
        - $ref: '#/components/schemas/calls_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/calls_turn_key'
              type: array
    calls_turn_key_response_single:
      allOf:
        - $ref: '#/components/schemas/calls_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/calls_turn_key'
    calls_turn_key_single_with_secret:
      allOf:
        - $ref: '#/components/schemas/calls_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/calls_turn_key_with_key'
    calls_turn_key_with_key:
      properties:
        created:
          $ref: '#/components/schemas/calls_created'
        key:
          $ref: '#/components/schemas/calls_turn_key'
        modified:
          $ref: '#/components/schemas/calls_modified'
        name:
          $ref: '#/components/schemas/calls_turn_key_name'
        uid:
          $ref: '#/components/schemas/calls_identifier'
      type: object
    calls_turn_token:
      properties:
        created:
          $ref: '#/components/schemas/calls_created'
        modified:
          $ref: '#/components/schemas/calls_modified'
        name:
          $ref: '#/components/schemas/calls_name'
        uid:
          $ref: '#/components/schemas/calls_identifier'
      type: object
    cloud-connector_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/cloud-connector_messages'
        messages:
          $ref: '#/components/schemas/cloud-connector_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    cloud-connector_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/cloud-connector_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/cloud-connector_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    cloud-connector_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    cloud-connector_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    cloud-connector_provider:
      description: Cloud Provider type
      enum:
        - aws_s3
        - r2
        - gcp_storage
        - azure_storage
      example: aws_s3
      type: string
    cloud-connector_rules:
      description: List of Cloud Connector rules
      items:
        properties:
          description:
            example: Rule description
            type: string
          enabled:
            example: true
            type: boolean
          expression:
            example: http.cookie eq "a=b"
            type: string
          id:
            example: 95c365e17e1b46599cd99e5b231fac4e
            type: string
          parameters:
            description: Parameters of Cloud Connector Rule
            properties:
              host:
                description: Host to perform Cloud Connection to
                example: examplebucket.s3.eu-north-1.amazonaws.com
                type: string
            type: object
          provider:
            $ref: '#/components/schemas/cloud-connector_provider'
        type: object
      type: array
    cloud-connector_zone_identifier:
      $ref: '#/components/schemas/cloud-connector_identifier'
    cloudforce-one_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/cloudforce-one_messages'
        messages:
          $ref: '#/components/schemas/cloudforce-one_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    cloudforce-one_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    cloudforce-one_api-response-single:
      allOf:
        - $ref: '#/components/schemas/cloudforce-one_api-response-common'
      type: object
    cloudforce-one_asset-content:
      description: Asset file to upload
      example: '@/Users/me/test.doc'
      type: string
    cloudforce-one_domain_name:
      example: cloudflare.com
      type: string
    cloudforce-one_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    cloudforce-one_labels:
      description: List of labels
      example:
        - DoS
        - CVE
      items:
        type: string
      title: Labels
      type: array
    cloudforce-one_message-content:
      description: Content of message
      example: Can you elaborate on the type of DoS that occurred?
      type: string
    cloudforce-one_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    cloudforce-one_priority:
      enum:
        - routine
        - high
        - urgent
      title: Request Priority
      type: string
    cloudforce-one_priority-edit:
      properties:
        labels:
          $ref: '#/components/schemas/cloudforce-one_labels'
        priority:
          description: Priority
          example: 1
          type: integer
        requirement:
          description: Requirement
          example: DoS attacks carried out by CVEs
          type: string
        tlp:
          $ref: '#/components/schemas/cloudforce-one_tlp'
      required:
        - labels
        - priority
        - requirement
        - tlp
      title: Priority Editable Attributes
      type: object
    cloudforce-one_priority-item:
      properties:
        created:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Priority creation time
        id:
          $ref: '#/components/schemas/cloudforce-one_uuid'
        labels:
          $ref: '#/components/schemas/cloudforce-one_labels'
        priority:
          description: Priority
          example: 1
          type: integer
        requirement:
          description: Requirement
          example: DoS attacks carried out by CVEs
          type: string
        tlp:
          $ref: '#/components/schemas/cloudforce-one_tlp'
        updated:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Priority last updated time
      required:
        - id
        - created
        - updated
        - labels
        - priority
        - requirement
        - tlp
      title: Priority Item
      type: object
    cloudforce-one_priority-list:
      properties:
        page:
          description: Page number of results
          type: integer
        per_page:
          description: Number of results per page
          example: 10
          type: integer
      required:
        - page
        - per_page
      title: Priority List Parameters
      type: object
    cloudforce-one_quota:
      properties:
        anniversary_date:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Anniversary date is when annual quota limit is refresh
            - example: "2022-01-01T00:00:00Z"
        quarter_anniversary_date:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Quater anniversary date is when quota limit is refreshed each quarter
            - example: "2022-04-01T00:00:00Z"
        quota:
          description: Tokens for the quarter
          example: 120
          type: integer
        remaining:
          description: Tokens remaining for the quarter
          example: 64
          type: integer
      title: Quota
      type: object
    cloudforce-one_request-asset-edit:
      properties:
        source:
          $ref: '#/components/schemas/cloudforce-one_asset-content'
      title: Request Asset Editable Attributes
      type: object
    cloudforce-one_request-asset-item:
      properties:
        created:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Asset creation time
            - example: "2022-01-01T00:00:00Z"
        description:
          description: Asset description
          example: example description
          type: string
        file_type:
          description: Asset file type
          example: png
          type: string
        id:
          description: Asset ID
          type: integer
        name:
          description: Asset name
          example: example.png
          type: string
      required:
        - id
        - name
      title: Request Asset Item
      type: object
    cloudforce-one_request-asset-list:
      properties:
        page:
          description: Page number of results
          type: integer
        per_page:
          description: Number of results per page
          example: 10
          type: integer
      required:
        - page
        - per_page
      title: Request Asset List Parameters
      type: object
    cloudforce-one_request-constants:
      properties:
        priority:
          example:
            - routine
            - high
            - urgent
          items:
            $ref: '#/components/schemas/cloudforce-one_priority'
          type: array
        status:
          example:
            - open
            - accepted
            - reported
            - approved
            - completed
            - declined
          items:
            $ref: '#/components/schemas/cloudforce-one_request-status'
          type: array
        tlp:
          example:
            - clear
            - green
            - amber
            - amber-strict
            - red
          items:
            $ref: '#/components/schemas/cloudforce-one_tlp'
          type: array
      title: Request Constants
      type: object
    cloudforce-one_request-content:
      description: Request content
      example: What regions were most effected by the recent DoS?
      type: string
    cloudforce-one_request-edit:
      properties:
        content:
          $ref: '#/components/schemas/cloudforce-one_request-content'
        priority:
          description: Priority for analyzing the request
          example: routine
          type: string
        request_type:
          $ref: '#/components/schemas/cloudforce-one_request-type'
        summary:
          $ref: '#/components/schemas/cloudforce-one_request-summary'
        tlp:
          $ref: '#/components/schemas/cloudforce-one_tlp'
      title: Request Editable Parameters
      type: object
    cloudforce-one_request-item:
      properties:
        completed:
          $ref: '#/components/schemas/cloudforce-one_time'
        content:
          $ref: '#/components/schemas/cloudforce-one_request-content'
        created:
          $ref: '#/components/schemas/cloudforce-one_time'
        id:
          $ref: '#/components/schemas/cloudforce-one_uuid'
        message_tokens:
          description: Tokens for the request messages
          example: 1
          type: integer
        priority:
          $ref: '#/components/schemas/cloudforce-one_time'
        readable_id:
          $ref: '#/components/schemas/cloudforce-one_request-readable-id'
        request:
          $ref: '#/components/schemas/cloudforce-one_request-type'
        status:
          $ref: '#/components/schemas/cloudforce-one_request-status'
        summary:
          $ref: '#/components/schemas/cloudforce-one_request-summary'
        tlp:
          $ref: '#/components/schemas/cloudforce-one_tlp'
        tokens:
          description: Tokens for the request
          example: 16
          type: integer
        updated:
          $ref: '#/components/schemas/cloudforce-one_time'
      required:
        - id
        - created
        - updated
        - content
        - priority
        - request
        - summary
        - tlp
      title: Request Item
      type: object
    cloudforce-one_request-list:
      properties:
        completed_after:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Retrieve requests completed after this time
            - example: "2022-01-01T00:00:00Z"
        completed_before:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Retrieve requests completed before this time
            - example: "2024-01-01T00:00:00Z"
        created_after:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Retrieve requests created after this time
            - example: "2022-01-01T00:00:00Z"
        created_before:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Retrieve requests created before this time
            - example: "2024-01-01T00:00:00Z"
        page:
          description: Page number of results
          type: integer
        per_page:
          description: Number of results per page
          example: 10
          type: integer
        request_type:
          $ref: '#/components/schemas/cloudforce-one_request-type'
        sort_by:
          description: Field to sort results by
          example: created
          type: string
        sort_order:
          description: Sort order (asc or desc)
          enum:
            - asc
            - desc
          type: string
        status:
          $ref: '#/components/schemas/cloudforce-one_request-status'
      required:
        - page
        - per_page
      title: Request List Parameters
      type: object
    cloudforce-one_request-list-item:
      properties:
        completed:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Request completion time
            - example: "2024-01-01T00:00:00Z"
        created:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Request creation time
            - example: "2022-04-01T00:00:00Z"
        id:
          $ref: '#/components/schemas/cloudforce-one_uuid'
        message_tokens:
          description: Tokens for the request messages
          example: 16
          type: integer
        priority:
          $ref: '#/components/schemas/cloudforce-one_priority'
        readable_id:
          $ref: '#/components/schemas/cloudforce-one_request-readable-id'
        request:
          $ref: '#/components/schemas/cloudforce-one_request-type'
        status:
          $ref: '#/components/schemas/cloudforce-one_request-status'
        summary:
          $ref: '#/components/schemas/cloudforce-one_request-summary'
        tlp:
          $ref: '#/components/schemas/cloudforce-one_tlp'
        tokens:
          description: Tokens for the request
          type: integer
        updated:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Request last updated time
            - example: "2022-04-01T00:00:00Z"
      required:
        - id
        - created
        - updated
        - priority
        - request
        - summary
        - tlp
      title: Request List Item
      type: object
    cloudforce-one_request-message-edit:
      properties:
        content:
          $ref: '#/components/schemas/cloudforce-one_message-content'
      title: Request Message Editable Attributes
      type: object
    cloudforce-one_request-message-item:
      properties:
        author:
          description: Author of message
          example: user@domain.com
          type: string
        content:
          $ref: '#/components/schemas/cloudforce-one_message-content'
        created:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Message creation time
            - example: "2022-01-01T00:00:00Z"
        id:
          description: Message ID
          type: integer
        is_follow_on_request:
          description: Whether the message is a follow-on request
          type: boolean
        updated:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Message last updated time
            - example: "2022-01-01T00:00:00Z"
      required:
        - id
        - updated
        - content
        - author
        - is_follow_on_request
      title: Request Message Item
      type: object
    cloudforce-one_request-message-list:
      properties:
        after:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Retrieve messages created after this time
            - example: "2022-01-01T00:00:00Z"
        before:
          allOf:
            - $ref: '#/components/schemas/cloudforce-one_time'
            - description: Retrieve messages created before this time
            - example: "2024-01-01T00:00:00Z"
        page:
          description: Page number of results
          type: integer
        per_page:
          description: Number of results per page
          example: 10
          type: integer
        sort_by:
          description: Field to sort results by
          example: created
          type: string
        sort_order:
          description: Sort order (asc or desc)
          enum:
            - asc
            - desc
          type: string
      required:
        - page
        - per_page
      title: Request Message List Parameters
      type: object
    cloudforce-one_request-readable-id:
      description: Readable Request ID
      example: RFI-2022-000001
      title: Request Readable ID
      type: string
    cloudforce-one_request-status:
      description: Request Status
      enum:
        - open
        - accepted
        - reported
        - approved
        - completed
        - declined
      title: Request Status
      type: string
    cloudforce-one_request-summary:
      description: Brief description of the request
      example: DoS attack
      type: string
    cloudforce-one_request-type:
      description: Requested information from request
      example: Victomology
      type: string
    cloudforce-one_request-types:
      example:
        - Indicators of Compromise
        - Victomology
      items:
        description: Request Types
        type: string
      title: Request Types
      type: array
    cloudforce-one_schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/cloudforce-one_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/cloudforce-one_whois'
    cloudforce-one_time:
      example: "2022-04-01T05:20:00Z"
      format: date-time
      type: string
    cloudforce-one_tlp:
      description: The CISA defined Traffic Light Protocol (TLP)
      enum:
        - clear
        - amber
        - amber-strict
        - green
        - red
      title: TLP
      type: string
    cloudforce-one_uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    cloudforce-one_whois:
      properties:
        administrative_city:
          type: string
        administrative_country:
          type: string
        administrative_email:
          type: string
        administrative_fax:
          type: string
        administrative_fax_ext:
          type: string
        administrative_id:
          type: string
        administrative_name:
          type: string
        administrative_org:
          type: string
        administrative_phone:
          type: string
        administrative_phone_ext:
          type: string
        administrative_postal_code:
          type: string
        administrative_province:
          type: string
        administrative_referral_url:
          type: string
        administrative_street:
          type: string
        billing_city:
          type: string
        billing_country:
          type: string
        billing_email:
          type: string
        billing_fax:
          type: string
        billing_fax_ext:
          type: string
        billing_id:
          type: string
        billing_name:
          type: string
        billing_org:
          type: string
        billing_phone:
          type: string
        billing_phone_ext:
          type: string
        billing_postal_code:
          type: string
        billing_province:
          type: string
        billing_referral_url:
          type: string
        billing_street:
          type: string
        created_date:
          example: "2009-02-17T22:07:54.000Z"
          format: date-time
          type: string
        created_date_raw:
          example: "2009-02-17T22:07:54Z"
          type: string
        dnssec:
          example: true
          type: boolean
        domain:
          $ref: '#/components/schemas/cloudforce-one_domain_name'
        expiration_date:
          example: "2033-02-17T22:07:54.000Z"
          format: date-time
          type: string
        expiration_date_raw:
          example: "2033-02-17T22:07:54Z"
          type: string
        extension:
          example: com
          type: string
        found:
          example: true
          type: boolean
        id:
          example: 1542998887_DOMAIN_COM-VRSN
          type: string
        nameservers:
          example:
            - ns3.cloudflare.com
            - ns4.cloudflare.com
            - ns5.cloudflare.com
            - ns6.cloudflare.com
            - ns7.cloudflare.com
          items:
            type: string
          type: array
        punycode:
          example: cloudflare.com
          type: string
        registrant:
          type: string
        registrant_city:
          type: string
        registrant_country:
          type: string
        registrant_email:
          type: string
        registrant_fax:
          type: string
        registrant_fax_ext:
          type: string
        registrant_id:
          type: string
        registrant_name:
          type: string
        registrant_org:
          type: string
        registrant_phone:
          type: string
        registrant_phone_ext:
          type: string
        registrant_postal_code:
          type: string
        registrant_province:
          type: string
        registrant_referral_url:
          type: string
        registrant_street:
          type: string
        registrar:
          example: Cloudflare, Inc.
          type: string
        registrar_city:
          type: string
        registrar_country:
          type: string
        registrar_email:
          type: string
        registrar_fax:
          type: string
        registrar_fax_ext:
          type: string
        registrar_id:
          type: string
        registrar_name:
          type: string
        registrar_org:
          type: string
        registrar_phone:
          type: string
        registrar_phone_ext:
          type: string
        registrar_postal_code:
          type: string
        registrar_province:
          type: string
        registrar_referral_url:
          type: string
        registrar_street:
          type: string
        status:
          example:
            - clientdeleteprohibited
            - clienttransferprohibited
            - clientupdateprohibited
            - serverdeleteprohibited
            - servertransferprohibited
            - serverupdateprohibited
          items:
            type: string
          type: array
        technical_city:
          type: string
        technical_country:
          type: string
        technical_email:
          type: string
        technical_fax:
          type: string
        technical_fax_ext:
          type: string
        technical_id:
          type: string
        technical_name:
          type: string
        technical_org:
          type: string
        technical_phone:
          type: string
        technical_phone_ext:
          type: string
        technical_postal_code:
          type: string
        technical_province:
          type: string
        technical_referral_url:
          type: string
        technical_street:
          type: string
        updated_date:
          example: "2024-01-09T16:45:28.000Z"
          format: date-time
          type: string
        updated_date_raw:
          example: "2024-01-09T16:45:28Z"
          type: string
        whois_server:
          example: whois.cloudflare.com
          type: string
      required:
        - found
        - domain
        - dnnsec
        - extension
        - nameservers
        - punycode
        - registrar
        - registrant
    custom-indicator-feeds_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/custom-indicator-feeds_messages'
        messages:
          $ref: '#/components/schemas/custom-indicator-feeds_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    custom-indicator-feeds_api-response-single:
      allOf:
        - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common'
      type: object
    custom-indicator-feeds_api_response_common_failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/custom-indicator-feeds_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/custom-indicator-feeds_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    custom-indicator-feeds_create_feed:
      example:
        description: example feed description
        name: example_feed_1
      properties:
        description:
          $ref: '#/components/schemas/custom-indicator-feeds_description'
        name:
          $ref: '#/components/schemas/custom-indicator-feeds_name'
    custom-indicator-feeds_create_feed_response:
      allOf:
        - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_item'
    custom-indicator-feeds_description:
      description: The description of the example test
      type: string
    custom-indicator-feeds_feed_id:
      description: Indicator feed ID
      example: 12
      type: integer
    custom-indicator-feeds_id:
      description: The unique identifier for the indicator feed
      type: integer
    custom-indicator-feeds_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    custom-indicator-feeds_indicator_feed_item:
      example:
        created_on: "2023-05-12T12:21:56.777653Z"
        description: example feed description
        id: 1
        is_attributable: false
        is_downloadable: false
        is_public: false
        modified_on: "2023-06-18T03:13:34.123321Z"
        name: example_feed_1
      properties:
        created_on:
          description: The date and time when the data entry was created
          format: date-time
          type: string
        description:
          $ref: '#/components/schemas/custom-indicator-feeds_description'
        id:
          $ref: '#/components/schemas/custom-indicator-feeds_id'
        is_attributable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_attributable'
        is_downloadable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_downloadable'
        is_public:
          $ref: '#/components/schemas/custom-indicator-feeds_is_public'
        modified_on:
          description: The date and time when the data entry was last modified
          format: date-time
          type: string
        name:
          $ref: '#/components/schemas/custom-indicator-feeds_name'
    custom-indicator-feeds_indicator_feed_metadata:
      example:
        created_on: "2023-05-12T12:21:56.777653Z"
        description: example feed description
        id: 1
        is_attributable: false
        is_downloadable: false
        is_public: false
        latest_upload_status: Complete
        modified_on: "2023-06-18T03:13:34.123321Z"
        name: example_feed_1
      properties:
        created_on:
          description: The date and time when the data entry was created
          format: date-time
          type: string
        description:
          $ref: '#/components/schemas/custom-indicator-feeds_description'
        id:
          $ref: '#/components/schemas/custom-indicator-feeds_id'
        is_attributable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_attributable'
        is_downloadable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_downloadable'
        is_public:
          $ref: '#/components/schemas/custom-indicator-feeds_is_public'
        latest_upload_status:
          description: Status of the latest snapshot uploaded
          enum:
            - Mirroring
            - Unifying
            - Loading
            - Provisioning
            - Complete
            - Error
          type: string
        modified_on:
          description: The date and time when the data entry was last modified
          format: date-time
          type: string
        name:
          $ref: '#/components/schemas/custom-indicator-feeds_name'
        provider_id:
          $ref: '#/components/schemas/custom-indicator-feeds_provider_id'
        provider_name:
          $ref: '#/components/schemas/custom-indicator-feeds_provider_name'
    custom-indicator-feeds_indicator_feed_metadata_response:
      allOf:
        - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_metadata'
    custom-indicator-feeds_indicator_feed_response:
      allOf:
        - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common'
        - properties:
            result:
              example:
                - created_on: "2023-05-12T12:21:56.777653Z"
                  description: user specified description 1
                  id: 1
                  modified_on: "2023-06-18T03:13:34.123321Z"
                  name: user_specified_name_1
                - created_on: "2023-05-21T21:43:52.867525Z"
                  description: User specified description 2
                  id: 2
                  modified_on: "2023-06-28T18:46:18.764425Z"
                  name: user_specified_name_2
              items:
                $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_item'
              type: array
    custom-indicator-feeds_indicator_feed_response_single:
      allOf:
        - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_item'
    custom-indicator-feeds_is_attributable:
      description: Whether the indicator feed can be attributed to a provider
      type: boolean
    custom-indicator-feeds_is_downloadable:
      description: Whether the indicator feed can be downloaded
      type: boolean
    custom-indicator-feeds_is_public:
      description: Whether the indicator feed is exposed to customers
      type: boolean
    custom-indicator-feeds_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    custom-indicator-feeds_name:
      description: The name of the indicator feed
      type: string
    custom-indicator-feeds_permission_list_item:
      properties:
        description:
          $ref: '#/components/schemas/custom-indicator-feeds_description'
        id:
          $ref: '#/components/schemas/custom-indicator-feeds_id'
        is_attributable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_attributable'
        is_downloadable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_downloadable'
        is_public:
          $ref: '#/components/schemas/custom-indicator-feeds_is_public'
        name:
          $ref: '#/components/schemas/custom-indicator-feeds_name'
    custom-indicator-feeds_permission_list_item_response:
      allOf:
        - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common'
        - properties:
            result:
              example:
                - description: An important indicator list
                  id: 1
                  is_attributable: false
                  is_downloadable: false
                  is_public: false
                  name: indicator_list_1
                - description: An even more important indicator list
                  id: 2
                  is_attributable: true
                  is_downloadable: false
                  is_public: true
                  name: indicator_list_2
              items:
                $ref: '#/components/schemas/custom-indicator-feeds_permission_list_item'
              type: array
    custom-indicator-feeds_permissions_request:
      properties:
        account_tag:
          description: The Cloudflare account tag of the account to change permissions on
          example: 823f45f16fd2f7e21e1e054aga4d2859
          type: string
        feed_id:
          description: The ID of the feed to add/remove permissions on
          example: 1
          type: integer
    custom-indicator-feeds_permissions_response:
      allOf:
        - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/custom-indicator-feeds_permissions_update'
    custom-indicator-feeds_permissions_update:
      properties:
        success:
          description: Whether the update succeeded or not
          type: boolean
    custom-indicator-feeds_provider_id:
      description: The unique identifier for the provider
      type: string
    custom-indicator-feeds_provider_name:
      description: The provider of the indicator feed
      type: string
    custom-indicator-feeds_update_feed:
      properties:
        file_id:
          description: Feed id
          example: 1
          type: integer
        filename:
          description: Name of the file unified in our system
          example: snapshot_file.unified
          type: string
        status:
          description: Current status of upload, should be unified
          example: unified
          type: string
    custom-indicator-feeds_update_feed_response:
      allOf:
        - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/custom-indicator-feeds_update_feed'
    custom-indicator-feeds_update_public_field_request:
      properties:
        description:
          description: The new description of the feed
          example: This is an example description
          type: string
        is_attributable:
          description: The new is_attributable value of the feed
          example: true
          type: boolean
        is_downloadable:
          description: The new is_downloadable value of the feed
          example: true
          type: boolean
        is_public:
          description: The new is_public value of the feed
          example: true
          type: boolean
        name:
          description: The new name of the feed
          example: indicator_list
          type: string
    custom-indicator-feeds_update_public_field_response:
      allOf:
        - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_item'
    custom-pages_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/custom-pages_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/custom-pages_result_info'
      type: object
    custom-pages_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/custom-pages_messages'
        messages:
          $ref: '#/components/schemas/custom-pages_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    custom-pages_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/custom-pages_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/custom-pages_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    custom-pages_api-response-single:
      allOf:
        - $ref: '#/components/schemas/custom-pages_api-response-common'
        - properties:
            result:
              anyOf:
                - type: object
                - type: string
              nullable: true
      type: object
    custom-pages_custom_pages_response_collection:
      allOf:
        - $ref: '#/components/schemas/custom-pages_api-response-collection'
        - properties:
            result:
              items:
                type: object
              type: array
    custom-pages_custom_pages_response_single:
      allOf:
        - $ref: '#/components/schemas/custom-pages_api-response-single'
        - properties:
            result:
              type: object
    custom-pages_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    custom-pages_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    custom-pages_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    custom-pages_state:
      description: The custom page state.
      enum:
        - default
        - customized
      example: default
      type: string
    custom-pages_url:
      default: ""
      description: The URL associated with the custom page.
      example: http://www.example.com
      format: uri
      type: string
    d1_account-identifier:
      description: Account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    d1_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/d1_messages'
        messages:
          $ref: '#/components/schemas/d1_messages'
        result:
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    d1_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/d1_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/d1_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    d1_created-at:
      description: Specifies the timestamp the resource was created as an ISO8601 string.
      example: "2022-11-15T18:25:44.442097Z"
      format: date-time
      readOnly: true
      type: string
    d1_database-details-response:
      properties:
        created_at:
          $ref: '#/components/schemas/d1_created-at'
        file_size:
          $ref: '#/components/schemas/d1_file-size'
        name:
          $ref: '#/components/schemas/d1_database-name'
        num_tables:
          $ref: '#/components/schemas/d1_table-count'
        uuid:
          $ref: '#/components/schemas/d1_database-identifier'
        version:
          $ref: '#/components/schemas/d1_database-version'
      type: object
    d1_database-identifier:
      example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      readOnly: true
      type: string
    d1_database-name:
      example: my-database
      pattern: ^[a-z0-9][a-z0-9-_]*$
      type: string
    d1_database-response:
      properties:
        created_at:
          $ref: '#/components/schemas/d1_created-at'
        name:
          $ref: '#/components/schemas/d1_database-name'
        uuid:
          $ref: '#/components/schemas/d1_database-identifier'
        version:
          $ref: '#/components/schemas/d1_database-version'
      type: object
    d1_database-version:
      example: production
      pattern: ^(alpha|beta|production)$
      type: string
    d1_file-size:
      description: The D1 database's size, in bytes.
      example: 12
      type: number
    d1_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    d1_params:
      example:
        - firstParam
        - secondParam
      items:
        type: string
      type: array
    d1_primary-location-hint:
      description: Specify the region to create the D1 primary, if available. If this option is omitted, the D1 will be created as close as possible to the current user.
      enum:
        - wnam
        - enam
        - weur
        - eeur
        - apac
        - oc
      example: wnam
      type: string
    d1_query-meta:
      properties:
        changed_db:
          type: boolean
        changes:
          type: number
        duration:
          type: number
        last_row_id:
          type: number
        rows_read:
          type: number
        rows_written:
          type: number
        size_after:
          type: number
      type: object
    d1_query-result-response:
      properties:
        meta:
          $ref: '#/components/schemas/d1_query-meta'
        results:
          items:
            type: object
          type: array
        success:
          type: boolean
      type: object
    d1_raw-result-response:
      properties:
        meta:
          $ref: '#/components/schemas/d1_query-meta'
        results:
          properties:
            columns:
              items:
                type: string
              type: array
            rows:
              items:
                items:
                  anyOf:
                    - type: number
                    - type: string
                    - type: object
                type: array
              type: array
          type: object
        success:
          type: boolean
      type: object
    d1_sql:
      description: Your SQL query. Supports multiple statements, joined by semicolons, which will be executed as a batch.
      example: SELECT * FROM myTable WHERE field = ? OR field = ?;
      type: string
    d1_table-count:
      example: 12
      type: number
    digital-experience-monitoring_account_identifier:
      example: 01a7362d577a6c3019a474fd6f485823
      maxLength: 32
      readOnly: true
      type: string
    digital-experience-monitoring_aggregate_stat:
      properties:
        avgMs:
          nullable: true
          type: integer
        deltaPct:
          format: float
          nullable: true
          type: number
        timePeriod:
          $ref: '#/components/schemas/digital-experience-monitoring_aggregate_time_period'
      required:
        - timePeriod
      type: object
    digital-experience-monitoring_aggregate_time_period:
      properties:
        units:
          enum:
            - hours
            - days
            - testRuns
          type: string
        value:
          type: integer
      required:
        - value
        - units
      type: object
    digital-experience-monitoring_aggregate_time_slot:
      properties:
        avgMs:
          type: integer
        timestamp:
          type: string
      required:
        - timestamp
        - avgMs
      type: object
    digital-experience-monitoring_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/digital-experience-monitoring_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/digital-experience-monitoring_result_info'
      type: object
    digital-experience-monitoring_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/digital-experience-monitoring_messages'
        messages:
          $ref: '#/components/schemas/digital-experience-monitoring_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    digital-experience-monitoring_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/digital-experience-monitoring_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/digital-experience-monitoring_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    digital-experience-monitoring_api-response-single:
      allOf:
        - $ref: '#/components/schemas/digital-experience-monitoring_api-response-common'
      type: object
    digital-experience-monitoring_colo:
      description: Cloudflare colo
      example: SJC
      type: string
    digital-experience-monitoring_colos_response:
      description: array of colos.
      items:
        required:
          - airportCode
          - countryCode
          - city
        type: object
      properties:
        airportCode:
          description: Airport code
          example: SFO
          type: string
        city:
          description: City
          example: San Francisco
          type: string
        countryCode:
          description: Country code
          example: US
          type: string
      type: array
    digital-experience-monitoring_device:
      properties:
        colo:
          $ref: '#/components/schemas/digital-experience-monitoring_colo'
        deviceId:
          description: Device identifier (UUID v4)
          type: string
        deviceName:
          description: Device identifier (human readable)
          type: string
        personEmail:
          $ref: '#/components/schemas/digital-experience-monitoring_personEmail'
        platform:
          $ref: '#/components/schemas/digital-experience-monitoring_platform'
        status:
          $ref: '#/components/schemas/digital-experience-monitoring_status'
        version:
          $ref: '#/components/schemas/digital-experience-monitoring_version'
      required:
        - colo
        - deviceId
        - mode
        - platform
        - status
        - timestamp
        - version
      type: object
    digital-experience-monitoring_device_id:
      description: Device-specific ID, given as UUID v4
      example: cb49c27f-7f97-49c5-b6f3-f7c01ead0fd7
      type: string
    digital-experience-monitoring_fleet_status_devices_response:
      allOf:
        - $ref: '#/components/schemas/digital-experience-monitoring_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/digital-experience-monitoring_device'
              type: array
          type: object
    digital-experience-monitoring_fleet_status_live_response:
      allOf:
        - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
        - properties:
            result:
              properties:
                deviceStats:
                  properties:
                    byColo:
                      items:
                        $ref: '#/components/schemas/digital-experience-monitoring_live_stat'
                      nullable: true
                      type: array
                    byMode:
                      items:
                        $ref: '#/components/schemas/digital-experience-monitoring_live_stat'
                      nullable: true
                      type: array
                    byPlatform:
                      items:
                        $ref: '#/components/schemas/digital-experience-monitoring_live_stat'
                      nullable: true
                      type: array
                    byStatus:
                      items:
                        $ref: '#/components/schemas/digital-experience-monitoring_live_stat'
                      nullable: true
                      type: array
                    byVersion:
                      items:
                        $ref: '#/components/schemas/digital-experience-monitoring_live_stat'
                      nullable: true
                      type: array
                    uniqueDevicesTotal:
                      $ref: '#/components/schemas/digital-experience-monitoring_uniqueDevicesTotal'
                  type: object
              type: object
          type: object
    digital-experience-monitoring_http_details_percentiles_response:
      properties:
        dnsResponseTimeMs:
          $ref: '#/components/schemas/digital-experience-monitoring_percentiles'
        resourceFetchTimeMs:
          $ref: '#/components/schemas/digital-experience-monitoring_percentiles'
        serverResponseTimeMs:
          $ref: '#/components/schemas/digital-experience-monitoring_percentiles'
      type: object
    digital-experience-monitoring_http_details_response:
      properties:
        host:
          description: The url of the HTTP synthetic application test
          example: http://example.com
          type: string
        httpStats:
          nullable: true
          properties:
            availabilityPct:
              $ref: '#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time'
            dnsResponseTimeMs:
              $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
            httpStatusCode:
              items:
                properties:
                  status200:
                    type: integer
                  status300:
                    type: integer
                  status400:
                    type: integer
                  status500:
                    type: integer
                  timestamp:
                    example: 2023-07-16 15:00:00+00
                    type: string
                required:
                  - timestamp
                  - status200
                  - status300
                  - status400
                  - status500
                type: object
              type: array
            resourceFetchTimeMs:
              $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
            serverResponseTimeMs:
              $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
            uniqueDevicesTotal:
              description: Count of unique devices that have run this test in the given time period
              example: 57
              type: integer
          required:
            - uniqueDevicesTotal
            - resourceFetchTimeMs
            - serverResponseTimeMs
            - dnsResponseTimeMs
            - httpStatusCode
            - availabilityPct
          type: object
        httpStatsByColo:
          items:
            properties:
              availabilityPct:
                $ref: '#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time'
              colo:
                example: DFW
                type: string
              dnsResponseTimeMs:
                $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
              httpStatusCode:
                items:
                  properties:
                    status200:
                      type: integer
                    status300:
                      type: integer
                    status400:
                      type: integer
                    status500:
                      type: integer
                    timestamp:
                      example: 2023-07-16 15:00:00+00
                      type: string
                  required:
                    - timestamp
                    - status200
                    - status300
                    - status400
                    - status500
                  type: object
                type: array
              resourceFetchTimeMs:
                $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
              serverResponseTimeMs:
                $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
              uniqueDevicesTotal:
                description: Count of unique devices that have run this test in the given time period
                example: 57
                type: integer
            required:
              - colo
              - uniqueDevicesTotal
              - resourceFetchTimeMs
              - serverResponseTimeMs
              - dnsResponseTimeMs
              - httpStatusCode
              - availabilityPct
            type: object
          type: array
        interval:
          description: The interval at which the HTTP synthetic application test is set to run.
          example: 0h5m0s
          type: string
        kind:
          enum:
            - http
        method:
          description: The HTTP method to use when running the test
          example: GET
          type: string
        name:
          description: The name of the HTTP synthetic application test
          example: Atlassian Sign In Page
          type: string
        target_policies:
          items:
            properties:
              default:
                description: Whether the policy is the default for the account
                type: boolean
              id:
                type: string
              name:
                type: string
            required:
              - id
              - name
              - default
            type: object
          nullable: true
          type: array
        targeted:
          type: boolean
      type: object
    digital-experience-monitoring_live_stat:
      properties:
        uniqueDevicesTotal:
          $ref: '#/components/schemas/digital-experience-monitoring_uniqueDevicesTotal'
        value:
          type: string
      type: object
    digital-experience-monitoring_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    digital-experience-monitoring_mode:
      description: The mode under which the WARP client is run
      example: proxy
      type: string
    digital-experience-monitoring_page:
      default: 1
      description: Page number of paginated results
      example: 1
      minimum: 1
      type: number
    digital-experience-monitoring_per_page:
      description: Number of items per page
      example: 10
      maximum: 50
      minimum: 1
      type: number
    digital-experience-monitoring_percentiles:
      properties:
        p50:
          description: p50 observed in the time period
          nullable: true
          type: number
        p90:
          description: p90 observed in the time period
          nullable: true
          type: number
        p95:
          description: p95 observed in the time period
          nullable: true
          type: number
        p99:
          description: p99 observed in the time period
          nullable: true
          type: number
      type: object
    digital-experience-monitoring_personEmail:
      description: User contact email address
      type: string
    digital-experience-monitoring_platform:
      description: Operating system
      example: windows
      type: string
    digital-experience-monitoring_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    digital-experience-monitoring_since_minutes:
      default: 10
      description: Number of minutes before current time
      example: 10
      maximum: 60
      minimum: 1
      type: number
    digital-experience-monitoring_sort_by:
      default: timestamp
      description: Dimension to sort results by
      enum:
        - colo
        - device_id
        - mode
        - platform
        - status
        - timestamp
        - version
      type: string
    digital-experience-monitoring_source:
      default: last_seen
      description: Specifies fleet status details source
      enum:
        - last_seen
        - hourly
        - raw
      example: last_seen
      type: string
    digital-experience-monitoring_status:
      description: Network status
      example: connected
      type: string
    digital-experience-monitoring_test_stat_over_time:
      properties:
        avg:
          description: average observed in the time period
          nullable: true
          type: integer
        max:
          description: highest observed in the time period
          nullable: true
          type: integer
        min:
          description: lowest observed in the time period
          nullable: true
          type: integer
        slots:
          items:
            properties:
              timestamp:
                example: 2023-07-16 15:00:00+00
                type: string
              value:
                type: integer
            required:
              - timestamp
              - value
            type: object
          type: array
      required:
        - slots
      type: object
    digital-experience-monitoring_test_stat_pct_over_time:
      properties:
        avg:
          description: average observed in the time period
          format: float
          nullable: true
          type: number
        max:
          description: highest observed in the time period
          format: float
          nullable: true
          type: number
        min:
          description: lowest  observed in the time period
          format: float
          nullable: true
          type: number
        slots:
          items:
            properties:
              timestamp:
                example: 2023-07-16 15:00:00+00
                type: string
              value:
                format: float
                type: number
            required:
              - timestamp
              - value
            type: object
          type: array
      required:
        - slots
      type: object
    digital-experience-monitoring_tests_response:
      properties:
        overviewMetrics:
          properties:
            avgHttpAvailabilityPct:
              description: percentage availability for all HTTP test results in response
              format: float
              nullable: true
              type: number
            avgTracerouteAvailabilityPct:
              description: percentage availability for all traceroutes results in response
              format: float
              nullable: true
              type: number
            testsTotal:
              description: number of  tests.
              type: integer
          required:
            - testsTotal
          type: object
        tests:
          description: array of test results objects.
          items:
            properties:
              created:
                description: date the test was created.
                type: string
              description:
                description: the test description defined during configuration
                type: string
              enabled:
                description: if true, then the test will run on targeted devices. Else, the test will not run.
                type: boolean
              host:
                type: string
              httpResults:
                nullable: true
                properties:
                  resourceFetchTime:
                    $ref: '#/components/schemas/digital-experience-monitoring_timing_aggregates'
                required:
                  - resourceFetchTime
                type: object
              httpResultsByColo:
                items:
                  properties:
                    colo:
                      description: Cloudflare colo
                      example: SJC
                      type: string
                    resourceFetchTime:
                      $ref: '#/components/schemas/digital-experience-monitoring_timing_aggregates'
                  required:
                    - colo
                    - resourceFetchTime
                  type: object
                type: array
              id:
                $ref: '#/components/schemas/digital-experience-monitoring_uuid'
              interval:
                description: The interval at which the synthetic application test is set to run.
                type: string
              kind:
                description: test type, http or traceroute
                enum:
                  - http
                  - traceroute
                type: string
              method:
                description: for HTTP, the method to use when running the test
                type: string
              name:
                description: name given to this test
                type: string
              target_policies:
                items:
                  properties:
                    default:
                      description: Whether the policy is the default for the account
                      type: boolean
                    id:
                      type: string
                    name:
                      type: string
                  required:
                    - id
                    - name
                    - default
                  type: object
                nullable: true
                type: array
              targeted:
                type: boolean
              tracerouteResults:
                nullable: true
                properties:
                  roundTripTime:
                    $ref: '#/components/schemas/digital-experience-monitoring_timing_aggregates'
                required:
                  - roundTripTime
                type: object
              tracerouteResultsByColo:
                items:
                  properties:
                    colo:
                      description: Cloudflare colo
                      example: SJC
                      type: string
                    roundTripTime:
                      $ref: '#/components/schemas/digital-experience-monitoring_timing_aggregates'
                  required:
                    - colo
                    - roundTripTime
                  type: object
                type: array
              updated:
                type: string
            required:
              - id
              - name
              - kind
              - interval
              - enabled
              - description
              - updated
              - created
              - host
            type: object
          type: array
      required:
        - overviewMetrics
        - tests
      type: object
    digital-experience-monitoring_timestamp:
      description: Timestamp in ISO format
      example: "2023-10-11T00:00:00Z"
      type: string
    digital-experience-monitoring_timing_aggregates:
      properties:
        avgMs:
          nullable: true
          type: integer
        history:
          items:
            $ref: '#/components/schemas/digital-experience-monitoring_aggregate_stat'
          type: array
        overTime:
          nullable: true
          properties:
            timePeriod:
              $ref: '#/components/schemas/digital-experience-monitoring_aggregate_time_period'
            values:
              items:
                $ref: '#/components/schemas/digital-experience-monitoring_aggregate_time_slot'
              type: array
          required:
            - values
            - timePeriod
          type: object
      required:
        - history
      type: object
    digital-experience-monitoring_traceroute_details_percentiles_response:
      properties:
        hopsCount:
          $ref: '#/components/schemas/digital-experience-monitoring_percentiles'
        packetLossPct:
          $ref: '#/components/schemas/digital-experience-monitoring_percentiles'
        roundTripTimeMs:
          $ref: '#/components/schemas/digital-experience-monitoring_percentiles'
      type: object
    digital-experience-monitoring_traceroute_details_response:
      properties:
        host:
          description: The host of the Traceroute synthetic application test
          example: 1.1.1.1
          type: string
        interval:
          description: The interval at which the Traceroute synthetic application test is set to run.
          example: 0h5m0s
          type: string
        kind:
          enum:
            - traceroute
        name:
          description: The name of the Traceroute synthetic application test
          example: Atlassian Sign In Page
          type: string
        target_policies:
          items:
            properties:
              default:
                description: Whether the policy is the default for the account
                type: boolean
              id:
                type: string
              name:
                type: string
            required:
              - id
              - name
              - default
            type: object
          nullable: true
          type: array
        targeted:
          type: boolean
        tracerouteStats:
          nullable: true
          properties:
            availabilityPct:
              $ref: '#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time'
            hopsCount:
              $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
            packetLossPct:
              $ref: '#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time'
            roundTripTimeMs:
              $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
            uniqueDevicesTotal:
              description: Count of unique devices that have run this test in the given time period
              example: 57
              type: integer
          required:
            - uniqueDevicesTotal
            - roundTripTimeMs
            - hopsCount
            - packetLossPct
            - availabilityPct
          type: object
        tracerouteStatsByColo:
          items:
            properties:
              availabilityPct:
                $ref: '#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time'
              colo:
                example: DFW
                type: string
              hopsCount:
                $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
              packetLossPct:
                $ref: '#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time'
              roundTripTimeMs:
                $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
              uniqueDevicesTotal:
                description: Count of unique devices that have run this test in the given time period
                example: 57
                type: integer
            required:
              - colo
              - uniqueDevicesTotal
              - roundTripTimeMs
              - hopsCount
              - packetLossPct
              - availabilityPct
            type: object
          type: array
      required:
        - kind
        - name
        - host
        - interval
      type: object
    digital-experience-monitoring_traceroute_test_network_path_response:
      properties:
        deviceName:
          type: string
        id:
          $ref: '#/components/schemas/digital-experience-monitoring_uuid'
        interval:
          description: The interval at which the Traceroute synthetic application test is set to run.
          example: 0h5m0s
          type: string
        kind:
          enum:
            - traceroute
        name:
          type: string
        networkPath:
          nullable: true
          properties:
            sampling:
              description: Specifies the sampling applied, if any, to the slots response. When sampled, results shown represent the first test run to the start of each sampling interval.
              nullable: true
              properties:
                unit:
                  enum:
                    - hours
                value:
                  type: integer
              required:
                - value
                - unit
              type: object
            slots:
              items:
                properties:
                  clientToAppRttMs:
                    description: Round trip time in ms of the client to app mile
                    nullable: true
                    type: integer
                  clientToCfEgressRttMs:
                    description: Round trip time in ms of the client to Cloudflare egress mile
                    nullable: true
                    type: integer
                  clientToCfIngressRttMs:
                    description: Round trip time in ms of the client to Cloudflare ingress mile
                    nullable: true
                    type: integer
                  clientToIspRttMs:
                    description: Round trip time in ms of the client to ISP mile
                    nullable: true
                    type: integer
                  id:
                    $ref: '#/components/schemas/digital-experience-monitoring_uuid'
                  timestamp:
                    example: 2023-07-16 15:00:00+00
                    type: string
                required:
                  - id
                  - timestamp
                  - clientToAppRttMs
                  - clientToCfIngressRttMs
                  - clientToCfEgressRttMs
                type: object
              type: array
          required:
            - slots
          type: object
        url:
          description: The host of the Traceroute synthetic application test
          example: 1.1.1.1
          type: string
      required:
        - id
      type: object
    digital-experience-monitoring_traceroute_test_result_network_path_response:
      properties:
        deviceName:
          description: name of the device associated with this network path response
          type: string
        hops:
          description: an array of the hops taken by the device to reach the end destination
          items:
            properties:
              asn:
                nullable: true
                type: integer
              aso:
                nullable: true
                type: string
              ipAddress:
                nullable: true
                type: string
              location:
                nullable: true
                properties:
                  city:
                    nullable: true
                    type: string
                  state:
                    nullable: true
                    type: string
                  zip:
                    nullable: true
                    type: string
                type: object
              mile:
                enum:
                  - client-to-app
                  - client-to-cf-egress
                  - client-to-cf-ingress
                  - client-to-isp
                nullable: true
                type: string
              name:
                nullable: true
                type: string
              packetLossPct:
                format: float
                nullable: true
                type: number
              rttMs:
                nullable: true
                type: integer
              ttl:
                type: integer
            required:
              - ttl
            type: object
          type: array
        resultId:
          $ref: '#/components/schemas/digital-experience-monitoring_uuid'
        testId:
          $ref: '#/components/schemas/digital-experience-monitoring_uuid'
        testName:
          description: name of the tracroute test
          type: string
      required:
        - resultId
        - hops
      type: object
    digital-experience-monitoring_unique_devices_response:
      properties:
        uniqueDevicesTotal:
          description: total number of unique devices
          type: integer
      required:
        - uniqueDevicesTotal
      type: object
    digital-experience-monitoring_uniqueDevicesTotal:
      description: Number of unique devices
      type: number
    digital-experience-monitoring_uuid:
      description: API Resource UUID tag.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    digital-experience-monitoring_version:
      description: WARP client version
      example: 1.0.0
      type: string
    dlp_Behavior:
      properties:
        description:
          type: string
        enabled:
          type: boolean
        name:
          type: string
        risk_level:
          $ref: '#/components/schemas/dlp_RiskLevel'
      required:
        - name
        - description
        - risk_level
        - enabled
      type: object
    dlp_Behaviors:
      properties:
        behaviors:
          additionalProperties:
            $ref: '#/components/schemas/dlp_Behavior'
          type: object
      required:
        - behaviors
      type: object
    dlp_ContextAwareness:
      description: Scan the context of predefined entries to only return matches surrounded by keywords.
      properties:
        enabled:
          description: If true, scan the context of predefined entries to only return matches surrounded by keywords.
          type: boolean
        skip:
          $ref: '#/components/schemas/dlp_SkipConfig'
      required:
        - enabled
        - skip
      type: object
    dlp_CreateIntegrationBody:
      properties:
        integration_type:
          $ref: '#/components/schemas/dlp_RiskScoreIntegrationType'
        reference_id:
          description: |-
            A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4).
            https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
          nullable: true
          type: string
        tenant_url:
          description: The base url of the tenant, e.g. "https://tenant.okta.com"
          format: uri
          type: string
      required:
        - integration_type
        - tenant_url
      type: object
    dlp_CustomEntry:
      properties:
        created_at:
          format: date-time
          type: string
        enabled:
          type: boolean
        id:
          format: uuid
          type: string
        name:
          type: string
        pattern:
          $ref: '#/components/schemas/dlp_Pattern'
        profile_id:
          format: uuid
          nullable: true
          type: string
        updated_at:
          format: date-time
          type: string
      required:
        - id
        - name
        - created_at
        - updated_at
        - pattern
        - enabled
      type: object
    dlp_CustomProfile:
      properties:
        allowed_match_count:
          default: 0
          description: Related DLP policies will trigger when the match count exceeds the number set.
          example: 5
          format: int32
          maximum: 1000
          minimum: 0
          type: integer
        context_awareness:
          $ref: '#/components/schemas/dlp_ContextAwareness'
        created_at:
          description: When the profile was created
          format: date-time
          type: string
        description:
          description: The description of the profile
          nullable: true
          type: string
        entries:
          items:
            $ref: '#/components/schemas/dlp_Entry'
          type: array
        id:
          description: The id of the profile (uuid)
          format: uuid
          type: string
        name:
          description: The name of the profile
          type: string
        ocr_enabled:
          type: boolean
        updated_at:
          description: When the profile was lasted updated
          format: date-time
          type: string
      required:
        - id
        - name
        - entries
        - created_at
        - updated_at
        - allowed_match_count
        - context_awareness
        - ocr_enabled
      type: object
    dlp_CustomProfileUpdate:
      properties:
        allowed_match_count:
          format: int32
          nullable: true
          type: integer
        context_awareness:
          $ref: '#/components/schemas/dlp_ContextAwareness'
        description:
          description: The description of the profile
          nullable: true
          type: string
        entries:
          description: Custom entries from this profile
          items:
            $ref: '#/components/schemas/dlp_EntryUpdate'
          type: array
        name:
          type: string
        ocr_enabled:
          type: boolean
        shared_entries:
          description: Other entries, e.g. predefined or integration.
          items:
            $ref: '#/components/schemas/dlp_SharedEntryUpdate'
          type: array
      required:
        - name
        - entries
      type: object
    dlp_Dataset:
      properties:
        columns:
          items:
            $ref: '#/components/schemas/dlp_DatasetColumn'
          type: array
        created_at:
          format: date-time
          type: string
        description:
          description: The description of the dataset
          nullable: true
          type: string
        encoding_version:
          format: int32
          minimum: 0
          type: integer
        id:
          format: uuid
          type: string
        name:
          type: string
        num_cells:
          format: int64
          type: integer
        secret:
          type: boolean
        status:
          $ref: '#/components/schemas/dlp_DatasetUploadStatus'
        updated_at:
          format: date-time
          type: string
        uploads:
          items:
            $ref: '#/components/schemas/dlp_DatasetUpload'
          type: array
      required:
        - name
        - id
        - status
        - num_cells
        - created_at
        - updated_at
        - uploads
        - secret
        - encoding_version
        - columns
      type: object
    dlp_DatasetArray:
      items:
        $ref: '#/components/schemas/dlp_Dataset'
      type: array
    dlp_DatasetColumn:
      properties:
        entry_id:
          format: uuid
          type: string
        header_name:
          type: string
        num_cells:
          format: int64
          type: integer
        upload_status:
          $ref: '#/components/schemas/dlp_DatasetUploadStatus'
      required:
        - entry_id
        - upload_status
        - header_name
        - num_cells
      type: object
    dlp_DatasetColumnArray:
      items:
        $ref: '#/components/schemas/dlp_DatasetColumn'
      type: array
    dlp_DatasetCreation:
      properties:
        dataset:
          $ref: '#/components/schemas/dlp_Dataset'
        encoding_version:
          description: Encoding version to use for dataset
          format: int32
          minimum: 0
          type: integer
        max_cells:
          format: int64
          minimum: 0
          type: integer
        secret:
          description: |-
            The secret to use for Exact Data Match datasets. This is not present in
            Custom Wordlists.
          format: password
          type: string
        version:
          description: The version to use when uploading the dataset.
          format: int64
          type: integer
      required:
        - version
        - max_cells
        - dataset
        - encoding_version
      type: object
    dlp_DatasetNewVersion:
      properties:
        columns:
          items:
            $ref: '#/components/schemas/dlp_DatasetColumn'
          type: array
        encoding_version:
          format: int32
          minimum: 0
          type: integer
        max_cells:
          format: int64
          minimum: 0
          type: integer
        secret:
          format: password
          type: string
        version:
          format: int64
          type: integer
      required:
        - version
        - max_cells
        - encoding_version
      type: object
    dlp_DatasetUpdate:
      properties:
        description:
          description: The description of the dataset
          nullable: true
          type: string
        name:
          description: The name of the dataset, must be unique
          nullable: true
          type: string
      type: object
    dlp_DatasetUpload:
      properties:
        num_cells:
          format: int64
          type: integer
        status:
          $ref: '#/components/schemas/dlp_DatasetUploadStatus'
        version:
          format: int64
          type: integer
      required:
        - version
        - status
        - num_cells
      type: object
    dlp_DatasetUploadStatus:
      enum:
        - empty
        - uploading
        - processing
        - failed
        - complete
      type: string
    dlp_Empty:
      nullable: true
      type: object
    dlp_Entry:
      discriminator:
        propertyName: type
      oneOf:
        - allOf:
            - $ref: '#/components/schemas/dlp_CustomEntry'
            - properties:
                type:
                  enum:
                    - custom
                  type: string
              required:
                - type
              type: object
          title: Custom Entry
        - allOf:
            - $ref: '#/components/schemas/dlp_PredefinedEntry'
            - properties:
                type:
                  enum:
                    - predefined
                  type: string
              required:
                - type
              type: object
          title: Predefined Entry
        - allOf:
            - $ref: '#/components/schemas/dlp_IntegrationEntry'
            - properties:
                type:
                  enum:
                    - integration
                  type: string
              required:
                - type
              type: object
          title: Integration Entry
        - allOf:
            - $ref: '#/components/schemas/dlp_ExactDataEntry'
            - properties:
                type:
                  enum:
                    - exact_data
                  type: string
              required:
                - type
              type: object
          title: Exact Data Entry
        - allOf:
            - $ref: '#/components/schemas/dlp_WordListEntry'
            - properties:
                type:
                  enum:
                    - word_list
                  type: string
              required:
                - type
              type: object
          title: Word List Entry
    dlp_EntryOfNewProfile:
      oneOf:
        - $ref: '#/components/schemas/dlp_NewCustomEntry'
        - $ref: '#/components/schemas/dlp_NewWordListEntry'
    dlp_EntryUpdate:
      oneOf:
        - $ref: '#/components/schemas/dlp_NewCustomEntryWithId'
        - $ref: '#/components/schemas/dlp_NewCustomEntry'
    dlp_ExactDataEntry:
      properties:
        created_at:
          format: date-time
          type: string
        enabled:
          type: boolean
        id:
          format: uuid
          type: string
        name:
          type: string
        secret:
          type: boolean
        updated_at:
          format: date-time
          type: string
      required:
        - id
        - name
        - created_at
        - updated_at
        - enabled
        - secret
      type: object
    dlp_IntegrationEntry:
      properties:
        created_at:
          format: date-time
          type: string
        enabled:
          type: boolean
        id:
          format: uuid
          type: string
        name:
          type: string
        profile_id:
          format: uuid
          nullable: true
          type: string
        updated_at:
          format: date-time
          type: string
      required:
        - id
        - name
        - created_at
        - updated_at
        - enabled
      type: object
    dlp_IntegrationProfile:
      properties:
        created_at:
          format: date-time
          type: string
        description:
          description: The description of the profile
          nullable: true
          type: string
        entries:
          items:
            $ref: '#/components/schemas/dlp_Entry'
          type: array
        id:
          format: uuid
          type: string
        name:
          type: string
        updated_at:
          format: date-time
          type: string
      required:
        - id
        - name
        - entries
        - created_at
        - updated_at
      type: object
    dlp_Limits:
      properties:
        max_dataset_cells:
          format: int64
          minimum: 0
          type: integer
      required:
        - max_dataset_cells
      type: object
    dlp_NewCustomEntry:
      properties:
        enabled:
          type: boolean
        name:
          type: string
        pattern:
          $ref: '#/components/schemas/dlp_Pattern'
      required:
        - name
        - pattern
        - enabled
      type: object
    dlp_NewCustomEntryWithId:
      allOf:
        - $ref: '#/components/schemas/dlp_NewCustomEntry'
        - properties:
            entry_id:
              format: uuid
              type: string
          required:
            - entry_id
          type: object
    dlp_NewCustomProfile:
      properties:
        allowed_match_count:
          default: 0
          description: Related DLP policies will trigger when the match count exceeds the number set.
          example: 5
          format: int32
          maximum: 1000
          minimum: 0
          type: integer
        context_awareness:
          $ref: '#/components/schemas/dlp_ContextAwareness'
        description:
          description: The description of the profile
          nullable: true
          type: string
        entries:
          items:
            $ref: '#/components/schemas/dlp_EntryOfNewProfile'
          type: array
        name:
          type: string
        ocr_enabled:
          type: boolean
        shared_entries:
          description: Entries from other profiles (e.g. pre-defined Cloudflare profiles, or your Microsoft Information Protection profiles).
          items:
            $ref: '#/components/schemas/dlp_NewSharedEntry'
          type: array
      required:
        - name
        - entries
      type: object
    dlp_NewCustomProfiles:
      properties:
        profiles:
          items:
            $ref: '#/components/schemas/dlp_NewCustomProfile'
          type: array
      required:
        - profiles
      type: object
    dlp_NewDataset:
      properties:
        description:
          description: The description of the dataset
          nullable: true
          type: string
        encoding_version:
          description: |-
            Dataset encoding version

            Non-secret custom word lists with no header are always version 1.
            Secret EDM lists with no header are version 1.
            Multicolumn CSV with headers are version 2.
            Omitting this field provides the default value 0, which is interpreted
            the same as 1.
          format: int32
          minimum: 0
          type: integer
        name:
          type: string
        secret:
          description: |-
            Generate a secret dataset.

            If true, the response will include a secret to use with the EDM encoder.
            If false, the response has no secret and the dataset is uploaded in plaintext.
          type: boolean
      required:
        - name
      type: object
    dlp_NewDatasetColumn:
      allOf:
        - oneOf:
            - properties:
                entry_id:
                  format: uuid
                  type: string
              required:
                - entry_id
              title: Existing Column
              type: object
            - properties:
                entry_name:
                  type: string
              required:
                - entry_name
              title: New Column
              type: object
        - properties:
            header_name:
              type: string
            num_cells:
              format: int64
              type: integer
          required:
            - header_name
            - num_cells
          type: object
    dlp_NewSharedEntry:
      discriminator:
        propertyName: entry_type
      oneOf:
        - properties:
            enabled:
              type: boolean
            entry_id:
              format: uuid
              type: string
            entry_type:
              enum:
                - custom
              type: string
          required:
            - entry_id
            - enabled
            - entry_type
          type: object
        - properties:
            enabled:
              type: boolean
            entry_id:
              format: uuid
              type: string
            entry_type:
              enum:
                - predefined
              type: string
          required:
            - entry_id
            - enabled
            - entry_type
          type: object
        - properties:
            enabled:
              type: boolean
            entry_id:
              format: uuid
              type: string
            entry_type:
              enum:
                - integration
              type: string
          required:
            - entry_id
            - enabled
            - entry_type
          type: object
        - properties:
            enabled:
              type: boolean
            entry_id:
              format: uuid
              type: string
            entry_type:
              enum:
                - exact_data
              type: string
          required:
            - entry_id
            - enabled
            - entry_type
          type: object
    dlp_NewWordListEntry:
      properties:
        enabled:
          type: boolean
        name:
          type: string
        words:
          items:
            type: string
          type: array
      required:
        - name
        - words
        - enabled
      type: object
    dlp_Pattern:
      properties:
        regex:
          type: string
        validation:
          allOf:
            - $ref: '#/components/schemas/dlp_Validation'
      required:
        - regex
      type: object
    dlp_PayloadLogSetting:
      properties:
        public_key:
          nullable: true
          type: string
        updated_at:
          format: date-time
          type: string
      required:
        - updated_at
      type: object
    dlp_PayloadLogSettingUpdate:
      properties:
        public_key:
          nullable: true
          type: string
      type: object
    dlp_PredefinedEntry:
      properties:
        enabled:
          type: boolean
        id:
          format: uuid
          type: string
        name:
          type: string
        profile_id:
          format: uuid
          nullable: true
          type: string
      required:
        - id
        - name
        - enabled
      type: object
    dlp_PredefinedEntryUpdate:
      properties:
        enabled:
          type: boolean
        id:
          format: uuid
          type: string
      required:
        - id
        - enabled
      type: object
    dlp_PredefinedProfile:
      properties:
        allowed_match_count:
          format: int32
          type: integer
        context_awareness:
          $ref: '#/components/schemas/dlp_ContextAwareness'
        entries:
          items:
            $ref: '#/components/schemas/dlp_Entry'
          type: array
        id:
          description: The id of the predefined profile (uuid)
          format: uuid
          type: string
        name:
          description: The name of the predefined profile
          type: string
        ocr_enabled:
          type: boolean
        open_access:
          description: Whether this profile can be accessed by anyone
          type: boolean
      required:
        - id
        - name
        - entries
        - allowed_match_count
      type: object
    dlp_PredefinedProfileUpdate:
      properties:
        allowed_match_count:
          format: int32
          nullable: true
          type: integer
        context_awareness:
          $ref: '#/components/schemas/dlp_ContextAwareness'
        entries:
          items:
            $ref: '#/components/schemas/dlp_PredefinedEntryUpdate'
          type: array
        ocr_enabled:
          type: boolean
      required:
        - entries
      type: object
    dlp_Profile:
      discriminator:
        propertyName: type
      oneOf:
        - allOf:
            - $ref: '#/components/schemas/dlp_CustomProfile'
            - properties:
                type:
                  enum:
                    - custom
                  type: string
              required:
                - type
              type: object
          title: Custom Profile
        - allOf:
            - $ref: '#/components/schemas/dlp_PredefinedProfile'
            - properties:
                type:
                  enum:
                    - predefined
                  type: string
              required:
                - type
              type: object
          title: Predefined Profile
        - allOf:
            - $ref: '#/components/schemas/dlp_IntegrationProfile'
            - properties:
                type:
                  enum:
                    - integration
                  type: string
              required:
                - type
              type: object
          title: Integration Profile
    dlp_ProfileArray:
      items:
        $ref: '#/components/schemas/dlp_Profile'
      type: array
    dlp_RegexValidationQuery:
      properties:
        max_match_bytes:
          description: |-
            Maximum number of bytes that the regular expression can match.

            If this is `null` then there is no limit on the length. Patterns can use
            `*` and `+`. Otherwise repeats should use a range `{m,n}` to restrict
            patterns to the length. If this field is missing, then a default length
            limit is used.

            Note that the length is specified in bytes. Since regular expressions
            use UTF-8 the pattern `.` can match up to 4 bytes. Hence `.{1,256}`
            has a maximum length of 1024 bytes.
          format: int32
          minimum: 0
          nullable: true
          type: integer
        regex:
          type: string
      required:
        - regex
      type: object
    dlp_RegexValidationResult:
      properties:
        valid:
          type: boolean
      required:
        - valid
      type: object
    dlp_RiskEvent:
      properties:
        event_details: {}
        id:
          type: string
        name:
          type: string
        risk_level:
          $ref: '#/components/schemas/dlp_RiskLevel'
        timestamp:
          format: date-time
          type: string
      required:
        - id
        - risk_level
        - name
        - timestamp
      type: object
    dlp_RiskEvents:
      properties:
        email:
          type: string
        events:
          items:
            $ref: '#/components/schemas/dlp_RiskEvent'
          type: array
        last_reset_time:
          format: date-time
          nullable: true
          type: string
        name:
          type: string
        risk_level:
          allOf:
            - $ref: '#/components/schemas/dlp_RiskLevel'
      required:
        - name
        - email
        - events
      type: object
    dlp_RiskLevel:
      enum:
        - low
        - medium
        - high
      type: string
    dlp_RiskScoreIntegration:
      properties:
        account_tag:
          description: The Cloudflare account tag.
          type: string
        active:
          description: Whether this integration is enabled and should export changes in risk score.
          type: boolean
        created_at:
          description: When the integration was created in RFC3339 format.
          format: date-time
          type: string
        id:
          description: The id of the integration, a UUIDv4.
          format: uuid
          type: string
        integration_type:
          $ref: '#/components/schemas/dlp_RiskScoreIntegrationType'
        reference_id:
          description: |-
            A reference ID defined by the client.
            Should be set to the Access-Okta IDP integration ID.
            Useful when the risk-score integration needs to be associated with a secondary asset and recalled using that ID.
          type: string
        tenant_url:
          description: The base URL for the tenant. E.g. "https://tenant.okta.com"
          type: string
        well_known_url:
          description: The URL for the Shared Signals Framework configuration, e.g. "/.well-known/sse-configuration/{integration_uuid}/". https://openid.net/specs/openid-sse-framework-1_0.html#rfc.section.6.2.1
          type: string
      required:
        - id
        - account_tag
        - integration_type
        - reference_id
        - tenant_url
        - well_known_url
        - active
        - created_at
      type: object
    dlp_RiskScoreIntegrationArray:
      items:
        $ref: '#/components/schemas/dlp_RiskScoreIntegration'
      type: array
    dlp_RiskScoreIntegrationType:
      enum:
        - Okta
      type: string
    dlp_RiskSummary:
      properties:
        users:
          items:
            $ref: '#/components/schemas/dlp_UserRiskInfo'
          type: array
      required:
        - users
      type: object
    dlp_SharedEntryUpdate:
      discriminator:
        propertyName: entry_type
      oneOf:
        - properties:
            enabled:
              type: boolean
            entry_id:
              format: uuid
              type: string
            entry_type:
              enum:
                - predefined
              type: string
          required:
            - entry_id
            - enabled
            - entry_type
          type: object
        - properties:
            enabled:
              type: boolean
            entry_id:
              format: uuid
              type: string
            entry_type:
              enum:
                - integration
              type: string
          required:
            - entry_id
            - enabled
            - entry_type
          type: object
        - properties:
            enabled:
              type: boolean
            entry_id:
              format: uuid
              type: string
            entry_type:
              enum:
                - exact_data
              type: string
          required:
            - entry_id
            - enabled
            - entry_type
          type: object
    dlp_SkipConfig:
      description: Content types to exclude from context analysis and return all matches.
      properties:
        files:
          description: If the content type is a file, skip context analysis and return all matches.
          type: boolean
      required:
        - files
      type: object
    dlp_UpdateBehavior:
      properties:
        enabled:
          type: boolean
        risk_level:
          $ref: '#/components/schemas/dlp_RiskLevel'
      required:
        - risk_level
        - enabled
      type: object
    dlp_UpdateBehaviors:
      properties:
        behaviors:
          additionalProperties:
            $ref: '#/components/schemas/dlp_UpdateBehavior'
          type: object
      required:
        - behaviors
      type: object
    dlp_UpdateIntegrationBody:
      properties:
        active:
          description: Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.
          type: boolean
        reference_id:
          description: |-
            A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4).
            https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
          nullable: true
          type: string
        tenant_url:
          description: The base url of the tenant, e.g. "https://tenant.okta.com"
          format: uri
          type: string
      required:
        - tenant_url
        - active
      type: object
    dlp_UserRiskInfo:
      properties:
        email:
          type: string
        event_count:
          minimum: 0
          type: integer
        last_event:
          format: date-time
          type: string
        max_risk_level:
          $ref: '#/components/schemas/dlp_RiskLevel'
        name:
          type: string
        user_id:
          format: uuid
          type: string
      required:
        - user_id
        - name
        - email
        - max_risk_level
        - event_count
        - last_event
      type: object
    dlp_Validation:
      enum:
        - luhn
      type: string
    dlp_WordListEntry:
      properties:
        created_at:
          format: date-time
          type: string
        enabled:
          type: boolean
        id:
          format: uuid
          type: string
        name:
          type: string
        profile_id:
          format: uuid
          nullable: true
          type: string
        updated_at:
          format: date-time
          type: string
        word_list: {}
      required:
        - id
        - name
        - created_at
        - updated_at
        - word_list
        - enabled
      type: object
    dlp_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/dlp_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/dlp_result_info'
      type: object
    dlp_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/dlp_messages'
        messages:
          $ref: '#/components/schemas/dlp_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    dlp_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/dlp_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/dlp_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    dlp_api-response-single:
      allOf:
        - $ref: '#/components/schemas/dlp_api-response-common'
      type: object
    dlp_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    dlp_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    dls_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/dls_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/dls_result_info'
      type: object
    dls_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/dls_messages'
        messages:
          $ref: '#/components/schemas/dls_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    dls_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/dls_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/dls_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    dls_hostname:
      description: DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g `*.example.com`
      example: foo.example.com
      type: string
    dls_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    dls_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    dls_region_key:
      description: Identifying key for the region
      example: ca
      type: string
    dls_regional_hostname_response:
      properties:
        created_on:
          allOf:
            - $ref: '#/components/schemas/dls_timestamp'
            - description: When the regional hostname was created
            - example: "2014-01-01T05:20:00.12345Z"
        hostname:
          $ref: '#/components/schemas/dls_hostname'
        region_key:
          $ref: '#/components/schemas/dls_region_key'
      required:
        - hostname
        - region_key
        - created_on
      type: object
    dls_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    dls_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      readOnly: true
      type: string
    dns-analytics_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/dns-analytics_messages'
        messages:
          $ref: '#/components/schemas/dns-analytics_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    dns-analytics_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/dns-analytics_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/dns-analytics_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    dns-analytics_api-response-single:
      allOf:
        - $ref: '#/components/schemas/dns-analytics_api-response-common'
      type: object
    dns-analytics_data:
      description: Array with one row per combination of dimension values.
      items:
        properties:
          dimensions:
            description: Array of dimension values, representing the combination of dimension values corresponding to this row.
            items:
              description: Dimension value.
              example: NODATA
              type: string
            type: array
        required:
          - dimensions
        type: object
      type: array
    dns-analytics_dimensions:
      description: A comma-separated list of dimensions to group results by.
      example: queryType
      type: string
    dns-analytics_filters:
      description: Segmentation filter in 'attribute operator value' format.
      example: responseCode==NOERROR,queryType==A
      type: string
    dns-analytics_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    dns-analytics_limit:
      default: 100000
      description: Limit number of returned metrics.
      example: 100
      type: integer
    dns-analytics_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    dns-analytics_metrics:
      description: A comma-separated list of metrics to query.
      example: queryCount,uncachedCount
      type: string
    dns-analytics_query:
      properties:
        dimensions:
          description: Array of dimension names.
          example:
            - responseCode
            - queryName
          items:
            description: Dimension name.
            example: responseCode
            type: string
          type: array
        filters:
          $ref: '#/components/schemas/dns-analytics_filters'
        limit:
          $ref: '#/components/schemas/dns-analytics_limit'
        metrics:
          description: Array of metric names.
          example:
            - queryCount
            - responseTimeAvg
          items:
            description: Metric name.
            example: queries
            type: string
          type: array
        since:
          $ref: '#/components/schemas/dns-analytics_since'
        sort:
          description: Array of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).
          example:
            - +responseCode
            - -queryName
          items:
            description: Dimension name (may be prefixed by - (descending) or + (ascending).
            example: +responseCode
            type: string
          type: array
        until:
          $ref: '#/components/schemas/dns-analytics_until'
      required:
        - dimensions
        - metrics
        - since
        - until
        - limit
      type: object
    dns-analytics_report:
      allOf:
        - $ref: '#/components/schemas/dns-analytics_result'
        - properties:
            data:
              items:
                properties:
                  metrics:
                    description: Array with one item per requested metric. Each item is a single value.
                    items:
                      description: Nominal metric value.
                      type: number
                    type: array
                required:
                  - metrics
          required:
            - data
    dns-analytics_report_bytime:
      allOf:
        - $ref: '#/components/schemas/dns-analytics_result'
        - properties:
            data:
              items:
                properties:
                  metrics:
                    description: Array with one item per requested metric. Each item is an array of values, broken down by time interval.
                    items:
                      description: Nominal metric values, broken down by time interval.
                      items: {}
                      properties:
                        items:
                          description: Nominal metric value.
                          type: number
                      type: array
                    type: array
                required:
                  - metrics
            query:
              properties:
                time_delta:
                  $ref: '#/components/schemas/dns-analytics_time_delta'
              required:
                - time_delta
              type: object
            time_intervals:
              description: |
                Array of time intervals in the response data. Each interval is represented as an array containing two values: the start time, and the end time.
              items:
                description: Array with exactly two items, representing the start and end time (respectively) of this time interval.
                items:
                  description: Time value.
                  example: "2023-11-11T12:00:00Z"
                  format: date-time
                  type: string
                type: array
              type: array
          required:
            - time_intervals
            - query
            - data
    dns-analytics_result:
      properties:
        data:
          $ref: '#/components/schemas/dns-analytics_data'
        data_lag:
          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
          type: number
        max:
          description: Maximum results for each metric (object mapping metric names to values). Currently always an empty object.
          type: object
        min:
          description: Minimum results for each metric (object mapping metric names to values). Currently always an empty object.
          type: object
        query:
          $ref: '#/components/schemas/dns-analytics_query'
        rows:
          description: Total number of rows in the result.
          example: 100
          minimum: 0
          type: number
        totals:
          description: Total results for metrics across all data (object mapping metric names to values).
          type: object
      required:
        - rows
        - totals
        - min
        - max
        - data_lag
        - query
        - data
      type: object
    dns-analytics_since:
      description: Start date and time of requesting data period in ISO 8601 format.
      example: "2023-11-11T12:00:00Z"
      format: date-time
      type: string
    dns-analytics_sort:
      description: A comma-separated list of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).
      example: +responseCode,-queryName
      type: string
    dns-analytics_time_delta:
      description: Unit of time to group data by.
      enum:
        - all
        - auto
        - year
        - quarter
        - month
        - week
        - day
        - hour
        - dekaminute
        - minute
      example: hour
      type: string
    dns-analytics_until:
      description: End date and time of requesting data period in ISO 8601 format.
      example: "2023-11-11T13:00:00Z"
      format: date-time
      type: string
    dns-custom-nameservers_CustomNS:
      description: A single account custom nameserver.
      properties:
        dns_records:
          description: A and AAAA records associated with the nameserver.
          items:
            properties:
              type:
                description: DNS record type.
                enum:
                  - A
                  - AAAA
                example: A
                type: string
              value:
                description: DNS record contents (an IPv4 or IPv6 address).
                example: 1.1.1.1
                type: string
          type: array
        ns_name:
          $ref: '#/components/schemas/dns-custom-nameservers_ns_name'
        ns_set:
          $ref: '#/components/schemas/dns-custom-nameservers_ns_set'
        status:
          deprecated: true
          description: Verification status of the nameserver.
          enum:
            - moved
            - pending
            - verified
          example: verified
          type: string
        zone_tag:
          $ref: '#/components/schemas/dns-custom-nameservers_schemas-identifier'
      required:
        - dns_records
        - ns_name
        - status
        - zone_tag
      title: Custom NS
      type: object
    dns-custom-nameservers_CustomNSInput:
      properties:
        ns_name:
          $ref: '#/components/schemas/dns-custom-nameservers_ns_name'
        ns_set:
          $ref: '#/components/schemas/dns-custom-nameservers_ns_set'
      required:
        - ns_name
      title: Custom NS Input
    dns-custom-nameservers_acns_response_collection:
      allOf:
        - $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/dns-custom-nameservers_CustomNS'
              type: array
          type: object
    dns-custom-nameservers_acns_response_single:
      allOf:
        - $ref: '#/components/schemas/dns-custom-nameservers_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/dns-custom-nameservers_CustomNS'
          type: object
    dns-custom-nameservers_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/dns-custom-nameservers_result_info'
      type: object
    dns-custom-nameservers_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/dns-custom-nameservers_messages'
        messages:
          $ref: '#/components/schemas/dns-custom-nameservers_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    dns-custom-nameservers_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/dns-custom-nameservers_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/dns-custom-nameservers_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    dns-custom-nameservers_api-response-single:
      allOf:
        - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common'
      type: object
    dns-custom-nameservers_availability_response:
      allOf:
        - $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
        - properties:
            result:
              items:
                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
                format: hostname
                readOnly: true
                type: string
              type: array
          type: object
    dns-custom-nameservers_empty_response:
      allOf:
        - $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
        - properties:
            result:
              items:
                description: Unused
                type: string
              maxItems: 0
              type: array
          type: object
    dns-custom-nameservers_get_response:
      allOf:
        - $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
        - $ref: '#/components/schemas/dns-custom-nameservers_zone_metadata'
    dns-custom-nameservers_identifier:
      description: Account identifier tag.
      example: 372e67954025e0ba6aaa6d586b9e0b59
      maxLength: 32
      readOnly: true
      type: string
    dns-custom-nameservers_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    dns-custom-nameservers_ns_name:
      description: The FQDN of the name server.
      example: ns1.example.com
      format: hostname
      type: string
    dns-custom-nameservers_ns_set:
      default: 1
      description: The number of the set that this name server belongs to.
      example: 1
      maximum: 5
      minimum: 1
      type: number
    dns-custom-nameservers_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    dns-custom-nameservers_schemas-empty_response:
      allOf:
        - $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
        - properties:
            result:
              items:
                description: Unused
                type: string
              maxItems: 0
              type: array
          type: object
    dns-custom-nameservers_schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    dns-custom-nameservers_zone_metadata:
      properties:
        enabled:
          description: Whether zone uses account-level custom nameservers.
          example: true
          type: boolean
        ns_set:
          default: 1
          description: The number of the name server set to assign to the zone.
          example: 1
          maximum: 5
          minimum: 1
          type: number
      type: object
    dns-firewall_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/dns-firewall_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/dns-firewall_result_info'
      type: object
    dns-firewall_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/dns-firewall_messages'
        messages:
          $ref: '#/components/schemas/dns-firewall_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    dns-firewall_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/dns-firewall_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/dns-firewall_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    dns-firewall_api-response-single:
      allOf:
        - $ref: '#/components/schemas/dns-firewall_api-response-common'
      type: object
    dns-firewall_attack_mitigation:
      description: Attack mitigation settings
      nullable: true
      properties:
        enabled:
          description: When enabled, automatically mitigate random-prefix attacks to protect upstream DNS servers
          example: true
          type: boolean
        only_when_upstream_unhealthy:
          default: true
          description: Only mitigate attacks when upstream servers seem unhealthy
          example: false
          type: boolean
      type: object
    dns-firewall_deprecate_any_requests:
      description: Whether to refuse to answer queries for the ANY type
      example: true
      type: boolean
    dns-firewall_dns-firewall-cluster:
      properties:
        attack_mitigation:
          $ref: '#/components/schemas/dns-firewall_attack_mitigation'
        deprecate_any_requests:
          $ref: '#/components/schemas/dns-firewall_deprecate_any_requests'
        ecs_fallback:
          $ref: '#/components/schemas/dns-firewall_ecs_fallback'
        maximum_cache_ttl:
          $ref: '#/components/schemas/dns-firewall_maximum_cache_ttl'
        minimum_cache_ttl:
          $ref: '#/components/schemas/dns-firewall_minimum_cache_ttl'
        name:
          $ref: '#/components/schemas/dns-firewall_name'
        negative_cache_ttl:
          $ref: '#/components/schemas/dns-firewall_negative_cache_ttl'
        ratelimit:
          $ref: '#/components/schemas/dns-firewall_ratelimit'
        retries:
          $ref: '#/components/schemas/dns-firewall_retries'
        upstream_ips:
          $ref: '#/components/schemas/dns-firewall_upstream_ips'
      type: object
    dns-firewall_dns-firewall-cluster-patch:
      allOf:
        - $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster'
      type: object
    dns-firewall_dns-firewall-cluster-post:
      allOf:
        - $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster'
      required:
        - name
        - upstream_ips
      type: object
    dns-firewall_dns-firewall-cluster-response:
      allOf:
        - $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster'
        - properties:
            dns_firewall_ips:
              $ref: '#/components/schemas/dns-firewall_dns_firewall_ips'
            id:
              $ref: '#/components/schemas/dns-firewall_identifier'
            modified_on:
              $ref: '#/components/schemas/dns-firewall_modified_on'
          required:
            - id
            - dns_firewall_ips
            - modified_on
          type: object
      required:
        - name
        - upstream_ips
        - minimum_cache_ttl
        - maximum_cache_ttl
        - negative_cache_ttl
        - deprecate_any_requests
        - ecs_fallback
        - ratelimit
        - retries
      type: object
    dns-firewall_dns-firewall-reverse-dns:
      properties:
        ptr:
          additionalProperties:
            description: PTR record content
            type: string
          description: Map of cluster IP addresses to PTR record contents
          type: object
      type: object
    dns-firewall_dns-firewall-reverse-dns-patch:
      allOf:
        - $ref: '#/components/schemas/dns-firewall_dns-firewall-reverse-dns'
      type: object
    dns-firewall_dns-firewall-reverse-dns-response:
      allOf:
        - $ref: '#/components/schemas/dns-firewall_dns-firewall-reverse-dns'
      required:
        - ptr
      type: object
    dns-firewall_dns_firewall_ips:
      example:
        - 203.0.113.1
        - 203.0.113.254
        - 2001:DB8:AB::CF
        - 2001:DB8:CD::CF
      items:
        anyOf:
          - description: Cloudflare-assigned DNS IPv4 address
            example: 203.0.113.1
            format: ipv4
            type: string
          - description: Cloudflare-assigned DNS IPv6 address
            example: 2001:DB8:ab::CF
            format: ipv6
            type: string
      type: array
    dns-firewall_dns_firewall_response_collection:
      allOf:
        - $ref: '#/components/schemas/dns-firewall_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster-response'
              type: array
    dns-firewall_dns_firewall_reverse_dns_response:
      allOf:
        - $ref: '#/components/schemas/dns-firewall_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/dns-firewall_dns-firewall-reverse-dns-response'
    dns-firewall_dns_firewall_single_response:
      allOf:
        - $ref: '#/components/schemas/dns-firewall_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster-response'
    dns-firewall_ecs_fallback:
      description: Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent
      example: false
      type: boolean
    dns-firewall_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    dns-firewall_maximum_cache_ttl:
      default: 900
      description: Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes of caching between DNS Firewall and the upstream servers. Higher TTLs will be decreased to the maximum defined here for caching purposes.
      example: 900
      maximum: 36000
      minimum: 30
      type: number
    dns-firewall_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    dns-firewall_minimum_cache_ttl:
      default: 60
      description: Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes of caching between DNS Firewall and the upstream servers. Lower TTLs will be increased to the minimum defined here for caching purposes.
      example: 60
      maximum: 36000
      minimum: 30
      type: number
    dns-firewall_modified_on:
      description: Last modification of DNS Firewall cluster
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      type: string
    dns-firewall_name:
      description: DNS Firewall cluster name
      example: My Awesome DNS Firewall cluster
      maxLength: 160
      minLength: 1
      type: string
    dns-firewall_negative_cache_ttl:
      description: Negative DNS cache TTL This setting controls how long DNS Firewall should cache negative responses (e.g., NXDOMAIN) from the upstream servers.
      example: 900
      maximum: 36000
      minimum: 30
      nullable: true
      type: number
    dns-firewall_ratelimit:
      description: Ratelimit in queries per second per datacenter (applies to DNS queries sent to the upstream nameservers configured on the cluster)
      example: 600
      maximum: 1e+09
      minimum: 100
      nullable: true
      type: number
    dns-firewall_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    dns-firewall_retries:
      default: 2
      description: Number of retries for fetching DNS responses from upstream nameservers (not counting the initial attempt)
      example: 2
      maximum: 2
      minimum: 0
      type: number
    dns-firewall_upstream_ips:
      example:
        - 192.0.2.1
        - 198.51.100.1
        - 2001:DB8:100::CF
      items:
        anyOf:
          - description: Upstream DNS Server IPv4 address
            example: 192.0.2.1
            format: ipv4
            type: string
          - description: Upstream DNS Server IPv6 address
            example: 2001:DB8:100::CF
            format: ipv6
            type: string
      minLength: 1
      type: array
    dns-records_AAAARecord:
      properties:
        content:
          description: A valid IPv6 address.
          example: 2400:cb00:2049::1
          format: ipv6
          type: string
        type:
          description: Record type.
          enum:
            - AAAA
          example: AAAA
          type: string
      title: AAAA Record
      type: object
    dns-records_ARecord:
      properties:
        content:
          description: A valid IPv4 address.
          example: 198.51.100.4
          format: ipv4
          type: string
        type:
          description: Record type.
          enum:
            - A
          example: A
          type: string
      title: A Record
      type: object
    dns-records_CAARecord:
      properties:
        content:
          description: Formatted CAA content. See 'data' to set CAA properties.
          readOnly: true
          type: string
        data:
          description: Components of a CAA record.
          properties:
            flags:
              description: Flags for the CAA record.
              example: 1
              maximum: 255
              minimum: 0
              type: number
            tag:
              description: 'Name of the property controlled by this record (e.g.: issue, issuewild, iodef).'
              example: issue
              type: string
            value:
              description: Value of the record. This field's semantics depend on the chosen tag.
              type: string
          type: object
        type:
          description: Record type.
          enum:
            - CAA
          example: CAA
          type: string
      title: CAA Record
      type: object
    dns-records_CERTRecord:
      properties:
        content:
          description: Formatted CERT content. See 'data' to set CERT properties.
          readOnly: true
          type: string
        data:
          description: Components of a CERT record.
          properties:
            algorithm:
              description: Algorithm.
              example: 8
              maximum: 255
              minimum: 0
              type: number
            certificate:
              description: Certificate.
              type: string
            key_tag:
              description: Key Tag.
              example: 1
              maximum: 65535
              minimum: 0
              type: number
            type:
              description: Type.
              example: 9
              maximum: 65535
              minimum: 0
              type: number
          type: object
        type:
          description: Record type.
          enum:
            - CERT
          example: CERT
          type: string
      title: CERT Record
      type: object
    dns-records_CNAMERecord:
      properties:
        content:
          description: A valid hostname. Must not match the record's name.
          type: string
        type:
          description: Record type.
          enum:
            - CNAME
          example: CNAME
          type: string
      title: CNAME Record
      type: object
    dns-records_DNSKEYRecord:
      properties:
        content:
          description: Formatted DNSKEY content. See 'data' to set DNSKEY properties.
          readOnly: true
          type: string
        data:
          description: Components of a DNSKEY record.
          properties:
            algorithm:
              description: Algorithm.
              example: 5
              maximum: 255
              minimum: 0
              type: number
            flags:
              description: Flags.
              example: 1
              maximum: 65535
              minimum: 0
              type: number
            protocol:
              description: Protocol.
              example: 3
              maximum: 255
              minimum: 0
              type: number
            public_key:
              description: Public Key.
              type: string
          type: object
        type:
          description: Record type.
          enum:
            - DNSKEY
          example: DNSKEY
          type: string
      title: DNSKEY Record
      type: object
    dns-records_DSRecord:
      properties:
        content:
          description: Formatted DS content. See 'data' to set DS properties.
          readOnly: true
          type: string
        data:
          description: Components of a DS record.
          properties:
            algorithm:
              description: Algorithm.
              example: 3
              maximum: 255
              minimum: 0
              type: number
            digest:
              description: Digest.
              type: string
            digest_type:
              description: Digest Type.
              example: 1
              maximum: 255
              minimum: 0
              type: number
            key_tag:
              description: Key Tag.
              example: 1
              maximum: 65535
              minimum: 0
              type: number
          type: object
        type:
          description: Record type.
          enum:
            - DS
          example: DS
          type: string
      title: DS Record
      type: object
    dns-records_HTTPSRecord:
      properties:
        content:
          description: Formatted HTTPS content. See 'data' to set HTTPS properties.
          readOnly: true
          type: string
        data:
          description: Components of a HTTPS record.
          properties:
            priority:
              description: priority.
              example: 1
              maximum: 65535
              minimum: 0
              type: number
            target:
              description: target.
              example: .
              type: string
            value:
              description: value.
              example: alpn="h3,h2" ipv4hint="127.0.0.1" ipv6hint="::1"
              type: string
          type: object
        type:
          description: Record type.
          enum:
            - HTTPS
          example: HTTPS
          type: string
      title: HTTPS Record
      type: object
    dns-records_LOCRecord:
      properties:
        content:
          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
          type: string
        data:
          description: Components of a LOC record.
          properties:
            altitude:
              description: Altitude of location in meters.
              example: 0
              maximum: 4.284967295e+07
              minimum: -100000
              type: number
            lat_degrees:
              description: Degrees of latitude.
              example: 37
              maximum: 90
              minimum: 0
              type: number
            lat_direction:
              description: Latitude direction.
              enum:
                - "N"
                - S
              example: "N"
            lat_minutes:
              default: 0
              description: Minutes of latitude.
              example: 46
              maximum: 59
              minimum: 0
              type: number
            lat_seconds:
              default: 0
              description: Seconds of latitude.
              example: 46
              maximum: 59.999
              minimum: 0
              type: number
            long_degrees:
              description: Degrees of longitude.
              example: 122
              maximum: 180
              minimum: 0
              type: number
            long_direction:
              description: Longitude direction.
              enum:
                - E
                - W
              example: W
            long_minutes:
              default: 0
              description: Minutes of longitude.
              example: 23
              maximum: 59
              minimum: 0
              type: number
            long_seconds:
              default: 0
              description: Seconds of longitude.
              example: 35
              maximum: 59.999
              minimum: 0
              type: number
            precision_horz:
              default: 0
              description: Horizontal precision of location.
              example: 0
              maximum: 9e+07
              minimum: 0
              type: number
            precision_vert:
              default: 0
              description: Vertical precision of location.
              example: 0
              maximum: 9e+07
              minimum: 0
              type: number
            size:
              default: 0
              description: Size of location in meters.
              example: 100
              maximum: 9e+07
              minimum: 0
              type: number
          type: object
        type:
          description: Record type.
          enum:
            - LOC
          example: LOC
          type: string
      title: LOC Record
      type: object
    dns-records_MXRecord:
      properties:
        content:
          description: A valid mail server hostname.
          example: mx.example.com
          format: hostname
          type: string
        priority:
          $ref: '#/components/schemas/dns-records_priority'
        type:
          description: Record type.
          enum:
            - MX
          example: MX
          type: string
      title: MX Record
      type: object
    dns-records_NAPTRRecord:
      properties:
        content:
          description: Formatted NAPTR content. See 'data' to set NAPTR properties.
          readOnly: true
          type: string
        data:
          description: Components of a NAPTR record.
          properties:
            flags:
              description: Flags.
              type: string
            order:
              description: Order.
              example: 100
              maximum: 65535
              minimum: 0
              type: number
            preference:
              description: Preference.
              example: 10
              maximum: 65535
              minimum: 0
              type: number
            regex:
              description: Regex.
              type: string
            replacement:
              description: Replacement.
              type: string
            service:
              description: Service.
              type: string
          type: object
        type:
          description: Record type.
          enum:
            - NAPTR
          example: NAPTR
          type: string
      title: NAPTR Record
      type: object
    dns-records_NSRecord:
      properties:
        content:
          description: A valid name server host name.
          example: ns1.example.com
          type: string
        type:
          description: Record type.
          enum:
            - NS
          example: NS
          type: string
      title: NS Record
      type: object
    dns-records_OPENPGPKEYRecord:
      properties:
        content:
          description: A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)
          type: string
        type:
          description: Record type.
          enum:
            - OPENPGPKEY
          example: OPENPGPKEY
          type: string
      title: OPENPGPKEY Record
      type: object
    dns-records_PTRRecord:
      properties:
        content:
          description: Domain name pointing to the address.
          example: example.com
          type: string
        type:
          description: Record type.
          enum:
            - PTR
          example: PTR
          type: string
      title: PTR Record
      type: object
    dns-records_SMIMEARecord:
      properties:
        content:
          description: Formatted SMIMEA content. See 'data' to set SMIMEA properties.
          readOnly: true
          type: string
        data:
          description: Components of a SMIMEA record.
          properties:
            certificate:
              description: Certificate.
              type: string
            matching_type:
              description: Matching Type.
              example: 0
              maximum: 255
              minimum: 0
              type: number
            selector:
              description: Selector.
              example: 0
              maximum: 255
              minimum: 0
              type: number
            usage:
              description: Usage.
              example: 3
              maximum: 255
              minimum: 0
              type: number
          type: object
        type:
          description: Record type.
          enum:
            - SMIMEA
          example: SMIMEA
          type: string
      title: SMIMEA Record
      type: object
    dns-records_SRVRecord:
      properties:
        content:
          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
          type: string
        data:
          description: Components of a SRV record.
          properties:
            port:
              description: The port of the service.
              example: 8806
              maximum: 65535
              minimum: 0
              type: number
            priority:
              $ref: '#/components/schemas/dns-records_priority'
            target:
              description: A valid hostname.
              example: example.com
              format: hostname
              type: string
            weight:
              description: The record weight.
              example: 5
              maximum: 65535
              minimum: 0
              type: number
          type: object
        type:
          description: Record type.
          enum:
            - SRV
          example: SRV
          type: string
      title: SRV Record
      type: object
    dns-records_SSHFPRecord:
      properties:
        content:
          description: Formatted SSHFP content. See 'data' to set SSHFP properties.
          readOnly: true
          type: string
        data:
          description: Components of a SSHFP record.
          properties:
            algorithm:
              description: algorithm.
              example: 2
              maximum: 255
              minimum: 0
              type: number
            fingerprint:
              description: fingerprint.
              type: string
            type:
              description: type.
              example: 1
              maximum: 255
              minimum: 0
              type: number
          type: object
        type:
          description: Record type.
          enum:
            - SSHFP
          example: SSHFP
          type: string
      title: SSHFP Record
      type: object
    dns-records_SVCBRecord:
      properties:
        content:
          description: Formatted SVCB content. See 'data' to set SVCB properties.
          readOnly: true
          type: string
        data:
          description: Components of a SVCB record.
          properties:
            priority:
              description: priority.
              example: 1
              maximum: 65535
              minimum: 0
              type: number
            target:
              description: target.
              example: .
              type: string
            value:
              description: value.
              example: alpn="h3,h2" ipv4hint="127.0.0.1" ipv6hint="::1"
              type: string
          type: object
        type:
          description: Record type.
          enum:
            - SVCB
          example: SVCB
          type: string
      title: SVCB Record
      type: object
    dns-records_TLSARecord:
      properties:
        content:
          description: Formatted TLSA content. See 'data' to set TLSA properties.
          readOnly: true
          type: string
        data:
          description: Components of a TLSA record.
          properties:
            certificate:
              description: certificate.
              type: string
            matching_type:
              description: Matching Type.
              example: 1
              maximum: 255
              minimum: 0
              type: number
            selector:
              description: Selector.
              example: 0
              maximum: 255
              minimum: 0
              type: number
            usage:
              description: Usage.
              example: 0
              maximum: 255
              minimum: 0
              type: number
          type: object
        type:
          description: Record type.
          enum:
            - TLSA
          example: TLSA
          type: string
      title: TLSA Record
      type: object
    dns-records_TXTRecord:
      properties:
        content:
          description: Text content for the record.
          example: example text content
          type: string
        type:
          description: Record type.
          enum:
            - TXT
          example: TXT
          type: string
      title: TXT Record
      type: object
    dns-records_URIRecord:
      properties:
        content:
          description: Formatted URI content. See 'data' to set URI properties.
          readOnly: true
          type: string
        data:
          description: Components of a URI record.
          properties:
            target:
              description: The record content.
              example: http://example.com/example.html
              type: string
            weight:
              description: The record weight.
              example: 20
              maximum: 65535
              minimum: 0
              type: number
          type: object
        priority:
          $ref: '#/components/schemas/dns-records_priority'
        type:
          description: Record type.
          enum:
            - URI
          example: URI
          type: string
      title: URI Record
      type: object
    dns-records_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/dns-records_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/dns-records_result_info'
      type: object
    dns-records_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/dns-records_messages'
        messages:
          $ref: '#/components/schemas/dns-records_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    dns-records_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/dns-records_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/dns-records_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    dns-records_api-response-single:
      allOf:
        - $ref: '#/components/schemas/dns-records_api-response-common'
      type: object
    dns-records_comment:
      description: Comments or notes about the DNS record. This field has no effect on DNS responses.
      example: Domain verification record
      type: string
    dns-records_content:
      description: DNS record content.
      example: 127.0.0.1
      type: string
    dns-records_direction:
      default: asc
      description: Direction to order DNS records in.
      enum:
        - asc
        - desc
      type: string
    dns-records_dns-record:
      allOf:
        - properties:
            comment:
              $ref: '#/components/schemas/dns-records_comment'
            name:
              $ref: '#/components/schemas/dns-records_name'
            proxied:
              $ref: '#/components/schemas/dns-records_proxied'
            settings:
              $ref: '#/components/schemas/dns-records_settings'
            tags:
              $ref: '#/components/schemas/dns-records_tags'
            ttl:
              $ref: '#/components/schemas/dns-records_ttl'
          type: object
        - oneOf:
            - $ref: '#/components/schemas/dns-records_ARecord'
            - $ref: '#/components/schemas/dns-records_AAAARecord'
            - $ref: '#/components/schemas/dns-records_CAARecord'
            - $ref: '#/components/schemas/dns-records_CERTRecord'
            - $ref: '#/components/schemas/dns-records_CNAMERecord'
            - $ref: '#/components/schemas/dns-records_DNSKEYRecord'
            - $ref: '#/components/schemas/dns-records_DSRecord'
            - $ref: '#/components/schemas/dns-records_HTTPSRecord'
            - $ref: '#/components/schemas/dns-records_LOCRecord'
            - $ref: '#/components/schemas/dns-records_MXRecord'
            - $ref: '#/components/schemas/dns-records_NAPTRRecord'
            - $ref: '#/components/schemas/dns-records_NSRecord'
            - $ref: '#/components/schemas/dns-records_OPENPGPKEYRecord'
            - $ref: '#/components/schemas/dns-records_PTRRecord'
            - $ref: '#/components/schemas/dns-records_SMIMEARecord'
            - $ref: '#/components/schemas/dns-records_SRVRecord'
            - $ref: '#/components/schemas/dns-records_SSHFPRecord'
            - $ref: '#/components/schemas/dns-records_SVCBRecord'
            - $ref: '#/components/schemas/dns-records_TLSARecord'
            - $ref: '#/components/schemas/dns-records_TXTRecord'
            - $ref: '#/components/schemas/dns-records_URIRecord'
          type: object
      type: object
    dns-records_dns-record-patch:
      allOf:
        - $ref: '#/components/schemas/dns-records_dns-record'
      type: object
    dns-records_dns-record-post:
      allOf:
        - $ref: '#/components/schemas/dns-records_dns-record'
      required:
        - name
        - type
        - content
        - data
      type: object
    dns-records_dns-record-response:
      allOf:
        - $ref: '#/components/schemas/dns-records_dns-record'
        - properties:
            comment_modified_on:
              description: When the record comment was last modified. Omitted if there is no comment.
              example: "2024-01-01T05:20:00.12345Z"
              format: date-time
              readOnly: true
              type: string
            created_on:
              description: When the record was created.
              example: "2014-01-01T05:20:00.12345Z"
              format: date-time
              readOnly: true
              type: string
            id:
              $ref: '#/components/schemas/dns-records_identifier'
            meta:
              description: Extra Cloudflare-specific information about the record.
              readOnly: true
              type: object
            modified_on:
              description: When the record was last modified.
              example: "2014-01-01T05:20:00.12345Z"
              format: date-time
              readOnly: true
              type: string
            proxiable:
              description: Whether the record can be proxied by Cloudflare or not.
              example: true
              type: boolean
            tags_modified_on:
              description: When the record tags were last modified. Omitted if there are no tags.
              example: "2025-01-01T05:20:00.12345Z"
              format: date-time
              readOnly: true
              type: string
          required:
            - id
            - proxiable
            - created_on
            - modified_on
            - meta
          type: object
      required:
        - name
        - type
        - content
        - data
        - proxied
        - ttl
        - settings
        - comment
        - tags
      type: object
    dns-records_dns_response_collection:
      allOf:
        - $ref: '#/components/schemas/dns-records_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/dns-records_dns-record-response'
              type: array
          type: object
    dns-records_dns_response_import_scan:
      allOf:
        - $ref: '#/components/schemas/dns-records_api-response-single'
        - properties:
            result:
              properties:
                recs_added:
                  description: Number of DNS records added.
                  example: 5
                  type: number
                total_records_parsed:
                  description: Total number of DNS records parsed.
                  example: 5
                  type: number
              type: object
            timing:
              properties:
                end_time:
                  description: When the file parsing ended.
                  example: "2014-03-01T12:20:01Z"
                  format: date-time
                  type: string
                process_time:
                  description: Processing time of the file in seconds.
                  example: 1
                  type: number
                start_time:
                  description: When the file parsing started.
                  example: "2014-03-01T12:20:00Z"
                  format: date-time
                  type: string
              type: object
          type: object
    dns-records_dns_response_single:
      allOf:
        - $ref: '#/components/schemas/dns-records_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/dns-records_dns-record-response'
          type: object
    dns-records_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    dns-records_match:
      default: all
      description: |
        Whether to match all search requirements or at least one (any). If set to `all`, acts like a logical AND between filters. If set to `any`, acts like a logical OR instead. Note that the interaction between tag filters is controlled by the `tag-match` parameter instead.
      enum:
        - any
        - all
      example: any
      type: string
    dns-records_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    dns-records_name:
      description: DNS record name (or @ for the zone apex) in Punycode.
      example: example.com
      maxLength: 255
      minLength: 1
      type: string
    dns-records_order:
      default: type
      description: Field to order DNS records by.
      enum:
        - type
        - name
        - content
        - ttl
        - proxied
      type: string
    dns-records_page:
      default: 1
      description: Page number of paginated results.
      minimum: 1
      type: number
    dns-records_per_page:
      default: 100
      description: Number of DNS records per page.
      example: 5
      maximum: 5e+06
      minimum: 1
      type: number
    dns-records_priority:
      description: Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
      example: 10
      maximum: 65535
      minimum: 0
      type: number
    dns-records_proxied:
      default: false
      description: Whether the record is receiving the performance and security benefits of Cloudflare.
      example: true
      type: boolean
    dns-records_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    dns-records_search:
      description: |
        Allows searching in multiple properties of a DNS record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future. This parameter works independently of the `match` setting. For automated searches, please use the other available parameters.
      example: www.cloudflare.com
      type: string
    dns-records_settings:
      description: Settings for the DNS record.
      type: object
    dns-records_tag_match:
      default: all
      description: |
        Whether to match all tag search requirements or at least one (any). If set to `all`, acts like a logical AND between tag filters. If set to `any`, acts like a logical OR instead. Note that the regular `match` parameter is still used to combine the resulting condition with other filters that aren't related to tags.
      enum:
        - any
        - all
      example: any
      type: string
    dns-records_tags:
      default: []
      description: Custom tags for the DNS record. This field has no effect on DNS responses.
      items:
        description: Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens)
        example: owner:dns-team
        type: string
      type: array
    dns-records_ttl:
      anyOf:
        - example: 3600
          maximum: 86400
          minimum: 30
          type: number
        - enum:
            - 1
          type: number
      default: 1
      description: Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.
      example: 3600
      type: number
    dns-records_type:
      description: Record type.
      enum:
        - A
        - AAAA
        - CAA
        - CERT
        - CNAME
        - DNSKEY
        - DS
        - HTTPS
        - LOC
        - MX
        - NAPTR
        - NS
        - OPENPGPKEY
        - PTR
        - SMIMEA
        - SRV
        - SSHFP
        - SVCB
        - TLSA
        - TXT
        - URI
      example: A
      type: string
    dns-settings_account_settings:
      properties:
        zone_defaults:
          $ref: '#/components/schemas/dns-settings_dns-settings'
      type: object
    dns-settings_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/dns-settings_messages'
        messages:
          $ref: '#/components/schemas/dns-settings_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    dns-settings_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/dns-settings_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/dns-settings_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    dns-settings_api-response-single:
      allOf:
        - $ref: '#/components/schemas/dns-settings_api-response-common'
      type: object
    dns-settings_dns-settings:
      properties:
        flatten_all_cnames:
          $ref: '#/components/schemas/dns-settings_flatten_all_cnames'
        foundation_dns:
          $ref: '#/components/schemas/dns-settings_foundation_dns'
        multi_provider:
          $ref: '#/components/schemas/dns-settings_multi_provider'
        nameservers:
          $ref: '#/components/schemas/dns-settings_nameservers'
        ns_ttl:
          $ref: '#/components/schemas/dns-settings_ns_ttl'
        secondary_overrides:
          $ref: '#/components/schemas/dns-settings_secondary_overrides'
        soa:
          $ref: '#/components/schemas/dns-settings_soa'
        zone_mode:
          $ref: '#/components/schemas/dns-settings_zone_mode'
      type: object
    dns-settings_dns_response_single:
      allOf:
        - $ref: '#/components/schemas/dns-settings_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/dns-settings_account_settings'
          type: object
    dns-settings_flatten_all_cnames:
      description: Whether to flatten all CNAME records in the zone. Note that, due to DNS limitations, a CNAME record at the zone apex will always be flattened.
      example: false
      type: boolean
    dns-settings_foundation_dns:
      description: Whether to enable Foundation DNS Advanced Nameservers on the zone.
      example: false
      type: boolean
    dns-settings_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    dns-settings_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    dns-settings_multi_provider:
      description: Whether to enable multi-provider DNS, which causes Cloudflare to activate the zone even when non-Cloudflare NS records exist, and to respect NS records at the zone apex during outbound zone transfers.
      example: false
      type: boolean
    dns-settings_nameservers:
      description: Settings determining the nameservers through which the zone should be available.
      properties:
        type:
          description: Nameserver type
          enum:
            - cloudflare.standard
            - cloudflare.standard.random
            - custom.account
            - custom.tenant
            - custom.zone
          example: cloudflare.standard
          type: string
      required:
        - type
      type: object
    dns-settings_ns_ttl:
      description: The time to live (TTL) of the zone's nameserver (NS) records.
      example: 86400
      maximum: 86400
      minimum: 30
      type: number
    dns-settings_schemas-dns_response_single:
      allOf:
        - $ref: '#/components/schemas/dns-settings_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/dns-settings_dns-settings'
          type: object
    dns-settings_secondary_overrides:
      description: Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex.
      example: false
      type: boolean
    dns-settings_soa:
      description: Components of the zone's SOA record.
      properties:
        expire:
          description: Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.
          example: 604800
          maximum: 2.4192e+06
          minimum: 86400
          type: number
        min_ttl:
          description: The time to live (TTL) for negative caching of records within the zone.
          example: 1800
          maximum: 86400
          minimum: 60
          type: number
        mname:
          description: The primary nameserver, which may be used for outbound zone transfers.
          example: kristina.ns.cloudflare.com
          type: string
        refresh:
          description: Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.
          example: 10000
          maximum: 86400
          minimum: 600
          type: number
        retry:
          description: Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.
          example: 2400
          maximum: 86400
          minimum: 600
          type: number
        rname:
          description: The email address of the zone administrator, with the first label representing the local part of the email address.
          example: admin.example.com
          type: string
        ttl:
          description: The time to live (TTL) of the SOA record itself.
          example: 3600
          maximum: 86400
          minimum: 300
          type: number
      required:
        - mname
        - rname
        - refresh
        - retry
        - expire
        - min_ttl
        - ttl
      type: object
    dns-settings_zone_mode:
      description: Whether the zone mode is a regular or CDN/DNS only zone.
      enum:
        - standard
        - cdn_only
        - dns_only
      example: dns_only
      type: string
    dnssec_algorithm:
      description: Algorithm key code.
      example: "13"
      nullable: true
      readOnly: true
      type: string
    dnssec_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/dnssec_messages'
        messages:
          $ref: '#/components/schemas/dnssec_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    dnssec_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/dnssec_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/dnssec_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    dnssec_api-response-single:
      allOf:
        - $ref: '#/components/schemas/dnssec_api-response-common'
        - properties:
            result:
              anyOf:
                - type: object
                - type: string
      type: object
    dnssec_delete_dnssec_response_single:
      allOf:
        - $ref: '#/components/schemas/dnssec_api-response-single'
        - properties:
            result:
              example: ""
              type: string
    dnssec_digest:
      description: Digest hash.
      example: 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45
      nullable: true
      readOnly: true
      type: string
    dnssec_digest_algorithm:
      description: Type of digest algorithm.
      example: SHA256
      nullable: true
      readOnly: true
      type: string
    dnssec_digest_type:
      description: Coded type for digest algorithm.
      example: "2"
      nullable: true
      readOnly: true
      type: string
    dnssec_dnssec:
      properties:
        algorithm:
          $ref: '#/components/schemas/dnssec_algorithm'
        digest:
          $ref: '#/components/schemas/dnssec_digest'
        digest_algorithm:
          $ref: '#/components/schemas/dnssec_digest_algorithm'
        digest_type:
          $ref: '#/components/schemas/dnssec_digest_type'
        dnssec_multi_signer:
          $ref: '#/components/schemas/dnssec_dnssec_multi_signer'
        dnssec_presigned:
          $ref: '#/components/schemas/dnssec_dnssec_presigned'
        ds:
          $ref: '#/components/schemas/dnssec_ds'
        flags:
          $ref: '#/components/schemas/dnssec_flags'
        key_tag:
          $ref: '#/components/schemas/dnssec_key_tag'
        key_type:
          $ref: '#/components/schemas/dnssec_key_type'
        modified_on:
          $ref: '#/components/schemas/dnssec_modified_on'
        public_key:
          $ref: '#/components/schemas/dnssec_public_key'
        status:
          $ref: '#/components/schemas/dnssec_status'
      type: object
    dnssec_dnssec_multi_signer:
      description: |-
        If true, multi-signer DNSSEC is enabled on the zone, allowing multiple
        providers to serve a DNSSEC-signed zone at the same time.
        This is required for DNSKEY records (except those automatically
        generated by Cloudflare) to be added to the zone.

        See [Multi-signer DNSSEC](https://developers.cloudflare.com/dns/dnssec/multi-signer-dnssec/) for details.
      example: false
      type: boolean
    dnssec_dnssec_presigned:
      description: |-
        If true, allows Cloudflare to transfer in a DNSSEC-signed zone
        including signatures from an external provider, without requiring
        Cloudflare to sign any records on the fly.

        Note that this feature has some limitations.
        See [Cloudflare as Secondary](https://developers.cloudflare.com/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup/#dnssec) for details.
      example: true
      type: boolean
    dnssec_dnssec_response_single:
      allOf:
        - $ref: '#/components/schemas/dnssec_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/dnssec_dnssec'
    dnssec_ds:
      description: Full DS record.
      example: example.com. 3600 IN DS 16953 13 2 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45
      nullable: true
      readOnly: true
      type: string
    dnssec_flags:
      description: Flag for DNSSEC record.
      example: 257
      nullable: true
      readOnly: true
      type: number
    dnssec_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    dnssec_key_tag:
      description: Code for key tag.
      example: 42
      nullable: true
      readOnly: true
      type: number
    dnssec_key_type:
      description: Algorithm key type.
      example: ECDSAP256SHA256
      nullable: true
      readOnly: true
      type: string
    dnssec_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    dnssec_modified_on:
      description: When DNSSEC was last modified.
      example: "2014-01-01T05:20:00Z"
      format: date-time
      nullable: true
      readOnly: true
      type: string
    dnssec_public_key:
      description: Public key for DS record.
      example: oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA==
      nullable: true
      readOnly: true
      type: string
    dnssec_status:
      description: Status of DNSSEC, based on user-desired state and presence of necessary records.
      enum:
        - active
        - pending
        - disabled
        - pending-disabled
        - error
      example: active
    dos_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/dos_messages'
        messages:
          $ref: '#/components/schemas/dos_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    dos_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/dos_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/dos_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    dos_asn:
      type: integer
    dos_asn_country:
      example: US
      type: string
    dos_asn_description:
      example: CLOUDFLARENET
      type: string
    dos_asn_type:
      description: Infrastructure type of this ASN.
      enum:
        - hosting_provider
        - isp
        - organization
      example: hosting_provider
      type: string
    dos_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    dos_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    dos_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      type: string
    email-security_AccountId:
      description: Account Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      minLength: 32
      readOnly: true
      title: account_id
      type: string
    email-security_AllowPattern:
      allOf:
        - additionalProperties: false
          example:
            comments: Trust all messages send from test@example.com
            is_recipient: false
            is_regex: false
            is_sender: true
            is_spoof: false
            pattern: test@example.com
            pattern_type: EMAIL
            verify_sender: true
          properties:
            comments:
              nullable: true
              type: string
            is_recipient:
              type: boolean
            is_regex:
              type: boolean
            is_sender:
              type: boolean
            is_spoof:
              type: boolean
            pattern:
              minLength: 1
              type: string
            pattern_type:
              $ref: '#/components/schemas/email-security_PatternType'
            verify_sender:
              type: boolean
          required:
            - is_recipient
            - is_sender
            - is_spoof
            - pattern
            - is_regex
            - verify_sender
            - pattern_type
          type: object
        - properties:
            created_at:
              format: date-time
              type: string
            id:
              example: 2401
              format: int32
              title: identifier
              type: integer
            last_modified:
              format: date-time
              type: string
          required:
            - id
            - created_at
            - last_modified
          type: object
      example:
        comments: Trust all messages send from test@example.com
        created_at: "2023-11-14T22:13:20Z"
        id: 2401
        is_recipient: false
        is_regex: false
        is_sender: true
        is_spoof: false
        last_modified: "2023-11-14T22:13:20Z"
        pattern: test@example.com
        pattern_type: EMAIL
        verify_sender: true
    email-security_ApiResponseCommon:
      properties:
        errors:
          example: []
          items:
            $ref: '#/components/schemas/email-security_Message'
          type: array
        messages:
          example: []
          items:
            $ref: '#/components/schemas/email-security_Message'
          type: array
        success:
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    email-security_Attachment:
      properties:
        content_type:
          nullable: true
          type: string
        detection:
          allOf:
            - $ref: '#/components/schemas/email-security_DispositionLabel'
            - nullable: true
              type: string
        encrypted:
          nullable: true
          type: boolean
        name:
          nullable: true
          type: string
        size:
          minimum: 0
          type: integer
      required:
        - size
      type: object
    email-security_BlockedSender:
      allOf:
        - additionalProperties: false
          example:
            comments: block sender with email test@example.com
            is_regex: false
            pattern: test@example.com
            pattern_type: EMAIL
          properties:
            comments:
              nullable: true
              type: string
            is_regex:
              type: boolean
            pattern:
              minLength: 1
              type: string
            pattern_type:
              $ref: '#/components/schemas/email-security_PatternType'
          required:
            - pattern
            - is_regex
            - pattern_type
          type: object
        - properties:
            created_at:
              format: date-time
              type: string
            id:
              example: 2402
              format: int32
              title: identifier
              type: integer
            last_modified:
              format: date-time
              type: string
          required:
            - id
            - created_at
            - last_modified
          type: object
      example:
        comments: block sender with email test@example.com
        created_at: "2023-11-14T22:13:20Z"
        id: 2402
        is_regex: false
        last_modified: "2023-11-14T22:13:20Z"
        pattern: test@example.com
        pattern_type: EMAIL
    email-security_CreateAllowPattern:
      additionalProperties: false
      example:
        comments: Trust all messages send from test@example.com
        is_recipient: false
        is_regex: false
        is_sender: true
        is_spoof: false
        pattern: test@example.com
        pattern_type: EMAIL
        verify_sender: true
      properties:
        comments:
          nullable: true
          type: string
        is_recipient:
          type: boolean
        is_regex:
          type: boolean
        is_sender:
          type: boolean
        is_spoof:
          type: boolean
        pattern:
          minLength: 1
          type: string
        pattern_type:
          $ref: '#/components/schemas/email-security_PatternType'
        verify_sender:
          type: boolean
      required:
        - is_recipient
        - is_sender
        - is_spoof
        - pattern
        - is_regex
        - verify_sender
        - pattern_type
      type: object
    email-security_CreateBlockedSender:
      additionalProperties: false
      example:
        comments: block sender with email test@example.com
        is_regex: false
        pattern: test@example.com
        pattern_type: EMAIL
      properties:
        comments:
          nullable: true
          type: string
        is_regex:
          type: boolean
        pattern:
          minLength: 1
          type: string
        pattern_type:
          $ref: '#/components/schemas/email-security_PatternType'
      required:
        - pattern
        - is_regex
        - pattern_type
      type: object
    email-security_CreateDisplayName:
      properties:
        email:
          type: string
        is_email_regex:
          type: boolean
        name:
          type: string
      required:
        - name
        - email
        - is_email_regex
      type: object
    email-security_CreateTrustedDomain:
      additionalProperties: false
      example:
        comments:
        is_recent: true
        is_regex: false
        is_similarity: false
        pattern: example.com
      properties:
        comments:
          nullable: true
          type: string
        is_recent:
          type: boolean
        is_regex:
          type: boolean
        is_similarity:
          type: boolean
        pattern:
          minLength: 1
          type: string
      required:
        - is_recent
        - is_similarity
        - is_regex
        - pattern
      type: object
    email-security_DeliveryMode:
      enum:
        - DIRECT
        - BCC
        - JOURNAL
        - API
        - RETRO_SCAN
      type: string
    email-security_DisplayName:
      properties:
        comments:
          nullable: true
          type: string
        created_at:
          format: date-time
          type: string
        directory_id:
          allOf:
            - format: int64
              type: integer
            - nullable: true
              type: integer
        directory_node_id:
          nullable: true
          type: string
        email:
          nullable: true
          type: string
        id:
          example: 2403
          format: int32
          title: identifier
          type: integer
        is_email_regex:
          type: boolean
        last_modified:
          format: date-time
          type: string
        name:
          type: string
        provenance:
          nullable: true
          type: string
      required:
        - id
        - created_at
        - last_modified
        - name
        - is_email_regex
      type: object
    email-security_DispositionLabel:
      enum:
        - MALICIOUS
        - MALICIOUS-BEC
        - SUSPICIOUS
        - SPOOF
        - SPAM
        - BULK
        - ENCRYPTED
        - EXTERNAL
        - UNKNOWN
        - NONE
      type: string
    email-security_Domain:
      example:
        allowed_delivery_modes:
          - API
        created_at: "2023-11-14T22:13:20Z"
        domain: example.com
        id: 2400
        integration_id: a5dbb180-60ea-4578-84bb-d01a5d4e50c3
        last_modified: "2023-11-14T22:13:20Z"
        lookback_hops: 2
        o365_tenant_id: c3c3239d-8858-47df-9618-0e2d9bdf6aa8
      properties:
        allowed_delivery_modes:
          items:
            $ref: '#/components/schemas/email-security_DeliveryMode'
          type: array
        created_at:
          format: date-time
          type: string
        domain:
          type: string
        id:
          description: Unique domain identifier
          example: 2400
          format: int32
          type: integer
        integration_id:
          format: uuid
          nullable: true
          type: string
        last_modified:
          format: date-time
          type: string
        lookback_hops:
          format: int32
          type: integer
        o365_tenant_id:
          nullable: true
          type: string
      required:
        - id
        - created_at
        - last_modified
        - domain
        - allowed_delivery_modes
        - lookback_hops
      type: object
    email-security_Link:
      properties:
        href:
          type: string
        text:
          nullable: true
          type: string
      required:
        - href
      type: object
    email-security_MailsearchMessage:
      allOf:
        - properties:
            action_log: {}
            alert_id:
              nullable: true
              type: string
            client_recipients:
              items:
                type: string
              type: array
            delivery_mode:
              allOf:
                - $ref: '#/components/schemas/email-security_MessageDeliveryMode'
                - nullable: true
                  type: string
            detection_reasons:
              items:
                type: string
              type: array
            edf_hash:
              nullable: true
              type: string
            final_disposition:
              allOf:
                - $ref: '#/components/schemas/email-security_DispositionLabel'
                - nullable: true
                  type: string
            from:
              nullable: true
              type: string
            from_name:
              nullable: true
              type: string
            is_phish_submission:
              type: boolean
            is_quarantined:
              type: boolean
            message_id:
              type: string
            postfix_id:
              $ref: '#/components/schemas/email-security_PostfixId'
            sent_date:
              nullable: true
              type: string
            subject:
              nullable: true
              type: string
            threat_categories:
              items:
                type: string
              nullable: true
              type: array
            to:
              items:
                type: string
              nullable: true
              type: array
            to_name:
              items:
                type: string
              nullable: true
              type: array
            ts:
              type: string
            validation:
              allOf:
                - properties:
                    comment:
                      nullable: true
                      type: string
                    dkim:
                      allOf:
                        - $ref: '#/components/schemas/email-security_ValidationStatus'
                        - nullable: true
                          type: string
                    dmarc:
                      allOf:
                        - $ref: '#/components/schemas/email-security_ValidationStatus'
                        - nullable: true
                          type: string
                    spf:
                      allOf:
                        - $ref: '#/components/schemas/email-security_ValidationStatus'
                        - nullable: true
                          type: string
                  type: object
                - nullable: true
                  type: object
          required:
            - ts
            - message_id
            - client_recipients
            - postfix_id
            - detection_reasons
            - action_log
            - is_quarantined
            - is_phish_submission
          type: object
        - properties:
            id:
              type: string
          required:
            - id
          type: object
      example:
        action_log: []
        alert_id: 4Njp3P0STMz2c02Q-2022-12-30T02:44:49
        client_recipients:
          - email@example.com
        delivery_mode: DIRECT
        detection_reasons:
          - 'Selector is a source of spam/uce : Smtp-Helo-Server-Ip=<b>127.0.0[dot]186</b>'
        edf_hash:
        final_disposition: MALICIOUS
        from: d1994@example.com
        from_name: Sender Name
        id: 47JJcT1w6GztQV7-email@example.com
        is_phish_submission: false
        is_quarantined: false
        message_id: <4VAZPrAdg7IGNxdt1DWRNu0gvOeL_iZiwP4BQfo4DaE.Yw-woXuugQbeFhBpzwFQtqq_v2v1HOKznoMBqbciQpE@example.com>
        postfix_id: 47JJcT1w6GztQV7
        sent_date: 2019-11-21T00:22:01
        subject: listen, I highly recommend u to read that email, just to ensure not a thing will take place
        threat_categories:
          - IPReputation
          - ASNReputation
        to:
          - email@example.com
        to_name:
          - Recipient Name
        ts: 2019-11-20T23:22:01
        validation:
          comment:
          dkim: pass
          dmarc: none
          spf: fail
    email-security_Message:
      properties:
        code:
          format: int32
          minimum: 1000
          type: integer
        message:
          type: string
      required:
        - code
        - message
      type: object
    email-security_MessageDeliveryMode:
      enum:
        - DIRECT
        - BCC
        - JOURNAL
        - REVIEW_SUBMISSION
        - DMARC_UNVERIFIED
        - DMARC_FAILURE_REPORT
        - DMARC_AGGREGATE_REPORT
        - THREAT_INTEL_SUBMISSION
        - SIMULATION_SUBMISSION
        - API
        - RETRO_SCAN
      type: string
    email-security_MessageHeader:
      properties:
        name:
          type: string
        value:
          type: string
      required:
        - name
        - value
      type: object
    email-security_PatternType:
      enum:
        - EMAIL
        - DOMAIN
        - IP
        - UNKNOWN
      type: string
    email-security_PhishGuardReport:
      properties:
        content:
          type: string
        disposition:
          $ref: '#/components/schemas/email-security_DispositionLabel'
        fields:
          properties:
            from:
              nullable: true
              type: string
            postfix_id:
              type: string
            to:
              items:
                type: string
              type: array
            ts:
              format: date-time
              type: string
          required:
            - to
            - ts
            - postfix_id
          type: object
        id:
          format: int32
          type: integer
        priority:
          type: string
        tags:
          items:
            $ref: '#/components/schemas/email-security_PhishGuardReportTag'
          nullable: true
          type: array
        title:
          type: string
        ts:
          format: date-time
          type: string
      required:
        - id
        - ts
        - title
        - content
        - fields
        - priority
        - disposition
      type: object
    email-security_PhishGuardReportTag:
      properties:
        category:
          type: string
        value:
          type: string
      required:
        - category
        - value
      type: object
    email-security_PostfixId:
      description: Message identifier
      example: 4Njp3P0STMz2c02Q
      title: postfix_id
      type: string
    email-security_ReleaseResponse:
      allOf:
        - properties:
            delivered:
              items:
                type: string
              nullable: true
              type: array
            failed:
              items:
                type: string
              nullable: true
              type: array
            undelivered:
              items:
                type: string
              nullable: true
              type: array
          type: object
        - properties:
            postfix_id:
              $ref: '#/components/schemas/email-security_PostfixId'
          required:
            - postfix_id
          type: object
    email-security_ResultInfo:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          format: int32
          type: integer
        page:
          description: Current page within paginated list of results
          example: 1
          format: int32
          type: integer
        per_page:
          description: Number of results per page of results
          example: 20
          format: int32
          type: integer
        total_count:
          description: Total results available without any search parameters
          example: 2000
          format: int32
          type: integer
      required:
        - count
        - page
        - per_page
        - total_count
      type: object
    email-security_SortingDirection:
      enum:
        - asc
        - desc
      type: string
    email-security_ThreatCategory:
      properties:
        description:
          nullable: true
          type: string
        id:
          format: int64
          type: integer
        name:
          nullable: true
          type: string
      required:
        - id
      type: object
    email-security_TraceLine:
      properties:
        lineno:
          format: int64
          type: integer
        message:
          type: string
        ts:
          format: date-time
          type: string
      required:
        - ts
        - lineno
        - message
      type: object
    email-security_TrustedDomain:
      allOf:
        - additionalProperties: false
          example:
            comments:
            is_recent: true
            is_regex: false
            is_similarity: false
            pattern: example.com
          properties:
            comments:
              nullable: true
              type: string
            is_recent:
              type: boolean
            is_regex:
              type: boolean
            is_similarity:
              type: boolean
            pattern:
              minLength: 1
              type: string
          required:
            - is_recent
            - is_similarity
            - is_regex
            - pattern
          type: object
        - properties:
            created_at:
              format: date-time
              type: string
            id:
              example: 2401
              format: int32
              title: identifier
              type: integer
            last_modified:
              format: date-time
              type: string
          required:
            - id
            - created_at
            - last_modified
          type: object
      example:
        comments:
        created_at: "2023-11-14T22:13:20Z"
        id: 2401
        is_recent: true
        is_regex: false
        is_similarity: false
        last_modified: "2023-11-14T22:13:20Z"
        pattern: example.com
    email-security_ValidationStatus:
      enum:
        - pass
        - neutral
        - fail
        - error
        - none
      type: string
    email_account_id:
      $ref: '#/components/schemas/email_identifier'
    email_addresses:
      allOf:
        - $ref: '#/components/schemas/email_destination_address_properties'
      type: object
    email_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/email_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/email_result_info'
      type: object
    email_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/email_messages'
        messages:
          $ref: '#/components/schemas/email_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    email_api-response-single:
      allOf:
        - $ref: '#/components/schemas/email_api-response-common'
      type: object
    email_catch_all_rule:
      properties:
        actions:
          $ref: '#/components/schemas/email_rule_catchall-actions'
        enabled:
          $ref: '#/components/schemas/email_rule_enabled'
        id:
          $ref: '#/components/schemas/email_rule_identifier'
        matchers:
          $ref: '#/components/schemas/email_rule_catchall-matchers'
        name:
          $ref: '#/components/schemas/email_rule_name'
        tag:
          $ref: '#/components/schemas/email_rule_tag'
      type: object
    email_catch_all_rule_response_single:
      allOf:
        - $ref: '#/components/schemas/email_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/email_catch_all_rule'
    email_create_destination_address_properties:
      properties:
        email:
          $ref: '#/components/schemas/email_email'
      required:
        - email
      type: object
    email_create_rule_properties:
      properties:
        actions:
          $ref: '#/components/schemas/email_rule_actions'
        enabled:
          $ref: '#/components/schemas/email_rule_enabled'
        matchers:
          $ref: '#/components/schemas/email_rule_matchers'
        name:
          $ref: '#/components/schemas/email_rule_name'
        priority:
          $ref: '#/components/schemas/email_rule_priority'
      required:
        - actions
        - matchers
      type: object
    email_created:
      description: The date and time the destination address has been created.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      readOnly: true
      type: string
    email_destination_address_identifier:
      description: Destination address identifier.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      readOnly: true
      type: string
    email_destination_address_properties:
      properties:
        created:
          $ref: '#/components/schemas/email_created'
        email:
          $ref: '#/components/schemas/email_email'
        id:
          $ref: '#/components/schemas/email_destination_address_identifier'
        modified:
          $ref: '#/components/schemas/email_modified'
        tag:
          $ref: '#/components/schemas/email_destination_address_tag'
        verified:
          $ref: '#/components/schemas/email_verified'
      type: object
    email_destination_address_response_single:
      allOf:
        - $ref: '#/components/schemas/email_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/email_addresses'
    email_destination_address_tag:
      deprecated: true
      description: Destination address tag. (Deprecated, replaced by destination address identifier)
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      readOnly: true
      type: string
    email_destination_addresses_response_collection:
      allOf:
        - $ref: '#/components/schemas/email_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/email_addresses'
              type: array
            result_info:
              properties:
                count:
                  example: 1
                page:
                  example: 1
                per_page:
                  example: 20
                total_count:
                  example: 1
              type: object
    email_dns_record:
      description: List of records needed to enable an Email Routing zone.
      properties:
        content:
          description: DNS record content.
          example: route1.mx.cloudflare.net
          type: string
        name:
          description: DNS record name (or @ for the zone apex).
          example: example.com
          maxLength: 255
          type: string
        priority:
          description: Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred.
          example: 12
          maximum: 65535
          minimum: 0
          type: number
        ttl:
          anyOf:
            - example: 3600
              maximum: 86400
              minimum: 1
              type: number
            - enum:
                - 1
              type: number
          description: Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.
          example: 1
          type: number
        type:
          description: DNS record type.
          enum:
            - A
            - AAAA
            - CNAME
            - HTTPS
            - TXT
            - SRV
            - LOC
            - MX
            - NS
            - CERT
            - DNSKEY
            - DS
            - NAPTR
            - SMIMEA
            - SSHFP
            - SVCB
            - TLSA
            - URI
          example: NS
          readOnly: true
          type: string
      type: object
    email_dns_settings_response_collection:
      allOf:
        - $ref: '#/components/schemas/email_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/email_dns_record'
              type: array
    email_email:
      description: The contact email address of the user.
      example: user@example.com
      maxLength: 90
      type: string
    email_email_setting_created:
      description: The date and time the settings have been created.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      readOnly: true
      type: string
    email_email_setting_enabled:
      default: true
      description: State of the zone settings for Email Routing.
      enum:
        - true
        - false
      example: true
      type: boolean
    email_email_setting_identifier:
      description: Email Routing settings identifier.
      example: 75610dab9e69410a82cf7e400a09ecec
      maxLength: 32
      readOnly: true
      type: string
    email_email_setting_modified:
      description: The date and time the settings have been modified.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      readOnly: true
      type: string
    email_email_setting_name:
      description: Domain of your zone.
      example: example.net
      readOnly: true
      type: string
    email_email_setting_skip-wizard:
      default: true
      description: Flag to check if the user skipped the configuration wizard.
      enum:
        - true
        - false
      example: true
      type: boolean
    email_email_setting_status:
      description: Show the state of your account, and the type or configuration error.
      enum:
        - ready
        - unconfigured
        - misconfigured
        - misconfigured/locked
        - unlocked
      example: ready
      readOnly: true
      type: string
    email_email_setting_tag:
      deprecated: true
      description: Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
      example: 75610dab9e69410a82cf7e400a09ecec
      maxLength: 32
      readOnly: true
      type: string
    email_email_settings_properties:
      properties:
        created:
          $ref: '#/components/schemas/email_email_setting_created'
        enabled:
          $ref: '#/components/schemas/email_email_setting_enabled'
        id:
          $ref: '#/components/schemas/email_email_setting_identifier'
        modified:
          $ref: '#/components/schemas/email_email_setting_modified'
        name:
          $ref: '#/components/schemas/email_email_setting_name'
        skip_wizard:
          $ref: '#/components/schemas/email_email_setting_skip-wizard'
        status:
          $ref: '#/components/schemas/email_email_setting_status'
        tag:
          $ref: '#/components/schemas/email_email_setting_tag'
      type: object
    email_email_settings_response_single:
      allOf:
        - $ref: '#/components/schemas/email_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/email_settings'
    email_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    email_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    email_modified:
      description: The date and time the destination address was last modified.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      readOnly: true
      type: string
    email_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    email_rule_action:
      description: Actions pattern.
      properties:
        type:
          description: Type of supported action.
          enum:
            - drop
            - forward
            - worker
          example: forward
          type: string
        value:
          items:
            description: Value for action.
            example: destinationaddress@example.net
            maxLength: 90
            type: string
          type: array
      required:
        - type
        - value
      type: object
    email_rule_actions:
      description: List actions patterns.
      items:
        $ref: '#/components/schemas/email_rule_action'
      type: array
    email_rule_catchall-action:
      description: Action for the catch-all routing rule.
      properties:
        type:
          description: Type of action for catch-all rule.
          enum:
            - drop
            - forward
            - worker
          example: forward
          type: string
        value:
          items:
            description: Input value for action.
            example: destinationaddress@example.net
            maxLength: 90
            type: string
          type: array
      required:
        - type
      type: object
    email_rule_catchall-actions:
      description: List actions for the catch-all routing rule.
      items:
        $ref: '#/components/schemas/email_rule_catchall-action'
      type: array
    email_rule_catchall-matcher:
      description: Matcher for catch-all routing rule.
      properties:
        type:
          description: Type of matcher. Default is 'all'.
          enum:
            - all
          example: all
          type: string
      required:
        - type
      type: object
    email_rule_catchall-matchers:
      description: List of matchers for the catch-all routing rule.
      items:
        $ref: '#/components/schemas/email_rule_catchall-matcher'
      type: array
    email_rule_enabled:
      default: true
      description: Routing rule status.
      enum:
        - true
        - false
      example: true
      type: boolean
    email_rule_identifier:
      description: Routing rule identifier.
      example: a7e6fb77503c41d8a7f3113c6918f10c
      maxLength: 32
      readOnly: true
      type: string
    email_rule_matcher:
      description: Matching pattern to forward your actions.
      properties:
        field:
          description: Field for type matcher.
          enum:
            - to
          example: to
          type: string
        type:
          description: Type of matcher.
          enum:
            - literal
          example: literal
          type: string
        value:
          description: Value for matcher.
          example: test@example.com
          maxLength: 90
          type: string
      required:
        - type
        - field
        - value
      type: object
    email_rule_matchers:
      description: Matching patterns to forward to your actions.
      items:
        $ref: '#/components/schemas/email_rule_matcher'
      type: array
    email_rule_name:
      description: Routing rule name.
      example: Send to user@example.net rule.
      maxLength: 256
      type: string
    email_rule_priority:
      default: 0
      description: Priority of the routing rule.
      minimum: 0
      type: number
    email_rule_properties:
      properties:
        actions:
          $ref: '#/components/schemas/email_rule_actions'
        enabled:
          $ref: '#/components/schemas/email_rule_enabled'
        id:
          $ref: '#/components/schemas/email_rule_identifier'
        matchers:
          $ref: '#/components/schemas/email_rule_matchers'
        name:
          $ref: '#/components/schemas/email_rule_name'
        priority:
          $ref: '#/components/schemas/email_rule_priority'
        tag:
          $ref: '#/components/schemas/email_rule_tag'
      type: object
    email_rule_response_single:
      allOf:
        - $ref: '#/components/schemas/email_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/email_rules'
    email_rule_tag:
      deprecated: true
      description: Routing rule tag. (Deprecated, replaced by routing rule identifier)
      example: a7e6fb77503c41d8a7f3113c6918f10c
      maxLength: 32
      readOnly: true
      type: string
    email_rules:
      allOf:
        - $ref: '#/components/schemas/email_rule_properties'
      type: object
    email_rules_response_collection:
      allOf:
        - $ref: '#/components/schemas/email_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/email_rules'
              type: array
            result_info:
              properties:
                count:
                  example: 1
                page:
                  example: 1
                per_page:
                  example: 20
                total_count:
                  example: 1
              type: object
    email_settings:
      allOf:
        - $ref: '#/components/schemas/email_email_settings_properties'
      type: object
    email_update_catch_all_rule_properties:
      properties:
        actions:
          $ref: '#/components/schemas/email_rule_catchall-actions'
        enabled:
          $ref: '#/components/schemas/email_rule_enabled'
        matchers:
          $ref: '#/components/schemas/email_rule_catchall-matchers'
        name:
          $ref: '#/components/schemas/email_rule_name'
      required:
        - actions
        - matchers
      type: object
    email_update_rule_properties:
      properties:
        actions:
          $ref: '#/components/schemas/email_rule_actions'
        enabled:
          $ref: '#/components/schemas/email_rule_enabled'
        matchers:
          $ref: '#/components/schemas/email_rule_matchers'
        name:
          $ref: '#/components/schemas/email_rule_name'
        priority:
          $ref: '#/components/schemas/email_rule_priority'
      required:
        - actions
        - matchers
      type: object
    email_verified:
      description: The date and time the destination address has been verified. Null means not verified yet.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      readOnly: true
      type: string
    email_zone_id:
      $ref: '#/components/schemas/email_identifier'
    firewall_account_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    firewall_action:
      anyOf:
        - properties:
            mode:
              $ref: '#/components/schemas/firewall_mode'
            response:
              $ref: '#/components/schemas/firewall_custom_response'
            timeout:
              $ref: '#/components/schemas/firewall_timeout'
          type: object
      description: The action to perform when the threshold of matched traffic within the configured period is exceeded.
      type: object
    firewall_action_mode:
      default: challenge
      description: The default action performed by the rules in the WAF package.
      enum:
        - simulate
        - block
        - challenge
      type: string
    firewall_action_parameters:
      description: The parameters configuring the action.
      oneOf:
        - $ref: '#/components/schemas/firewall_action_parameters_route'
      type: object
    firewall_action_parameters_redirect:
      description: The configuration parameters for the redirect action.
      properties:
        from_value:
          description: The parameters that control the redirect.
          properties:
            preserve_query_string:
              description: Whether the query string for the request should be carried to the redirect's target url.
              example: true
              type: boolean
            status_code:
              description: The status code to use for the redirect.
              type: integer
            target_url:
              oneOf:
                - properties:
                    expression:
                      description: An expression defining a dynamic value for the target url of the redirect.
                      example: concat(http.request.full_uri, "/latest")
                      type: string
                  type: object
                - properties:
                    value:
                      description: The value defining the target url of the redirect.
                      example: https://example.com/blog/latest
                      type: string
                  type: object
          type: object
    firewall_action_parameters_rewrite:
      description: The configuration parameters for the rewrite action.
      properties:
        uri:
          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.
          type: object
    firewall_action_parameters_route:
      description: The configuration parameters for the route action.
      properties:
        host_header:
          description: The value of the Host header.
          example: foo.example.com
          type: string
        origin:
          description: The parameters that control where the origin is.
          properties:
            host:
              description: The host to use for origin.
              example: foo.example.com
              type: string
            port:
              description: The port to use for origin.
              type: integer
          type: object
        sni:
          description: The parameters that control the SNI.
          properties:
            value:
              description: The SNI used to connect to the origin.
              example: foo.example.com
              type: string
          type: object
    firewall_action_parameters_set_cache_settings:
      description: The configuration parameters for the set_cache_settings action.
      properties:
        browser_ttl:
          description: Set the Browser TTL.
          properties:
            default:
              type: integer
            mode:
              example: override_origin
              type: string
          type: object
        cache_key:
          description: Set the Cache TTL.
          properties:
            cache_deception_armor:
              example: true
              type: boolean
            custom_key:
              properties:
                cookie:
                  properties:
                    check_presence:
                      example:
                        - cookie_1
                      items: {}
                      type: array
                    include:
                      example:
                        - cookie1
                      items: {}
                      type: array
                  type: object
                header:
                  properties:
                    check_presence:
                      example:
                        - header_1
                      items: {}
                      type: array
                    include:
                      example:
                        - header1
                      items: {}
                      type: array
                  type: object
                host:
                  properties:
                    resolved:
                      example: false
                      type: boolean
                  type: object
                query_string:
                  properties:
                    include:
                      example: '*'
                      type: string
                  type: object
                user:
                  properties:
                    device_type:
                      example: true
                      type: boolean
                    geo:
                      example: false
                      type: boolean
                    lang:
                      example: false
                      type: boolean
                  type: object
              type: object
            ignore_query_strings_order:
              example: true
              type: boolean
          type: object
        edge_ttl:
          description: Set the Cache TTL.
          properties:
            mode:
              example: respect_origin
              type: string
            status_code_ttl:
              properties:
                status_code:
                  type: integer
                value:
                  type: integer
              type: object
          type: object
        origin_error_page_passthru:
          example: true
          type: boolean
        respect_strong_etags:
          example: true
          type: boolean
        serve_stale:
          properties:
            disable_stale_while_updating:
              example: true
              type: boolean
          type: object
    firewall_action_parameters_set_config:
      description: The configuration parameters for the set_config action.
      properties:
        automatic_https_rewrites:
          description: Enable or disable Automatic HTTPS Rewrites for matching requests
          example: true
          type: boolean
        autominify:
          description: Select which file extensions to minify automatically.
          properties:
            css:
              example: true
              type: boolean
            html:
              example: true
              type: boolean
            js:
              example: true
              type: boolean
          type: object
        bic:
          description: Enable or disable Browser Integrity Check
          example: true
          type: boolean
        disable_apps:
          description: Disable all active Cloudflare Apps
          example: true
          type: boolean
        disable_railgun:
          description: Disable Cloudflare Railgun
          example: true
          type: boolean
        disable_zaraz:
          description: Disable Cloudflare Railgun
          example: true
          type: boolean
        email_obfuscation:
          description: Enable or disable Email Obfuscation
          example: false
          type: boolean
        hotlink_protection:
          description: Enable or disable Hotlink Protection
          example: false
          type: boolean
        mirage:
          description: Enable or disable Mirage
          example: false
          type: boolean
        opportunistic_encryption:
          description: Enable or disableOpportunistic Encryption
          example: false
          type: boolean
        polish:
          description: Set Polish compression options
          example: lossless
          type: string
        rocket_loader:
          description: Enable or disable Rocket Loader
          example: false
          type: boolean
        security_level:
          description: Set the Security Level
          example: low
          type: string
        server_side_excludes:
          description: Enable or disable Server Side Excludes
          example: false
          type: boolean
        ssl:
          description: Select the SSL encryption mode
          example: flexible
          type: string
        sxg:
          description: Enable or disable Signed Exchangesn(SXG)
          example: false
          type: boolean
    firewall_anomaly_description:
      description: A summary of the purpose/function of the WAF package.
      example: Covers OWASP Top 10 vulnerabilities and more.
      readOnly: true
      type: string
    firewall_anomaly_detection_mode:
      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
      type: string
    firewall_anomaly_name:
      description: The name of the WAF package.
      example: OWASP ModSecurity Core Rule Set
      readOnly: true
      type: string
    firewall_anomaly_package:
      allOf:
        - $ref: '#/components/schemas/firewall_package_definition'
        - properties:
            action_mode:
              $ref: '#/components/schemas/firewall_action_mode'
            description:
              $ref: '#/components/schemas/firewall_anomaly_description'
            detection_mode:
              $ref: '#/components/schemas/firewall_anomaly_detection_mode'
            name:
              $ref: '#/components/schemas/firewall_anomaly_name'
            sensitivity:
              $ref: '#/components/schemas/firewall_sensitivity'
      required:
        - id
        - name
        - description
        - zone_id
        - detection_mode
        - sensitivity
        - action_mode
      title: Anomaly detection WAF package (OWASP)
    firewall_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/firewall_result_info'
      type: object
    firewall_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/firewall_messages'
        messages:
          $ref: '#/components/schemas/firewall_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    firewall_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/firewall_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/firewall_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    firewall_api-response-single:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-common'
        - properties:
            result:
              anyOf:
                - nullable: true
                  type: object
                - nullable: true
                  type: string
      type: object
    firewall_api-response-single-id:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                id:
                  $ref: '#/components/schemas/firewall_identifier'
              required:
                - id
              type: object
      type: object
    firewall_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:
          description: The AS number to match.
          example: AS12345
          type: string
      title: An ASN configuration.
    firewall_body:
      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
      type: string
    firewall_bypass:
      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:
        properties:
          name:
            enum:
              - url
            example: url
            type: string
          value:
            description: The URL to bypass.
            example: api.example.com/*
            type: string
        type: object
      type: array
    firewall_cache-rules_components-schemas-action_parameters:
      description: The parameters configuring the action.
      oneOf:
        - $ref: '#/components/schemas/firewall_action_parameters_set_cache_settings'
      type: object
    firewall_cache-rules_components-schemas-rule:
      properties:
        action:
          example: set_cache_settings
        action_parameters:
          $ref: '#/components/schemas/firewall_cache-rules_components-schemas-action_parameters'
        description:
          example: use the cache settings
        expression:
          example: http.cookie contains "something"
        id:
          example: 3a03d665bac047339bb530ecb439a90d
        version:
          example: "1"
    firewall_cache-rules_components-schemas-ruleset:
      properties:
        description:
          example: ""
        id:
          example: 2f2feab2026849078ba485f918791bdc
        kind:
          example: zone
        name:
          example: default
        phase:
          example: http_request_cache_settings
        rules:
          description: The rules in the ruleset.
          items:
            $ref: '#/components/schemas/firewall_cache-rules_components-schemas-rule'
          type: array
    firewall_cidr_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:
          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
          type: string
      title: An IP address range configuration.
    firewall_components-schemas-action:
      description: The action to perform when the rule matches.
      example: execute
      pattern: ^[a-z_]+$
      type: string
    firewall_components-schemas-action_parameters:
      description: The parameters configuring the action.
      oneOf:
        - $ref: '#/components/schemas/firewall_action_parameters_redirect'
      type: object
    firewall_components-schemas-description:
      description: An informative summary of the current URI-based WAF override.
      example: Enable Cloudflare Magento ruleset for shop.example.com
      maxLength: 1024
      nullable: true
      type: string
    firewall_components-schemas-id:
      description: The unique identifier of the User Agent Blocking rule.
      example: 372e67954025e0ba6aaa6d586b9e0b59
      maxLength: 32
      readOnly: true
      type: string
    firewall_components-schemas-identifier:
      description: The unique identifier of the resource.
      example: de677e5818985db1285d0e80225f06e5
      maxLength: 32
      readOnly: true
      type: string
    firewall_components-schemas-mode:
      description: The action to apply to a matched request.
      enum:
        - block
        - challenge
        - js_challenge
        - managed_challenge
      example: js_challenge
      maxLength: 12
    firewall_components-schemas-paused:
      description: When true, indicates that the firewall rule is currently paused.
      example: false
      type: boolean
    firewall_components-schemas-priority:
      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
      maximum: 2.147483647e+09
      minimum: 0
      type: number
    firewall_components-schemas-ref:
      description: The reference of the rule (the rule ID by default).
      example: my_ref
      type: string
    firewall_components-schemas-rule:
      properties:
        action:
          example: route
        action_parameters:
          $ref: '#/components/schemas/firewall_action_parameters'
        description:
          example: change the host header, origin, and SNI
        expression:
          example: http.cookie contains "something"
        id:
          example: 3a03d665bac047339bb530ecb439a90d
        version:
          example: "1"
    firewall_components-schemas-ruleset:
      properties:
        description:
          example: ""
        id:
          example: 2f2feab2026849078ba485f918791bdc
        kind:
          example: zone
        name:
          example: default
        phase:
          example: http_config_settings
        rules:
          description: The rules in the ruleset.
          items:
            $ref: '#/components/schemas/firewall_config-rules_components-schemas-rule'
          type: array
    firewall_config-rules_components-schemas-action_parameters:
      description: The parameters configuring the action.
      oneOf:
        - $ref: '#/components/schemas/firewall_action_parameters_set_config'
      type: object
    firewall_config-rules_components-schemas-rule:
      properties:
        action:
          example: set_config
        action_parameters:
          $ref: '#/components/schemas/firewall_config-rules_components-schemas-action_parameters'
        description:
          example: enable Email Obfuscation
        expression:
          example: http.cookie contains "something"
        id:
          example: 3a03d665bac047339bb530ecb439a90d
        version:
          example: "1"
    firewall_configuration:
      description: The rule configuration.
      oneOf:
        - $ref: '#/components/schemas/firewall_ip_configuration'
        - $ref: '#/components/schemas/firewall_ipv6_configuration'
        - $ref: '#/components/schemas/firewall_cidr_configuration'
        - $ref: '#/components/schemas/firewall_asn_configuration'
        - $ref: '#/components/schemas/firewall_country_configuration'
      type: object
    firewall_configurations:
      anyOf:
        - $ref: '#/components/schemas/firewall_schemas-ip_configuration'
        - $ref: '#/components/schemas/firewall_schemas-cidr_configuration'
      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/firewall_schemas-ip_configuration'
          - $ref: '#/components/schemas/firewall_schemas-cidr_configuration'
      type: array
    firewall_content_type:
      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
      type: string
    firewall_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:
          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
          type: string
      title: A country configuration.
    firewall_create_update_rule:
      description: A rule object.
      properties:
        action:
          $ref: '#/components/schemas/firewall_components-schemas-action'
        action_parameters:
          $ref: '#/components/schemas/firewall_schemas-action_parameters'
        description:
          $ref: '#/components/schemas/firewall_rules_components-schemas-description'
        enabled:
          $ref: '#/components/schemas/firewall_enabled'
        expression:
          $ref: '#/components/schemas/firewall_schemas-expression'
        logging:
          $ref: '#/components/schemas/firewall_logging'
        ref:
          $ref: '#/components/schemas/firewall_components-schemas-ref'
      required:
        - expression
        - action
      type: object
    firewall_create_update_rules:
      description: The list of rules in the ruleset.
      items:
        anyOf:
          - $ref: '#/components/schemas/firewall_create_update_rule'
          - description: The unique ID of a rule.
      type: array
    firewall_created_on:
      description: The timestamp of when the rule was created.
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      readOnly: true
      type: string
    firewall_custom_response:
      anyOf:
        - properties:
            body:
              $ref: '#/components/schemas/firewall_body'
            content_type:
              $ref: '#/components/schemas/firewall_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.
      type: object
    firewall_delete_filter_if_unused:
      description: When true, indicates that Cloudflare should also delete the associated filter if there are no other firewall rules referencing the filter.
      type: boolean
    firewall_deleted:
      description: When true, indicates that the firewall rule was deleted.
      example: true
      type: boolean
    firewall_deleted-filter:
      additionalProperties: false
      properties:
        deleted:
          $ref: '#/components/schemas/firewall_deleted'
        id:
          $ref: '#/components/schemas/firewall_filters_components-schemas-id'
      required:
        - id
        - deleted
    firewall_description:
      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
      type: string
    firewall_description_search:
      description: A string to search for in the description of existing rules.
      example: abusive
      type: string
    firewall_detection_mode:
      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
      type: string
    firewall_disabled:
      description: When true, indicates that the rate limit is currently disabled.
      example: false
      type: boolean
    firewall_dynamic-redirect-rules_components-schemas-rule:
      properties:
        action:
          example: redirect
        action_parameters:
          $ref: '#/components/schemas/firewall_components-schemas-action_parameters'
        description:
          example: Blog redirect
        expression:
          example: http.request.uri.path == "/blog"
        id:
          example: 3a03d665bac047339bb530ecb439a90d
        version:
          example: "1"
    firewall_email:
      description: The contact email address of the user.
      example: user@example.com
      maxLength: 90
      type: string
    firewall_enabled:
      default: "true"
      description: Whether the rule should be executed.
      example: true
      type: boolean
    firewall_expression:
      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
      type: string
    firewall_filter:
      additionalProperties: false
      properties:
        description:
          $ref: '#/components/schemas/firewall_filters_components-schemas-description'
        expression:
          $ref: '#/components/schemas/firewall_expression'
        id:
          $ref: '#/components/schemas/firewall_filters_components-schemas-id'
        paused:
          $ref: '#/components/schemas/firewall_filters_components-schemas-paused'
        ref:
          $ref: '#/components/schemas/firewall_schemas-ref'
      type: object
    firewall_filter-delete-response-collection:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-collection'
        - properties:
            result:
              items:
                allOf:
                  - $ref: '#/components/schemas/firewall_filter'
                  - required:
                      - id
                    type: object
              type: array
          type: object
    firewall_filter-delete-response-single:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/firewall_filter'
                - required:
                    - id
                  type: object
          required:
            - result
          type: object
    firewall_filter-response-collection:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-collection'
        - properties:
            result:
              items:
                allOf:
                  - $ref: '#/components/schemas/firewall_filter'
                  - required:
                      - id
                      - expression
                      - paused
                    type: object
              type: array
          type: object
    firewall_filter-response-single:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/firewall_filter'
          required:
            - result
          type: object
    firewall_filter-rule-base:
      properties:
        action:
          $ref: '#/components/schemas/firewall_schemas-action'
        description:
          $ref: '#/components/schemas/firewall_firewall-rules_components-schemas-description'
        id:
          $ref: '#/components/schemas/firewall_firewall-rules_components-schemas-id'
        paused:
          $ref: '#/components/schemas/firewall_components-schemas-paused'
        priority:
          $ref: '#/components/schemas/firewall_components-schemas-priority'
        products:
          $ref: '#/components/schemas/firewall_products'
        ref:
          $ref: '#/components/schemas/firewall_ref'
      type: object
    firewall_filter-rule-response:
      allOf:
        - $ref: '#/components/schemas/firewall_filter-rule-base'
        - properties:
            filter:
              oneOf:
                - $ref: '#/components/schemas/firewall_filter'
                - $ref: '#/components/schemas/firewall_deleted-filter'
      type: object
    firewall_filter-rules-response-collection:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-collection'
        - properties:
            result:
              items:
                allOf:
                  - $ref: '#/components/schemas/firewall_filter-rule-response'
                  - required:
                      - id
                      - filter
                      - action
                      - paused
                    type: object
              type: array
          required:
            - result
          type: object
    firewall_filter-rules-response-collection-delete:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-collection'
        - properties:
            result:
              items:
                allOf:
                  - $ref: '#/components/schemas/firewall_filter-rule-response'
                  - required:
                      - id
                    type: object
              type: array
          required:
            - result
          type: object
    firewall_filter-rules-single-response:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/firewall_filter-rule-response'
                - required:
                    - id
                    - filter
                    - action
                    - paused
                  type: object
          required:
            - result
          type: object
    firewall_filter-rules-single-response-delete:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/firewall_filter-rule-response'
                - required:
                    - id
                  type: object
          required:
            - result
          type: object
    firewall_filters:
      properties:
        configuration.target:
          description: The target to search in existing rules.
          enum:
            - ip
            - ip_range
            - asn
            - country
          example: ip
          type: string
        configuration.value:
          description: |-
            The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.
            Notes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.
          example: 198.51.100.4
          type: string
        match:
          default: all
          description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
          enum:
            - any
            - all
          type: string
        mode:
          $ref: '#/components/schemas/firewall_schemas-mode'
        notes:
          description: |-
            The string to search for in the notes of existing IP Access rules.
            Notes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.
          example: my note
          type: string
      type: object
    firewall_filters_components-schemas-description:
      description: An informative summary of the filter.
      example: Restrict access from these browsers on this address range.
      maxLength: 500
      type: string
    firewall_filters_components-schemas-id:
      description: The unique identifier of the filter.
      example: 372e67954025e0ba6aaa6d586b9e0b61
      maxLength: 32
      minLength: 32
      readOnly: true
      type: string
    firewall_filters_components-schemas-paused:
      description: When true, indicates that the filter is currently paused.
      example: false
      type: boolean
    firewall_firewall-rules_components-schemas-description:
      description: An informative summary of the firewall rule.
      example: Blocks traffic identified during investigation for MIR-31
      maxLength: 500
      type: string
    firewall_firewall-rules_components-schemas-id:
      description: The unique identifier of the firewall rule.
      example: 372e67954025e0ba6aaa6d586b9e0b60
      maxLength: 32
      readOnly: true
      type: string
    firewall_firewalluablock:
      properties:
        configuration:
          $ref: '#/components/schemas/firewall_schemas-configuration'
        description:
          $ref: '#/components/schemas/firewall_ua-rules_components-schemas-description'
        id:
          $ref: '#/components/schemas/firewall_components-schemas-id'
        mode:
          $ref: '#/components/schemas/firewall_components-schemas-mode'
        paused:
          $ref: '#/components/schemas/firewall_schemas-paused'
    firewall_firewalluablock_response_collection:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/firewall_ua-rules'
              type: array
          type: object
    firewall_firewalluablock_response_single:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-single'
        - properties:
            result:
              type: object
          type: object
    firewall_groups:
      additionalProperties: true
      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
      type: object
    firewall_header_name:
      description: The name of the response header to match.
      example: Cf-Cache-Status
      type: string
    firewall_header_op:
      description: 'The operator used when matching: `eq` means "equal" and `ne` means "not equal".'
      enum:
        - eq
        - ne
      example: ne
      type: string
    firewall_header_value:
      description: The value of the response header, which must match exactly.
      example: HIT
      type: string
    firewall_id:
      description: The unique identifier of the rate limit.
      example: 372e67954025e0ba6aaa6d586b9e0b59
      maxLength: 32
      readOnly: true
      type: string
    firewall_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    firewall_ip_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:
          description: The IP address to match. This address will be compared to the IP address of incoming requests.
          example: 198.51.100.4
          type: string
      title: An IP address configuration.
    firewall_ip_range_search:
      description: A single IP address range to search for in existing rules.
      example: 1.2.3.0/16
      type: string
    firewall_ip_search:
      description: A single IP address to search for in existing rules.
      example: 1.2.3.4
      type: string
    firewall_ipv6_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:
          description: The IPv6 address to match.
          example: 2001:DB8:100::CF
          type: string
      title: An IPv6 address configuration.
    firewall_lockdowns_components-schemas-description:
      description: An informative summary of the rule.
      example: Restrict access to these endpoints to requests from a known IP address
      maxLength: 1024
      type: string
    firewall_lockdowns_components-schemas-id:
      description: The unique identifier of the Zone Lockdown rule.
      example: 372e67954025e0ba6aaa6d586b9e0b59
      maxLength: 32
      readOnly: true
      type: string
    firewall_logging:
      description: An object configuring the rule's logging behavior.
      example:
        enabled: true
      properties:
        enabled:
          description: Whether to generate a log when the rule matches.
          example: true
          type: boolean
      type: object
    firewall_match:
      description: Determines which traffic the rate limit counts towards the threshold.
      oneOf:
        - properties:
            headers:
              items:
                properties:
                  name:
                    $ref: '#/components/schemas/firewall_header_name'
                  op:
                    $ref: '#/components/schemas/firewall_header_op'
                  value:
                    $ref: '#/components/schemas/firewall_header_value'
                type: object
              type: array
            request:
              properties:
                methods:
                  $ref: '#/components/schemas/firewall_methods'
                schemes:
                  $ref: '#/components/schemas/firewall_schemes'
                url:
                  $ref: '#/components/schemas/firewall_url'
              type: object
            response:
              properties:
                origin_traffic:
                  $ref: '#/components/schemas/firewall_origin_traffic'
              type: object
          type: object
      type: object
    firewall_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    firewall_methods:
      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:
        description: An HTTP method or `_ALL_` to indicate all methods.
        enum:
          - GET
          - POST
          - PUT
          - DELETE
          - PATCH
          - HEAD
          - _ALL_
        example: GET
        type: string
      type: array
    firewall_mode:
      description: The action to perform.
      enum:
        - simulate
        - ban
        - challenge
        - js_challenge
        - managed_challenge
      example: challenge
      type: string
    firewall_modified_on:
      description: The timestamp of when the rule was last modified.
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      readOnly: true
      type: string
    firewall_name:
      description: The name of the WAF package.
      example: USER
      readOnly: true
      type: string
    firewall_notes:
      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.
      type: string
    firewall_origin_traffic:
      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.
      type: boolean
    firewall_override:
      properties:
        description:
          $ref: '#/components/schemas/firewall_components-schemas-description'
        groups:
          $ref: '#/components/schemas/firewall_groups'
        id:
          $ref: '#/components/schemas/firewall_schemas-id'
        paused:
          $ref: '#/components/schemas/firewall_paused'
        priority:
          $ref: '#/components/schemas/firewall_priority'
        rewrite_action:
          $ref: '#/components/schemas/firewall_rewrite_action'
        rules:
          $ref: '#/components/schemas/firewall_rules'
        urls:
          $ref: '#/components/schemas/firewall_urls'
    firewall_override_response_collection:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-collection'
        - properties:
            result:
              items:
                allOf:
                  - $ref: '#/components/schemas/firewall_override'
                  - required:
                      - id
                      - paused
                      - urls
                      - priority
                    type: object
              type: array
          required:
            - result
          type: object
    firewall_override_response_single:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/firewall_override'
          required:
            - result
          type: object
    firewall_package:
      oneOf:
        - $ref: '#/components/schemas/firewall_package_definition'
        - $ref: '#/components/schemas/firewall_anomaly_package'
      type: object
    firewall_package_definition:
      properties:
        description:
          $ref: '#/components/schemas/firewall_schemas-description'
        detection_mode:
          $ref: '#/components/schemas/firewall_detection_mode'
        id:
          $ref: '#/components/schemas/firewall_identifier'
        name:
          $ref: '#/components/schemas/firewall_name'
        status:
          $ref: '#/components/schemas/firewall_status'
        zone_id:
          $ref: '#/components/schemas/firewall_identifier'
      required:
        - id
        - name
        - description
        - detection_mode
        - zone_id
      title: Traditional WAF package
    firewall_package_response_collection:
      anyOf:
        - $ref: '#/components/schemas/firewall_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/firewall_package'
              type: array
    firewall_package_response_single:
      oneOf:
        - $ref: '#/components/schemas/firewall_api-response-single'
        - properties:
            result:
              type: object
    firewall_paused:
      description: When true, indicates that the WAF package is currently paused.
      type: boolean
    firewall_period:
      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
      maximum: 86400
      minimum: 10
      type: number
    firewall_phase:
      description: The phase where the ruleset is executed.
      enum:
        - http_request_transform
        - http_request_late_transform
        - http_response_headers_transform
      type: string
    firewall_priority:
      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
      maximum: 1e+09
      minimum: -1e+09
      type: number
    firewall_products:
      items:
        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
        type: string
      type: array
    firewall_rate-limits:
      allOf:
        - $ref: '#/components/schemas/firewall_ratelimit'
      type: object
    firewall_ratelimit:
      properties:
        action:
          $ref: '#/components/schemas/firewall_action'
        bypass:
          $ref: '#/components/schemas/firewall_bypass'
        description:
          $ref: '#/components/schemas/firewall_description'
        disabled:
          $ref: '#/components/schemas/firewall_disabled'
        id:
          $ref: '#/components/schemas/firewall_id'
        match:
          $ref: '#/components/schemas/firewall_match'
        period:
          $ref: '#/components/schemas/firewall_period'
        threshold:
          $ref: '#/components/schemas/firewall_threshold'
    firewall_ratelimit_response_collection:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/firewall_rate-limits'
              type: array
          type: object
    firewall_ratelimit_response_single:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-single'
        - properties:
            result:
              type: object
          type: object
    firewall_ref:
      description: A short reference tag. Allows you to select related firewall rules.
      example: MIR-31
      maxLength: 50
      type: string
    firewall_response_collection:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-collection'
        - properties:
            result:
              items:
                type: object
              type: array
          type: object
    firewall_response_single:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-single'
        - properties:
            result:
              type: object
          type: object
    firewall_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    firewall_rewrite_action:
      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/firewall_waf_rewrite_action'
        challenge:
          $ref: '#/components/schemas/firewall_waf_rewrite_action'
        default:
          $ref: '#/components/schemas/firewall_waf_rewrite_action'
        disable:
          $ref: '#/components/schemas/firewall_waf_rewrite_action'
        simulate:
          $ref: '#/components/schemas/firewall_waf_rewrite_action'
      type: object
    firewall_rule:
      properties:
        allowed_modes:
          description: The available actions that a rule can apply to a matched request.
          example:
            - whitelist
            - block
            - challenge
            - js_challenge
            - managed_challenge
          items:
            $ref: '#/components/schemas/firewall_schemas-mode'
          readOnly: true
          type: array
        configuration:
          $ref: '#/components/schemas/firewall_configuration'
        created_on:
          description: The timestamp of when the rule was created.
          example: "2014-01-01T05:20:00.12345Z"
          format: date-time
          readOnly: true
          type: string
        id:
          $ref: '#/components/schemas/firewall_schemas-identifier'
        mode:
          $ref: '#/components/schemas/firewall_schemas-mode'
        modified_on:
          description: The timestamp of when the rule was last modified.
          example: "2014-01-01T05:20:00.12345Z"
          format: date-time
          readOnly: true
          type: string
        notes:
          $ref: '#/components/schemas/firewall_notes'
      required:
        - id
        - mode
        - allowed_modes
        - configuration
      type: object
    firewall_rule_collection_response:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/firewall_rule'
              type: array
    firewall_rule_single_id_response:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/firewall_schemas-identifier'
              type: object
    firewall_rule_single_response:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/firewall_rule'
    firewall_rules:
      additionalProperties:
        allOf:
          - $ref: '#/components/schemas/firewall_waf_action'
        example: default
      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
      type: object
    firewall_rules_components-schemas-description:
      default: ""
      description: An informative description of the rule.
      example: Execute the OWASP ruleset when the IP address is not 1.1.1.1
      type: string
    firewall_ruleset:
      properties:
        description:
          example: ""
        id:
          example: 2f2feab2026849078ba485f918791bdc
        kind:
          example: zone
        name:
          example: default
        phase:
          example: http_request_origin
        rules:
          description: The rules in the ruleset.
          items:
            $ref: '#/components/schemas/firewall_components-schemas-rule'
          type: array
    firewall_rulesets_components-schemas-description:
      default: ""
      description: An informative description of the ruleset.
      example: My ruleset to execute managed rulesets
      type: string
    firewall_schemas-action:
      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
      type: string
    firewall_schemas-action_parameters:
      description: The parameters configuring the rule action.
      example:
        id: 4814384a9e5d4991b9815dcfc25d2f1f
      type: object
    firewall_schemas-cidr_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:
          description: The IP address range to match. You can only use prefix lengths `/16` and `/24`.
          example: 198.51.100.4/16
          type: string
      title: An IP address range configuration.
    firewall_schemas-configuration:
      description: The configuration object for the current rule.
      properties:
        target:
          description: The configuration target for this rule. You must set the target to `ua` for User Agent Blocking rules.
          example: ua
          type: string
        value:
          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
          type: string
      type: object
    firewall_schemas-description:
      description: A summary of the purpose/function of the WAF package.
      example: "null"
      readOnly: true
      type: string
    firewall_schemas-description_search:
      description: A string to search for in the description of existing rules.
      example: endpoints
      type: string
    firewall_schemas-expression:
      description: The expression defining which traffic will match the rule.
      example: ip.src ne 1.1.1.1
      type: string
    firewall_schemas-id:
      description: The unique identifier of the WAF override.
      example: de677e5818985db1285d0e80225f06e5
      maxLength: 32
      readOnly: true
      type: string
    firewall_schemas-identifier:
      description: The unique identifier of the IP Access rule.
      example: 92f17202ed8bd63d69a66b86a49a8f6b
      maxLength: 32
      readOnly: true
      type: string
    firewall_schemas-ip_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:
          description: The IP address to match. This address will be compared to the IP address of incoming requests.
          example: 198.51.100.4
          type: string
      title: An IP address configuration.
    firewall_schemas-mode:
      description: The action to apply to a matched request.
      enum:
        - block
        - challenge
        - whitelist
        - js_challenge
        - managed_challenge
      example: challenge
      type: string
    firewall_schemas-paused:
      description: When true, indicates that the rule is currently paused.
      example: false
      type: boolean
    firewall_schemas-priority:
      description: The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority.
      example: 5
      type: number
    firewall_schemas-ref:
      description: A short reference tag. Allows you to select related filters.
      example: FIL-100
      maxLength: 50
      type: string
    firewall_schemas-rule:
      allOf:
        - $ref: '#/components/schemas/firewall_rule'
        - properties:
            scope:
              description: All zones owned by the user will have the rule applied.
              properties:
                email:
                  $ref: '#/components/schemas/firewall_email'
                id:
                  $ref: '#/components/schemas/firewall_identifier'
                type:
                  description: The scope of the rule.
                  enum:
                    - user
                    - organization
                  example: user
                  readOnly: true
              readOnly: true
              type: object
      required:
        - id
        - mode
        - allowed_modes
        - configuration
        - scope
      type: object
    firewall_schemas-ruleset:
      properties:
        description:
          example: ""
        id:
          example: 2f2feab2026849078ba485f918791bdc
        kind:
          example: zone
        name:
          example: default
        phase:
          example: http_request_dynamic_redirect
        rules:
          description: The rules in the ruleset.
          items:
            $ref: '#/components/schemas/firewall_dynamic-redirect-rules_components-schemas-rule'
          type: array
    firewall_schemas-urls:
      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:
        example: api.mysite.com/some/endpoint*
        type: string
      type: array
    firewall_schemes:
      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:
        description: An HTTP scheme or `_ALL_` to indicate all schemes.
        example: HTTPS
        type: string
      type: array
    firewall_sensitivity:
      default: high
      description: The sensitivity of the WAF package.
      enum:
        - high
        - medium
        - low
        - "off"
      type: string
    firewall_status:
      default: active
      description: When set to `active`, indicates that the WAF package will be applied to the zone.
      enum:
        - active
      readOnly: true
      type: string
    firewall_threshold:
      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
      type: number
    firewall_timeout:
      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
      maximum: 86400
      minimum: 1
      type: number
    firewall_transform-rules_components-schemas-action_parameters:
      description: The parameters configuring the action.
      oneOf:
        - $ref: '#/components/schemas/firewall_action_parameters_rewrite'
      type: object
    firewall_transform-rules_components-schemas-rule:
      properties:
        action:
          example: rewrite
        action_parameters:
          $ref: '#/components/schemas/firewall_transform-rules_components-schemas-action_parameters'
        description:
          example: change request based on ip location
        expression:
          example: ip.geoip.country eq "AL"
        id:
          example: 3a03d665bac047339bb530ecb439a90d
        version:
          example: "1"
    firewall_transform-rules_components-schemas-ruleset:
      properties:
        description:
          example: ""
        id:
          example: 2f2feab2026849078ba485f918791bdc
        kind:
          example: zone
        name:
          example: default
        phase:
          example: http_request_transform
        rules:
          description: The rules in the ruleset.
          items:
            $ref: '#/components/schemas/firewall_transform-rules_components-schemas-rule'
          type: array
    firewall_ua-rules:
      allOf:
        - $ref: '#/components/schemas/firewall_firewalluablock'
      type: object
    firewall_ua-rules_components-schemas-description:
      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
      type: string
    firewall_update_ruleset:
      description: A ruleset object.
      properties:
        description:
          $ref: '#/components/schemas/firewall_rulesets_components-schemas-description'
        rules:
          $ref: '#/components/schemas/firewall_create_update_rules'
      required:
        - rules
      type: object
    firewall_uri_search:
      description: A single URI to search for in the list of URLs of existing rules.
      example: /some/path
      type: string
    firewall_url:
      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
      type: string
    firewall_urls:
      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:
        example: shop.example.com/*
        type: string
      type: array
    firewall_waf_action:
      description: The WAF rule action to apply.
      enum:
        - challenge
        - block
        - simulate
        - disable
        - default
    firewall_waf_rewrite_action:
      description: The WAF rule action to apply.
      enum:
        - challenge
        - block
        - simulate
        - disable
        - default
    firewall_zonelockdown:
      additionalProperties: false
      properties:
        configurations:
          $ref: '#/components/schemas/firewall_configurations'
        created_on:
          $ref: '#/components/schemas/firewall_created_on'
        description:
          $ref: '#/components/schemas/firewall_lockdowns_components-schemas-description'
        id:
          $ref: '#/components/schemas/firewall_lockdowns_components-schemas-id'
        modified_on:
          $ref: '#/components/schemas/firewall_modified_on'
        paused:
          $ref: '#/components/schemas/firewall_schemas-paused'
        urls:
          $ref: '#/components/schemas/firewall_schemas-urls'
      required:
        - id
        - created_on
        - modified_on
        - paused
        - description
        - urls
        - configurations
    firewall_zonelockdown_response_collection:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/firewall_zonelockdown'
              type: array
          required:
            - result
          type: object
    firewall_zonelockdown_response_single:
      allOf:
        - $ref: '#/components/schemas/firewall_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/firewall_zonelockdown'
          required:
            - result
          type: object
    healthchecks_address:
      description: The hostname or IP address of the origin server to run health checks on.
      example: www.example.com
      type: string
    healthchecks_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/healthchecks_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/healthchecks_result_info'
      type: object
    healthchecks_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/healthchecks_messages'
        messages:
          $ref: '#/components/schemas/healthchecks_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    healthchecks_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/healthchecks_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/healthchecks_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    healthchecks_api-response-single:
      allOf:
        - $ref: '#/components/schemas/healthchecks_api-response-common'
        - properties:
            result:
              oneOf:
                - type: object
                - type: string
      type: object
    healthchecks_check_regions:
      description: A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
      example:
        - WEU
        - ENAM
      items:
        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
        type: string
      nullable: true
      type: array
    healthchecks_consecutive_fails:
      default: 1
      description: The number of consecutive fails required from a health check before changing the health to unhealthy.
      type: integer
    healthchecks_consecutive_successes:
      default: 1
      description: The number of consecutive successes required from a health check before changing the health to healthy.
      type: integer
    healthchecks_description:
      description: A human-readable description of the health check.
      example: Health check for www.example.com
      type: string
    healthchecks_failure_reason:
      description: The current failure reason if status is unhealthy.
      example: ""
      readOnly: true
      type: string
    healthchecks_healthchecks:
      properties:
        address:
          $ref: '#/components/schemas/healthchecks_address'
        check_regions:
          $ref: '#/components/schemas/healthchecks_check_regions'
        consecutive_fails:
          $ref: '#/components/schemas/healthchecks_consecutive_fails'
        consecutive_successes:
          $ref: '#/components/schemas/healthchecks_consecutive_successes'
        created_on:
          $ref: '#/components/schemas/healthchecks_timestamp'
        description:
          $ref: '#/components/schemas/healthchecks_description'
        failure_reason:
          $ref: '#/components/schemas/healthchecks_failure_reason'
        http_config:
          $ref: '#/components/schemas/healthchecks_http_config'
        id:
          $ref: '#/components/schemas/healthchecks_identifier'
        interval:
          $ref: '#/components/schemas/healthchecks_interval'
        modified_on:
          $ref: '#/components/schemas/healthchecks_timestamp'
        name:
          $ref: '#/components/schemas/healthchecks_name'
        retries:
          $ref: '#/components/schemas/healthchecks_retries'
        status:
          $ref: '#/components/schemas/healthchecks_status'
        suspended:
          $ref: '#/components/schemas/healthchecks_suspended'
        tcp_config:
          $ref: '#/components/schemas/healthchecks_tcp_config'
        timeout:
          $ref: '#/components/schemas/healthchecks_timeout'
        type:
          $ref: '#/components/schemas/healthchecks_type'
      type: object
    healthchecks_http_config:
      description: Parameters specific to an HTTP or HTTPS health check.
      nullable: true
      properties:
        allow_insecure:
          default: false
          description: Do not validate the certificate when the health check uses HTTPS.
          type: boolean
        expected_body:
          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
          type: string
        expected_codes:
          default: "200"
          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.
          example:
            - 2xx
            - "302"
          items:
            type: string
          nullable: true
          type: array
        follow_redirects:
          default: false
          description: Follow redirects if the origin returns a 3xx status code.
          type: boolean
        header:
          additionalProperties:
            items:
              type: string
            type: array
          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
          type: object
        method:
          default: GET
          description: The HTTP method to use for the health check.
          enum:
            - GET
            - HEAD
          type: string
        path:
          default: /
          description: The endpoint path to health check against.
          example: /health
          type: string
        port:
          default: 80
          description: Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS.
          type: integer
      type: object
    healthchecks_id_response:
      allOf:
        - $ref: '#/components/schemas/healthchecks_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/healthchecks_identifier'
              type: object
    healthchecks_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    healthchecks_interval:
      default: 60
      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.
      type: integer
    healthchecks_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    healthchecks_name:
      description: A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
      example: server-1
      type: string
    healthchecks_query_healthcheck:
      properties:
        address:
          $ref: '#/components/schemas/healthchecks_address'
        check_regions:
          $ref: '#/components/schemas/healthchecks_check_regions'
        consecutive_fails:
          $ref: '#/components/schemas/healthchecks_consecutive_fails'
        consecutive_successes:
          $ref: '#/components/schemas/healthchecks_consecutive_successes'
        description:
          $ref: '#/components/schemas/healthchecks_description'
        http_config:
          $ref: '#/components/schemas/healthchecks_http_config'
        interval:
          $ref: '#/components/schemas/healthchecks_interval'
        name:
          $ref: '#/components/schemas/healthchecks_name'
        retries:
          $ref: '#/components/schemas/healthchecks_retries'
        suspended:
          $ref: '#/components/schemas/healthchecks_suspended'
        tcp_config:
          $ref: '#/components/schemas/healthchecks_tcp_config'
        timeout:
          $ref: '#/components/schemas/healthchecks_timeout'
        type:
          $ref: '#/components/schemas/healthchecks_type'
      required:
        - name
        - address
      type: object
    healthchecks_response_collection:
      allOf:
        - $ref: '#/components/schemas/healthchecks_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/healthchecks_healthchecks'
              type: array
    healthchecks_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    healthchecks_retries:
      default: 2
      description: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
      type: integer
    healthchecks_single_response:
      allOf:
        - $ref: '#/components/schemas/healthchecks_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/healthchecks_healthchecks'
    healthchecks_status:
      description: The current status of the origin server according to the health check.
      enum:
        - unknown
        - healthy
        - unhealthy
        - suspended
      example: healthy
      readOnly: true
      type: string
    healthchecks_suspended:
      default: false
      description: If suspended, no health checks are sent to the origin.
      type: boolean
    healthchecks_tcp_config:
      description: Parameters specific to TCP health check.
      nullable: true
      properties:
        method:
          default: connection_established
          description: The TCP connection method to use for the health check.
          enum:
            - connection_established
          type: string
        port:
          default: 80
          description: Port number to connect to for the health check. Defaults to 80.
          type: integer
      type: object
    healthchecks_timeout:
      default: 5
      description: The timeout (in seconds) before marking the health check as failed.
      type: integer
    healthchecks_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      readOnly: true
      type: string
    healthchecks_type:
      default: HTTP
      description: The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
      example: HTTPS
      type: string
    hyperdrive_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/hyperdrive_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/hyperdrive_result_info'
      type: object
    hyperdrive_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/hyperdrive_messages'
        messages:
          $ref: '#/components/schemas/hyperdrive_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    hyperdrive_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/hyperdrive_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/hyperdrive_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    hyperdrive_api-response-single:
      allOf:
        - $ref: '#/components/schemas/hyperdrive_api-response-common'
        - properties:
            result:
              anyOf:
                - type: object
                - type: string
              nullable: true
              type: object
      type: object
    hyperdrive_create-update-hyperdrive-config:
      allOf:
        - $ref: '#/components/schemas/hyperdrive_hyperdrive'
      properties:
        origin:
          $ref: '#/components/schemas/hyperdrive_hyperdrive-origin-with-secrets'
      required:
        - name
        - origin
      type: object
    hyperdrive_hyperdrive:
      properties:
        caching:
          $ref: '#/components/schemas/hyperdrive_hyperdrive-caching'
        name:
          $ref: '#/components/schemas/hyperdrive_hyperdrive-name'
        origin:
          $ref: '#/components/schemas/hyperdrive_hyperdrive-origin'
      type: object
    hyperdrive_hyperdrive-caching:
      properties:
        disabled:
          description: 'When set to true, disables the caching of SQL responses. (Default: false)'
          example: false
          type: boolean
        max_age:
          description: 'When present, specifies max duration for which items should persist in the cache. (Default: 60)'
          example: 60
          type: integer
        stale_while_revalidate:
          description: 'When present, indicates the number of seconds cache may serve the response after it becomes stale. (Default: 15)'
          example: 15
          type: integer
      type: object
    hyperdrive_hyperdrive-name:
      example: example-hyperdrive
      type: string
    hyperdrive_hyperdrive-origin:
      properties:
        access_client_id:
          description: The Client ID of the Access token to use when connecting to the origin database
          example: 0123456789abcdef0123456789abcdef.access
          type: string
        database:
          description: The name of your origin database.
          example: postgres
          type: string
        host:
          description: The host (hostname or IP) of your origin database.
          example: database.example.com
          type: string
        port:
          description: 'The port (default: 5432 for Postgres) of your origin database.'
          example: "5432"
          type: integer
        scheme:
          $ref: '#/components/schemas/hyperdrive_hyperdrive-scheme'
        user:
          description: The user of your origin database.
          example: postgres
          type: string
      required:
        - host
        - scheme
        - database
        - user
      type: object
    hyperdrive_hyperdrive-origin-with-secrets:
      allOf:
        - $ref: '#/components/schemas/hyperdrive_hyperdrive-origin'
      properties:
        access_client_secret:
          description: The Client Secret of the Access token to use when connecting to the origin database
          example: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
          type: string
        password:
          description: The password required to access your origin database. This value is write-only and never returned by the API.
          example: password1234!
          type: string
      required:
        - password
      type: object
    hyperdrive_hyperdrive-scheme:
      default: postgres
      description: Specifies the URL scheme used to connect to your origin database.
      enum:
        - postgres
        - postgresql
        - mysql
      type: string
    hyperdrive_hyperdrive-with-identifier:
      allOf:
        - $ref: '#/components/schemas/hyperdrive_hyperdrive'
      properties:
        id:
          $ref: '#/components/schemas/hyperdrive_identifier'
      type: object
    hyperdrive_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    hyperdrive_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    hyperdrive_patch-hyperdrive-config:
      allOf:
        - $ref: '#/components/schemas/hyperdrive_hyperdrive'
      properties:
        origin:
          $ref: '#/components/schemas/hyperdrive_hyperdrive-origin-with-secrets'
      type: object
    hyperdrive_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    iam_access:
      description: Allow or deny operations against the resources.
      enum:
        - allow
        - deny
      example: allow
      type: string
    iam_account:
      properties:
        created_on:
          description: Timestamp for the creation of the account
          example: "2014-03-01T12:21:02.0000Z"
          format: date-time
          readOnly: true
          type: string
        id:
          $ref: '#/components/schemas/iam_common_components-schemas-identifier'
        name:
          description: Account name
          example: Demo Account
          maxLength: 100
          type: string
        settings:
          description: Account settings
          properties:
            abuse_contact_email:
              description: Sets an abuse contact email to notify for abuse reports.
              type: string
            default_nameservers:
              default: cloudflare.standard
              description: |-
                Specifies the default nameservers to be used for new zones added to this account.

                - `cloudflare.standard` for Cloudflare-branded nameservers
                - `custom.account` for account custom nameservers
                - `custom.tenant` for tenant custom nameservers

                See [Custom Nameservers](https://developers.cloudflare.com/dns/additional-options/custom-nameservers/)
                for more information.
              enum:
                - cloudflare.standard
                - custom.account
                - custom.tenant
              type: string
            enforce_twofactor:
              default: false
              description: |-
                Indicates whether membership in this account requires that
                Two-Factor Authentication is enabled
              type: boolean
            use_account_custom_ns_by_default:
              default: false
              deprecated: true
              description: |-
                Indicates whether new zones should use the account-level custom
                nameservers by default.

                Deprecated in favor of `default_nameservers`.
              type: boolean
          type: object
      required:
        - id
        - name
      type: object
    iam_account_identifier:
      description: Account identifier tag.
      example: eb78d65290b24279ba6f44721b3ea3c4
      maxLength: 32
      readOnly: true
      type: string
    iam_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/iam_result_info'
      type: object
    iam_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/iam_messages'
        messages:
          $ref: '#/components/schemas/iam_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    iam_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/iam_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/iam_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    iam_api-response-single:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-common'
      type: object
    iam_api-response-single-id:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                id:
                  $ref: '#/components/schemas/iam_common_components-schemas-identifier'
              required:
                - id
              type: object
      type: object
    iam_api_access_enabled:
      description: Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.
      example: true
      nullable: true
      type: boolean
    iam_base:
      properties:
        expires_on:
          $ref: '#/components/schemas/iam_schemas-expires_on'
        id:
          $ref: '#/components/schemas/iam_invite_components-schemas-identifier'
        invited_by:
          $ref: '#/components/schemas/iam_invited_by'
        invited_member_email:
          $ref: '#/components/schemas/iam_invited_member_email'
        invited_member_id:
          description: ID of the user to add to the organization.
          example: 5a7805061c76ada191ed06f989cc3dac
          maxLength: 32
          nullable: true
          readOnly: true
          type: string
        invited_on:
          $ref: '#/components/schemas/iam_invited_on'
        organization_id:
          description: ID of the organization the user will be added to.
          example: 5a7805061c76ada191ed06f989cc3dac
          maxLength: 32
          readOnly: true
          type: string
        organization_name:
          description: Organization name.
          example: Cloudflare, Inc.
          maxLength: 100
          readOnly: true
          type: string
        roles:
          description: Roles to be assigned to this user.
          items:
            $ref: '#/components/schemas/iam_schemas-role'
          type: array
      required:
        - invited_member_id
        - organization_id
      type: object
    iam_cidr_list:
      description: List of IPv4/IPv6 CIDR addresses.
      example:
        - 199.27.128.0/21
        - 2400:cb00::/32
      items:
        description: IPv4/IPv6 CIDR.
        example: 199.27.128.0/21
        type: string
      type: array
    iam_code:
      description: The unique activation code for the account membership.
      example: 05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0
      maxLength: 64
      readOnly: true
      type: string
    iam_collection_invite_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/iam_invite'
              type: array
          type: object
    iam_collection_member_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/iam_member'
              type: array
          type: object
      title: members_with_roles
    iam_collection_member_response_with_policies:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/iam_member_with_policies'
              type: array
          type: object
      title: Members with Policies
    iam_collection_membership_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/iam_membership'
              type: array
          type: object
      title: memberships_with_roles
    iam_collection_membership_response_with_policies:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/iam_membership-with-policies'
              type: array
          type: object
      title: memberships_with_policies
    iam_collection_organization_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/iam_organization'
              type: array
          type: object
    iam_collection_permission_groups_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              $ref: '#/components/schemas/iam_permission_groups'
          type: object
      title: List of Resource groups
    iam_collection_resource_groups_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              $ref: '#/components/schemas/iam_resource_groups'
          type: object
      title: List of Resource groups
    iam_collection_role_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/iam_schemas-role'
              type: array
          type: object
    iam_collection_tokens_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/iam_token_base'
              type: array
          type: object
      title: Response with a list of tokens
    iam_common_components-schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    iam_components-schemas-account:
      allOf:
        - $ref: '#/components/schemas/iam_account'
    iam_components-schemas-name:
      description: Role Name.
      example: Organization Admin
      maxLength: 120
      readOnly: true
      type: string
    iam_components-schemas-status:
      description: Whether the user is a member of the organization or has an invitation pending.
      enum:
        - member
        - invited
      example: member
      type: string
    iam_condition:
      properties:
        request.ip:
          $ref: '#/components/schemas/iam_request_ip'
      type: object
    iam_country:
      description: The country in which the user lives.
      example: US
      maxLength: 30
      nullable: true
      type: string
    iam_create-account:
      properties:
        name:
          description: Account name
          type: string
        type:
          description: the type of account being created. For self-serve customers, use standard. for enterprise customers, use enterprise.
          enum:
            - standard
            - enterprise
          example: standard
        unit:
          description: information related to the tenant unit, and optionally, an id of the unit to create the account on. see https://developers.cloudflare.com/tenant/how-to/manage-accounts/
          properties:
            id:
              description: Tenant unit ID
              example: f267e341f3dd4697bd3b9f71dd96247f
              type: string
          type: object
      required:
        - name
        - type
      title: Create account
      type: object
    iam_create-member-with-policies:
      properties:
        email:
          $ref: '#/components/schemas/iam_email'
        policies:
          description: Array of policies associated with this member.
          items:
            $ref: '#/components/schemas/iam_create_member_policy'
          type: array
        status:
          default: pending
          enum:
            - accepted
            - pending
      required:
        - email
        - policies
      title: Add Member with Policies
      type: object
    iam_create-member-with-roles:
      properties:
        email:
          $ref: '#/components/schemas/iam_email'
        roles:
          description: Array of roles associated with this member.
          items:
            $ref: '#/components/schemas/iam_role_components-schemas-identifier'
          type: array
        status:
          default: pending
          enum:
            - accepted
            - pending
      required:
        - email
        - roles
      title: Add Member with Account Roles
      type: object
    iam_create-scope:
      description: A scope is a combination of scope objects which provides additional context.
      properties:
        key:
          $ref: '#/components/schemas/iam_create_resource_group_scope_scope_key'
        objects:
          description: A list of scope objects for additional context. The number of Scope objects should not be zero.
          items:
            $ref: '#/components/schemas/iam_create_resource_group_scope_scope_object'
          type: array
      required:
        - key
        - objects
      type: object
    iam_create_member_policy:
      properties:
        access:
          $ref: '#/components/schemas/iam_access'
        id:
          $ref: '#/components/schemas/iam_identifier'
        permission_groups:
          $ref: '#/components/schemas/iam_member_permission_groups'
        resource_groups:
          $ref: '#/components/schemas/iam_member_resource_groups'
      required:
        - id
        - access
        - permission_groups
        - resource_groups
      title: create_member_policy
    iam_create_payload:
      properties:
        condition:
          $ref: '#/components/schemas/iam_condition'
        expires_on:
          $ref: '#/components/schemas/iam_expires_on'
        name:
          $ref: '#/components/schemas/iam_name'
        not_before:
          $ref: '#/components/schemas/iam_not_before'
        policies:
          $ref: '#/components/schemas/iam_token_policies'
      required:
        - name
        - policies
      type: object
    iam_create_resource_group:
      properties:
        meta:
          description: Attributes associated to the resource group.
          example:
            editable: "false"
          type: object
        name:
          description: Name of the resource group.
          example: NameOfTheResourceGroup
          readOnly: true
          type: string
        scope:
          $ref: '#/components/schemas/iam_create-scope'
      required:
        - scope
      type: object
    iam_create_resource_group_scope_scope_key:
      description: This is a combination of pre-defined resource name and identifier (like Account ID etc.)
      example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4
    iam_create_resource_group_scope_scope_object:
      description: A scope object represents any resource that can have actions applied against invite.
      properties:
        key:
          $ref: '#/components/schemas/iam_create_resource_group_scope_scope_object_key'
      required:
        - key
      type: object
    iam_create_resource_group_scope_scope_object_key:
      description: This is a combination of pre-defined resource name and identifier (like Zone ID etc.)
      example: com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5
    iam_created_resource_group_response:
      description: A group of scoped resources.
      properties:
        id:
          description: Identifier of the group.
          example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
          readOnly: true
          type: string
        meta:
          description: Attributes associated to the resource group.
          example:
            editable: "false"
          type: object
        scope:
          $ref: '#/components/schemas/iam_create-scope'
      type: object
    iam_description:
      description: Description of role's permissions.
      example: Administrative access to the entire Organization
      readOnly: true
      type: string
    iam_effect:
      description: Allow or deny operations against the resources.
      enum:
        - allow
        - deny
      example: allow
      type: string
    iam_email:
      description: The contact email address of the user.
      example: user@example.com
      maxLength: 90
      type: string
    iam_expires_on:
      description: The expiration time on or after which the JWT MUST NOT be accepted for processing.
      example: "2020-01-01T00:00:00Z"
      format: date-time
      type: string
    iam_first_name:
      description: User's first name
      example: John
      maxLength: 60
      nullable: true
      type: string
    iam_grants:
      example:
        read: true
        write: false
      properties:
        read:
          example: true
          type: boolean
        write:
          example: true
          type: boolean
      type: object
    iam_identifier:
      description: Policy identifier.
      example: f267e341f3dd4697bd3b9f71dd96247f
      readOnly: true
      type: string
    iam_invite:
      allOf:
        - $ref: '#/components/schemas/iam_organization_invite'
      type: object
    iam_invite_components-schemas-identifier:
      description: Invite identifier tag.
      example: 4f5f0c14a2a41d5063dd301b2f829f04
      maxLength: 32
      readOnly: true
      type: string
    iam_invited_by:
      description: The email address of the user who created the invite.
      example: user@example.com
      maxLength: 90
      type: string
    iam_invited_member_email:
      description: Email address of the user to add to the organization.
      example: user@example.com
      maxLength: 90
      type: string
    iam_invited_on:
      description: When the invite was sent.
      example: "2014-01-01T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    iam_issued_on:
      description: The time on which the token was created.
      example: "2018-07-01T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    iam_last_name:
      description: User's last name
      example: Appleseed
      maxLength: 60
      nullable: true
      type: string
    iam_last_used_on:
      description: Last time the token was used.
      example: "2020-01-02T12:34:00Z"
      format: date-time
      readOnly: true
      type: string
    iam_list_member_policy:
      properties:
        access:
          $ref: '#/components/schemas/iam_access'
        id:
          $ref: '#/components/schemas/iam_identifier'
        permission_groups:
          $ref: '#/components/schemas/iam_permission_groups'
        resource_groups:
          $ref: '#/components/schemas/iam_resource_groups'
      title: list_member_policy
    iam_member:
      properties:
        id:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
        roles:
          description: Roles assigned to this member.
          items:
            $ref: '#/components/schemas/iam_role'
          type: array
        status:
          description: A member's status in the account.
          enum:
            - accepted
            - pending
          example: accepted
          readOnly: true
        user:
          description: Details of the user associated to the membership.
          properties:
            email:
              $ref: '#/components/schemas/iam_email'
            first_name:
              $ref: '#/components/schemas/iam_first_name'
            id:
              $ref: '#/components/schemas/iam_common_components-schemas-identifier'
            last_name:
              $ref: '#/components/schemas/iam_last_name'
            two_factor_authentication_enabled:
              $ref: '#/components/schemas/iam_two_factor_authentication_enabled'
          readOnly: true
          required:
            - email
          type: object
      type: object
    iam_member_permission_group:
      description: A group of permissions.
      properties:
        id:
          description: Identifier of the group.
          example: c8fed203ed3043cba015a93ad1616f1f
          type: string
      required:
        - id
      type: object
    iam_member_permission_groups:
      description: A set of permission groups that are specified to the policy.
      example:
        - id: c8fed203ed3043cba015a93ad1616f1f
        - id: 82e64a83756745bbbb1c9c2701bf816b
      items:
        $ref: '#/components/schemas/iam_member_permission_group'
      type: array
    iam_member_resource_group:
      description: A group of scoped resources.
      properties:
        id:
          description: Identifier of the group.
          example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
          type: string
      required:
        - id
      type: object
    iam_member_resource_groups:
      description: A list of resource groups that the policy applies to.
      items:
        $ref: '#/components/schemas/iam_member_resource_group'
      type: array
    iam_member_with_code:
      allOf:
        - $ref: '#/components/schemas/iam_member'
        - properties:
            code:
              $ref: '#/components/schemas/iam_code'
          type: object
    iam_member_with_policies:
      properties:
        id:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
        policies:
          description: Access policy for the membership
          items:
            $ref: '#/components/schemas/iam_list_member_policy'
          type: array
        roles:
          description: Roles assigned to this Member.
          items:
            $ref: '#/components/schemas/iam_schemas-role'
          type: array
        status:
          description: A member's status in the account.
          enum:
            - accepted
            - pending
          example: accepted
          readOnly: true
        user:
          description: Details of the user associated to the membership.
          properties:
            email:
              $ref: '#/components/schemas/iam_email'
            first_name:
              $ref: '#/components/schemas/iam_first_name'
            id:
              $ref: '#/components/schemas/iam_common_components-schemas-identifier'
            last_name:
              $ref: '#/components/schemas/iam_last_name'
            two_factor_authentication_enabled:
              $ref: '#/components/schemas/iam_two_factor_authentication_enabled'
          readOnly: true
          required:
            - email
          type: object
      type: object
    iam_membership:
      properties:
        account:
          $ref: '#/components/schemas/iam_schemas-account'
        api_access_enabled:
          $ref: '#/components/schemas/iam_api_access_enabled'
        id:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
        permissions:
          allOf:
            - $ref: '#/components/schemas/iam_permissions'
          description: All access permissions for the user at the account.
          readOnly: true
        roles:
          $ref: '#/components/schemas/iam_roles'
        status:
          $ref: '#/components/schemas/iam_schemas-status'
      type: object
    iam_membership-with-policies:
      properties:
        account:
          $ref: '#/components/schemas/iam_schemas-account'
        api_access_enabled:
          $ref: '#/components/schemas/iam_api_access_enabled'
        id:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
        permissions:
          allOf:
            - $ref: '#/components/schemas/iam_permissions'
          description: All access permissions for the user at the account.
          readOnly: true
        policies:
          description: Access policy for the membership
          items:
            $ref: '#/components/schemas/iam_list_member_policy'
          type: array
        roles:
          $ref: '#/components/schemas/iam_roles'
        status:
          $ref: '#/components/schemas/iam_schemas-status'
      type: object
    iam_membership_components-schemas-identifier:
      description: Membership identifier tag.
      example: 4536bcfad5faccb111b47003c79917fa
      maxLength: 32
      readOnly: true
      type: string
    iam_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    iam_modified_on:
      description: Last time the token was modified.
      example: "2018-07-02T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    iam_name:
      description: Token name.
      example: readonly token
      maxLength: 120
      type: string
    iam_not_before:
      description: The time before which the token MUST NOT be accepted for processing.
      example: "2018-07-01T05:20:00Z"
      format: date-time
      type: string
    iam_organization:
      properties:
        id:
          $ref: '#/components/schemas/iam_common_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/iam_schemas-name'
        permissions:
          $ref: '#/components/schemas/iam_schemas-permissions'
        roles:
          description: List of roles that a user has within an organization.
          items:
            example: All Privileges - Super Administrator
            maxLength: 120
            type: string
          readOnly: true
          type: array
        status:
          $ref: '#/components/schemas/iam_components-schemas-status'
      type: object
    iam_organization_invite:
      allOf:
        - $ref: '#/components/schemas/iam_base'
        - properties:
            organization_is_enforcing_twofactor:
              default: false
              description: Current status of two-factor enforcement on the organization.
              example: true
              type: boolean
            status:
              description: Current status of the invitation.
              enum:
                - pending
                - accepted
                - rejected
                - canceled
                - left
                - expired
              example: accepted
              type: string
    iam_permission_group:
      description: A named group of permissions that map to a group of operations against resources.
      properties:
        id:
          description: Identifier of the group.
          example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
          readOnly: true
          type: string
        meta:
          description: Attributes associated to the permission group.
          example:
            label: load_balancer_admin
            scopes: com.cloudflare.api.account
          properties:
            key:
              type: string
            value:
              type: string
          type: object
        name:
          description: Name of the group.
          example: Load Balancer
          readOnly: true
          type: string
      required:
        - id
      type: object
    iam_permission_group_components-schemas-identifier:
      description: Permission Group identifier tag.
      example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
      maxLength: 32
      readOnly: true
      type: string
    iam_permission_groups:
      description: A set of permission groups that are specified to the policy.
      example:
        - id: c8fed203ed3043cba015a93ad1616f1f
          meta:
            label: load_balancer_admin
            scopes: com.cloudflare.api.account
          name: Zone Read
        - id: 82e64a83756745bbbb1c9c2701bf816b
          meta:
            label: fbm_user
            scopes: com.cloudflare.api.account
          name: Magic Network Monitoring
      items:
        $ref: '#/components/schemas/iam_permission_group'
      type: array
    iam_permissions:
      example:
        analytics:
          read: true
          write: false
        zones:
          read: true
          write: true
      properties:
        analytics:
          $ref: '#/components/schemas/iam_grants'
        billing:
          $ref: '#/components/schemas/iam_grants'
        cache_purge:
          $ref: '#/components/schemas/iam_grants'
        dns:
          $ref: '#/components/schemas/iam_grants'
        dns_records:
          $ref: '#/components/schemas/iam_grants'
        lb:
          $ref: '#/components/schemas/iam_grants'
        logs:
          $ref: '#/components/schemas/iam_grants'
        organization:
          $ref: '#/components/schemas/iam_grants'
        ssl:
          $ref: '#/components/schemas/iam_grants'
        waf:
          $ref: '#/components/schemas/iam_grants'
        zone_settings:
          $ref: '#/components/schemas/iam_grants'
        zones:
          $ref: '#/components/schemas/iam_grants'
      type: object
    iam_policy_with_permission_groups_and_resources:
      properties:
        effect:
          $ref: '#/components/schemas/iam_effect'
        id:
          $ref: '#/components/schemas/iam_identifier'
        permission_groups:
          $ref: '#/components/schemas/iam_permission_groups'
        resources:
          $ref: '#/components/schemas/iam_resources'
      required:
        - id
        - effect
        - permission_groups
        - resources
      title: Policy with Permission Groups and Resources
      type: object
    iam_properties-name:
      description: Account name
      example: Demo Account
      maxLength: 100
      type: string
    iam_request_ip:
      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/iam_cidr_list'
        not_in:
          $ref: '#/components/schemas/iam_cidr_list'
      type: object
    iam_resource_group:
      description: A group of scoped resources.
      properties:
        id:
          description: Identifier of the group.
          example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
          readOnly: true
          type: string
        meta:
          description: Attributes associated to the resource group.
          example:
            editable: "false"
          properties:
            key:
              type: string
            value:
              type: string
          type: object
        name:
          description: Name of the resource group.
          example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4
          readOnly: true
          type: string
        scope:
          description: The scope associated to the resource group
          items:
            $ref: '#/components/schemas/iam_scope'
          type: array
      required:
        - id
        - scope
      type: object
    iam_resource_group_components-schemas-identifier:
      description: Resource Group identifier tag.
      example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
      maxLength: 32
      readOnly: true
      type: string
    iam_resource_groups:
      description: A list of resource groups that the policy applies to.
      items:
        $ref: '#/components/schemas/iam_resource_group'
      type: array
    iam_resources:
      description: A list of resource names that the policy applies to.
      example:
        com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43: '*'
        com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4: '*'
      properties:
        resource:
          type: string
        scope:
          type: string
      type: object
    iam_response_collection:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              items:
                type: object
              type: array
          type: object
    iam_response_collection_accounts:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/iam_account'
              type: array
          type: object
      title: Response with a list of accounts
    iam_response_create:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              allOf:
                - type: object
                - properties:
                    value:
                      $ref: '#/components/schemas/iam_value'
                  type: object
          type: object
    iam_response_single:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              type: object
          type: object
    iam_response_single_account:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/iam_account'
          type: object
      title: Response with a single account
    iam_response_single_segment:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              properties:
                expires_on:
                  $ref: '#/components/schemas/iam_expires_on'
                id:
                  $ref: '#/components/schemas/iam_token_identifier'
                not_before:
                  $ref: '#/components/schemas/iam_not_before'
                status:
                  $ref: '#/components/schemas/iam_status'
              required:
                - id
                - status
          type: object
    iam_response_single_value:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/iam_value'
          type: object
    iam_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    iam_role:
      properties:
        description:
          description: Description of role's permissions.
          example: Administrative access to the entire Account
          readOnly: true
          type: string
        id:
          $ref: '#/components/schemas/iam_role_components-schemas-identifier'
        name:
          description: Role name.
          example: Account Administrator
          maxLength: 120
          readOnly: true
          type: string
        permissions:
          allOf:
            - $ref: '#/components/schemas/iam_permissions'
            - readOnly: true
      required:
        - id
        - name
        - description
        - permissions
      type: object
    iam_role_components-schemas-identifier:
      description: Role identifier tag.
      example: 3536bcfad5faccb999b47003c79917fb
      maxLength: 32
      type: string
    iam_roles:
      description: List of role names for the user at the account.
      items:
        example: Account Administrator
        maxLength: 120
        type: string
      readOnly: true
      type: array
    iam_schemas-account:
      allOf:
        - $ref: '#/components/schemas/iam_account'
      readOnly: true
    iam_schemas-collection_invite_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/iam_schemas-invite'
              type: array
          type: object
    iam_schemas-expires_on:
      description: When the invite is no longer active.
      example: "2014-01-01T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    iam_schemas-invite:
      allOf:
        - $ref: '#/components/schemas/iam_user_invite'
      type: object
    iam_schemas-name:
      description: Organization name.
      example: Cloudflare, Inc.
      maxLength: 100
      type: string
    iam_schemas-permissions:
      description: Access permissions for this User.
      items:
        example: '#zones:read'
        maxLength: 160
        type: string
      readOnly: true
      type: array
    iam_schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-collection'
        - properties:
            result:
              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
              type: array
          type: object
    iam_schemas-role:
      properties:
        description:
          $ref: '#/components/schemas/iam_description'
        id:
          $ref: '#/components/schemas/iam_role_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/iam_components-schemas-name'
        permissions:
          $ref: '#/components/schemas/iam_schemas-permissions'
      required:
        - id
        - name
        - description
        - permissions
      type: object
    iam_schemas-status:
      description: Status of this membership.
      enum:
        - accepted
        - pending
        - rejected
      example: accepted
      type: string
    iam_scope:
      description: A scope is a combination of scope objects which provides additional context.
      properties:
        key:
          $ref: '#/components/schemas/iam_scope_key'
        objects:
          description: A list of scope objects for additional context.
          items:
            $ref: '#/components/schemas/iam_scope_object'
          type: array
      required:
        - key
        - objects
      type: object
    iam_scope_key:
      description: This is a combination of pre-defined resource name and identifier (like Account ID etc.)
      example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4
      readOnly: true
    iam_scope_object:
      description: A scope object represents any resource that can have actions applied against invite.
      properties:
        key:
          $ref: '#/components/schemas/iam_scope_object_key'
      required:
        - key
      type: object
    iam_scope_object_key:
      description: This is a combination of pre-defined resource name and identifier (like Zone ID etc.)
      example: com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5
      readOnly: true
    iam_single_invite_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              type: object
          type: object
    iam_single_member_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/iam_member'
          type: object
      title: response_with_roles
    iam_single_member_response_with_code:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/iam_member_with_code'
          type: object
      title: response_with_roles
    iam_single_member_response_with_policies:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/iam_member_with_policies'
          type: object
      title: Response with Policies
    iam_single_membership_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/iam_membership'
          type: object
      title: response_with_roles
    iam_single_membership_response_with_policies:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/iam_membership-with-policies'
          type: object
      title: response_with_policies
    iam_single_organization_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              type: object
          type: object
    iam_single_role_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              type: object
          type: object
    iam_single_token_create_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/iam_token_with_value'
          type: object
      title: Response of a create request with a single token
    iam_single_token_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/iam_token_base'
          type: object
      title: Response with a single token
    iam_single_user_response:
      allOf:
        - $ref: '#/components/schemas/iam_api-response-single'
        - properties:
            result:
              type: object
          type: object
    iam_status:
      description: Status of the token.
      enum:
        - active
        - disabled
        - expired
      example: active
      type: string
    iam_telephone:
      description: User's telephone number
      example: +1 123-123-1234
      maxLength: 20
      nullable: true
      type: string
    iam_token_base:
      properties:
        condition:
          $ref: '#/components/schemas/iam_condition'
        expires_on:
          $ref: '#/components/schemas/iam_expires_on'
        id:
          $ref: '#/components/schemas/iam_token_identifier'
        issued_on:
          $ref: '#/components/schemas/iam_issued_on'
        last_used_on:
          $ref: '#/components/schemas/iam_last_used_on'
        modified_on:
          $ref: '#/components/schemas/iam_modified_on'
        name:
          $ref: '#/components/schemas/iam_name'
        not_before:
          $ref: '#/components/schemas/iam_not_before'
        policies:
          $ref: '#/components/schemas/iam_token_policies'
        status:
          $ref: '#/components/schemas/iam_status'
      type: object
    iam_token_body:
      allOf:
        - $ref: '#/components/schemas/iam_token_base'
        - type: object
        - required:
            - name
            - status
            - policies
      title: Token defined in a request body
    iam_token_identifier:
      description: Token identifier tag.
      example: ed17574386854bf78a67040be0a770b0
      maxLength: 32
      readOnly: true
      type: string
    iam_token_policies:
      description: List of access policies assigned to the token.
      items:
        $ref: '#/components/schemas/iam_policy_with_permission_groups_and_resources'
      type: array
    iam_token_with_value:
      allOf:
        - $ref: '#/components/schemas/iam_token_base'
        - properties:
            value:
              $ref: '#/components/schemas/iam_value'
      title: Create token response, with the token value
    iam_two_factor_authentication_enabled:
      default: false
      description: Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.
      readOnly: true
      type: boolean
    iam_unit-identifier:
      description: Tenant unit identifier.
      example: f267e341f3dd4697bd3b9f71dd96247f
      readOnly: true
      type: string
    iam_update-member-with-policies:
      properties:
        policies:
          description: Array of policies associated with this member.
          items:
            $ref: '#/components/schemas/iam_create_member_policy'
          type: array
      required:
        - policies
      title: Update Member with Policies
      type: object
    iam_update-member-with-roles:
      allOf:
        - $ref: '#/components/schemas/iam_member'
      title: Update Member with Account Roles
    iam_user_invite:
      allOf:
        - $ref: '#/components/schemas/iam_base'
        - properties:
            status:
              description: Current status of the invitation.
              enum:
                - pending
                - accepted
                - rejected
                - expired
              example: accepted
    iam_value:
      description: The token value.
      example: 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T
      maxLength: 80
      minLength: 40
      readOnly: true
      type: string
      x-sensitive: true
    iam_zipcode:
      description: The zipcode or postal code where the user lives.
      example: "12345"
      maxLength: 20
      nullable: true
      type: string
    images_account_identifier:
      description: Account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    images_api-response-collection-v2:
      allOf:
        - $ref: '#/components/schemas/images_api-response-common'
        - properties:
            result:
              properties:
                continuation_token:
                  $ref: '#/components/schemas/images_images_list_continuation_token'
              type: object
      type: object
    images_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/images_messages'
        messages:
          $ref: '#/components/schemas/images_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    images_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/images_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/images_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    images_api-response-single:
      allOf:
        - $ref: '#/components/schemas/images_api-response-common'
        - properties:
            result:
              anyOf:
                - type: object
                - type: string
      type: object
    images_deleted_response:
      allOf:
        - $ref: '#/components/schemas/images_api-response-single'
        - properties:
            result:
              example: {}
              type: object
    images_image:
      properties:
        filename:
          $ref: '#/components/schemas/images_image_filename'
        id:
          $ref: '#/components/schemas/images_image_identifier'
        meta:
          $ref: '#/components/schemas/images_image_metadata'
        requireSignedURLs:
          $ref: '#/components/schemas/images_image_requireSignedURLs'
        uploaded:
          $ref: '#/components/schemas/images_image_uploaded'
        variants:
          $ref: '#/components/schemas/images_image_variants'
      type: object
    images_image_basic_upload:
      properties:
        file:
          description: An image binary data. Only needed when type is uploading a file.
          format: binary
        metadata:
          description: User modifiable key-value store. Can use used for keeping references to another system of record for managing images.
          type: object
        requireSignedURLs:
          default: false
          description: Indicates whether the image requires a signature token for the access.
          example: true
          type: boolean
        url:
          description: A URL to fetch an image from origin. Only needed when type is uploading from a URL.
          example: https://example.com/path/to/logo.png
          type: string
      type: object
    images_image_direct_upload_request_v2:
      properties:
        expiry:
          default: Now + 30 minutes
          description: 'The date after which the upload will not be accepted. Minimum: Now + 2 minutes. Maximum: Now + 6 hours.'
          example: "2021-01-02T02:20:00Z"
          format: date-time
          type: string
        id:
          description: Optional Image Custom ID. Up to 1024 chars. Can include any number of subpaths, and utf8 characters. Cannot start nor end with a / (forward slash). Cannot be a UUID.
          example: this/is/my-customid
          maxLength: 1024
          type: string
        metadata:
          description: User modifiable key-value store. Can be used for keeping references to another system of record, for managing images.
          type: object
        requireSignedURLs:
          default: false
          description: Indicates whether the image requires a signature token to be accessed.
          example: true
          type: boolean
      type: object
    images_image_direct_upload_response_v2:
      allOf:
        - $ref: '#/components/schemas/images_api-response-single'
        - properties:
            result:
              properties:
                id:
                  description: Image unique identifier.
                  example: e22e9e6b-c02b-42fd-c405-6c32af5fe600
                  maxLength: 32
                  readOnly: true
                  type: string
                uploadURL:
                  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
                  type: string
    images_image_filename:
      description: Image file name.
      example: logo.png
      maxLength: 255
      readOnly: true
      type: string
    images_image_hero_url:
      description: URI to hero variant for an image.
      example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero
      format: uri
      readOnly: true
      type: string
    images_image_identifier:
      description: Image unique identifier.
      example: 107b9558-dd06-4bbd-5fef-9c2c16bb7900
      maxLength: 32
      readOnly: true
      type: string
    images_image_key_name:
      description: Key name.
      example: default
      readOnly: true
      type: string
    images_image_key_response_collection:
      allOf:
        - $ref: '#/components/schemas/images_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/images_image_keys_response'
    images_image_key_value:
      description: Key value.
      example: Oix0bbNaT8Rge9PuyxUBrjI6zrgnsyJ5=
      readOnly: true
      type: string
    images_image_keys:
      properties:
        name:
          $ref: '#/components/schemas/images_image_key_name'
        value:
          $ref: '#/components/schemas/images_image_key_value'
      type: object
    images_image_keys_response:
      properties:
        keys:
          items:
            $ref: '#/components/schemas/images_image_keys'
          type: array
      type: object
    images_image_metadata:
      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
      type: object
    images_image_original_url:
      description: URI to original variant for an image.
      example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original
      format: uri
      readOnly: true
      type: string
    images_image_patch_request:
      properties:
        metadata:
          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.
          type: object
        requireSignedURLs:
          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
          type: boolean
      type: object
    images_image_requireSignedURLs:
      default: false
      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.
      example: true
      type: boolean
    images_image_response_blob:
      anyOf:
        - type: string
        - type: object
      example: <image blob data>
    images_image_response_single:
      allOf:
        - $ref: '#/components/schemas/images_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/images_image'
    images_image_thumbnail_url:
      description: URI to thumbnail variant for an image.
      example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail
      format: uri
      readOnly: true
      type: string
    images_image_uploaded:
      description: When the media item was uploaded.
      example: "2014-01-02T02:20:00.123Z"
      format: date-time
      readOnly: true
      type: string
    images_image_variant_definition:
      properties:
        id:
          $ref: '#/components/schemas/images_image_variant_identifier'
        neverRequireSignedURLs:
          $ref: '#/components/schemas/images_image_variant_neverRequireSignedURLs'
        options:
          $ref: '#/components/schemas/images_image_variant_options'
      required:
        - id
        - options
      type: object
    images_image_variant_fit:
      description: The fit property describes how the width and height dimensions should be interpreted.
      enum:
        - scale-down
        - contain
        - cover
        - crop
        - pad
      example: scale-down
      type: string
    images_image_variant_height:
      description: Maximum height in image pixels.
      example: 768
      minimum: 1
      type: number
    images_image_variant_identifier:
      example: hero
      maxLength: 99
      pattern: ^[a-zA-Z0-9]$
      type: string
    images_image_variant_list_response:
      allOf:
        - $ref: '#/components/schemas/images_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/images_image_variants_response'
    images_image_variant_neverRequireSignedURLs:
      default: false
      description: Indicates whether the variant can access an image without a signature, regardless of image access control.
      example: true
      type: boolean
    images_image_variant_options:
      description: Allows you to define image resizing sizes for different use cases.
      properties:
        fit:
          $ref: '#/components/schemas/images_image_variant_fit'
        height:
          $ref: '#/components/schemas/images_image_variant_height'
        metadata:
          $ref: '#/components/schemas/images_image_variant_schemas_metadata'
        width:
          $ref: '#/components/schemas/images_image_variant_width'
      required:
        - fit
        - metadata
        - width
        - height
      type: object
    images_image_variant_patch_request:
      properties:
        neverRequireSignedURLs:
          $ref: '#/components/schemas/images_image_variant_neverRequireSignedURLs'
        options:
          $ref: '#/components/schemas/images_image_variant_options'
      required:
        - options
      type: object
    images_image_variant_public_request:
      properties:
        hero:
          properties:
            id:
              $ref: '#/components/schemas/images_image_variant_identifier'
            neverRequireSignedURLs:
              $ref: '#/components/schemas/images_image_variant_neverRequireSignedURLs'
            options:
              $ref: '#/components/schemas/images_image_variant_options'
          required:
            - id
            - options
          type: object
      type: object
    images_image_variant_response:
      properties:
        variant:
          $ref: '#/components/schemas/images_image_variant_definition'
      type: object
    images_image_variant_schemas_metadata:
      description: What EXIF data should be preserved in the output image.
      enum:
        - keep
        - copyright
        - none
      example: none
      type: string
    images_image_variant_simple_response:
      allOf:
        - $ref: '#/components/schemas/images_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/images_image_variant_response'
    images_image_variant_width:
      description: Maximum width in image pixels.
      example: 1366
      minimum: 1
      type: number
    images_image_variants:
      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
      items:
        anyOf:
          - $ref: '#/components/schemas/images_image_thumbnail_url'
          - $ref: '#/components/schemas/images_image_hero_url'
          - $ref: '#/components/schemas/images_image_original_url'
      readOnly: true
      type: array
    images_image_variants_response:
      properties:
        variants:
          $ref: '#/components/schemas/images_image_variant_public_request'
      type: object
    images_images_list_continuation_token:
      description: Continuation token to fetch next page. Passed as a query param when requesting List V2 api endpoint.
      example: iD0bxlWFSVUWsDHbzIqvDkgBW4otifAAuGXLz1n8BQA
      maxLength: 32
      nullable: true
      readOnly: true
      type: string
    images_images_list_response:
      allOf:
        - $ref: '#/components/schemas/images_api-response-common'
        - properties:
            result:
              properties:
                images:
                  items:
                    $ref: '#/components/schemas/images_image'
                  type: array
              type: object
    images_images_list_response_v2:
      allOf:
        - $ref: '#/components/schemas/images_api-response-collection-v2'
        - properties:
            result:
              properties:
                images:
                  items:
                    $ref: '#/components/schemas/images_image'
                  type: array
              type: object
    images_images_stats:
      properties:
        count:
          $ref: '#/components/schemas/images_images_stats_count'
      type: object
    images_images_stats_allowed:
      description: Cloudflare Images allowed usage.
      example: 100000
      readOnly: true
      type: number
    images_images_stats_count:
      properties:
        allowed:
          $ref: '#/components/schemas/images_images_stats_allowed'
        current:
          $ref: '#/components/schemas/images_images_stats_current'
      type: object
    images_images_stats_current:
      description: Cloudflare Images current usage.
      example: 1000
      readOnly: true
      type: number
    images_images_stats_response:
      allOf:
        - $ref: '#/components/schemas/images_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/images_images_stats'
    images_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    images_signing_key_identifier:
      example: someKey
      maxLength: 20
      pattern: ^[a-zA-Z0-9]$
      type: string
    infra_AccountTag:
      description: Account identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      title: account_id
      type: string
    infra_IPInfo:
      description: The IPv4/IPv6 address that identifies where to reach a target
      properties:
        ipv4:
          description: The target's IPv4 address
          properties:
            ip_addr:
              description: IP address of the target
              example: 187.26.29.249
              type: string
            virtual_network_id:
              description: Private virtual network identifier for the target
              example: c77b744e-acc8-428f-9257-6878c046ed55
              format: uuid
              type: string
          type: object
        ipv6:
          description: The target's IPv6 address
          properties:
            ip_addr:
              description: IP address of the target
              example: 64c0:64e8:f0b4:8dbf:7104:72b0:ec8f:f5e0
              type: string
            virtual_network_id:
              description: Private virtual network identifier for the target
              example: c77b744e-acc8-428f-9257-6878c046ed55
              format: uuid
              type: string
          type: object
      type: object
    infra_Target:
      properties:
        created_at:
          description: Date and time at which the target was created
          example: "2019-08-24T14:15:22Z"
          format: date-time
          type: string
        hostname:
          description: A non-unique field that refers to a target
          example: infra-access-target
          type: string
        id:
          $ref: '#/components/schemas/infra_TargetId'
        ip:
          $ref: '#/components/schemas/infra_IPInfo'
        modified_at:
          description: Date and time at which the target was modified
          example: "2019-08-24T14:15:22Z"
          format: date-time
          type: string
      required:
        - id
        - hostname
        - ip
        - created_at
        - modified_at
      type: object
    infra_TargetArray:
      items:
        $ref: '#/components/schemas/infra_Target'
      type: array
    infra_TargetId:
      description: Target identifier
      example: 0191dce4-9ab4-7fce-b660-8e5dec5172da
      format: uuid
      maxLength: 36
      title: target_id
      type: string
    infra_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/infra_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/infra_result_info'
      type: object
    infra_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/infra_messages'
        messages:
          $ref: '#/components/schemas/infra_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    infra_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/infra_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/infra_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    infra_api-response-single:
      allOf:
        - $ref: '#/components/schemas/infra_api-response-common'
      type: object
    infra_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    infra_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    intel-sinkholes_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/intel-sinkholes_messages'
        messages:
          $ref: '#/components/schemas/intel-sinkholes_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    intel-sinkholes_empty_object_response:
      type: object
    intel-sinkholes_get_sinkholes_response:
      allOf:
        - $ref: '#/components/schemas/intel-sinkholes_api-response-common'
        - properties:
            result:
              example:
                - account_tag: 233f45e61fd1f7e21e1e154ede4q2859
                  created_on: "2023-05-12T12:21:56.777653Z"
                  description: user specified description 1
                  id: 1
                  modified_on: "2023-06-18T03:13:34.123321Z"
                  name: sinkhole_1
                  r2_bucket: my_bucket
                  r2_id: <r2_id>
                - account_tag: 233f45e61fd1f7e21e1e154ede4q2859
                  created_on: "2023-05-21T21:43:52.867525Z"
                  description: user specified description 2
                  id: 2
                  modified_on: "2023-06-28T18:46:18.764425Z"
                  name: sinkhole_1
                  r2_bucket: my_bucket
                  r2_id: <r2_id>
              items:
                $ref: '#/components/schemas/intel-sinkholes_sinkhole_item'
              type: array
    intel-sinkholes_id:
      description: The unique identifier for the sinkhole
      type: integer
    intel-sinkholes_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    intel-sinkholes_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    intel-sinkholes_name:
      description: The name of the sinkhole
      type: string
    intel-sinkholes_sinkhole_item:
      example:
        account_tag: 233f45e61fd1f7e21e1e154ede4q2859
        created_on: "2023-05-12T12:21:56.777653Z"
        description: user specified description 1
        id: 1
        modified_on: "2023-06-18T03:13:34.123321Z"
        name: sinkhole_1
        r2_bucket: my_bucket
        r2_id: <r2_id>
      properties:
        account_tag:
          description: The account tag that owns this sinkhole
          type: string
        created_on:
          description: The date and time when the sinkhole was created
          format: date-time
          type: string
        id:
          $ref: '#/components/schemas/intel-sinkholes_id'
        modified_on:
          description: The date and time when the sinkhole was last modified
          format: date-time
          type: string
        name:
          $ref: '#/components/schemas/intel-sinkholes_name'
        r2_bucket:
          description: The name of the R2 bucket to store results
          type: string
        r2_id:
          description: The id of the R2 instance
          type: string
    intel_additional_information:
      description: Additional information related to the host name.
      properties:
        suspected_malware_family:
          description: Suspected DGA malware family.
          example: ""
          type: string
      type: object
    intel_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/intel_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/intel_result_info'
      type: object
    intel_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/intel_messages'
        messages:
          $ref: '#/components/schemas/intel_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    intel_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/intel_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/intel_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    intel_api-response-single:
      allOf:
        - $ref: '#/components/schemas/intel_schemas-api-response-common'
      type: object
    intel_application:
      description: Application that the hostname belongs to.
      properties:
        id:
          type: integer
        name:
          example: CLOUDFLARE
          type: string
      type: object
    intel_asn:
      type: integer
    intel_asn_components-schemas-response:
      allOf:
        - $ref: '#/components/schemas/intel_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/intel_asn'
    intel_asn_country:
      example: US
      type: string
    intel_asn_description:
      example: CLOUDFLARENET
      type: string
    intel_asn_type:
      description: Infrastructure type of this ASN.
      enum:
        - hosting_provider
        - isp
        - organization
      example: hosting_provider
      type: string
    intel_categories_with_super_category_ids_example_empty:
      example: []
      items:
        $ref: '#/components/schemas/intel_category_with_super_category_id'
      type: array
    intel_category_with_super_category_id:
      properties:
        id:
          type: integer
        name:
          type: string
        super_category_id:
          type: integer
    intel_collection_response:
      allOf:
        - $ref: '#/components/schemas/intel_api-response-collection'
        - properties:
            result:
              items:
                properties:
                  additional_information:
                    $ref: '#/components/schemas/intel_additional_information'
                  application:
                    $ref: '#/components/schemas/intel_application'
                  content_categories:
                    $ref: '#/components/schemas/intel_content_categories'
                  domain:
                    $ref: '#/components/schemas/intel_domain_name'
                  inherited_content_categories:
                    $ref: '#/components/schemas/intel_inherited_content_categories'
                  inherited_from:
                    $ref: '#/components/schemas/intel_inherited_from'
                  inherited_risk_types:
                    $ref: '#/components/schemas/intel_inherited_risk_types'
                  popularity_rank:
                    $ref: '#/components/schemas/intel_popularity_rank'
                  risk_score:
                    $ref: '#/components/schemas/intel_risk_score'
                  risk_types:
                    $ref: '#/components/schemas/intel_risk_types'
              type: array
    intel_components-schemas-response:
      allOf:
        - $ref: '#/components/schemas/intel_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/intel_ip-list'
              type: array
    intel_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/intel_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/intel_passive-dns-by-ip'
    intel_content_categories:
      description: Current content categories.
      example:
        - id: 155
          name: Technology
          super_category_id: 26
    intel_count:
      description: Total results returned based on your search parameters.
      example: 1
      type: number
    intel_domain:
      properties:
        additional_information:
          $ref: '#/components/schemas/intel_additional_information'
        application:
          $ref: '#/components/schemas/intel_application'
        content_categories:
          $ref: '#/components/schemas/intel_content_categories'
        domain:
          $ref: '#/components/schemas/intel_domain_name'
        inherited_content_categories:
          $ref: '#/components/schemas/intel_inherited_content_categories'
        inherited_from:
          $ref: '#/components/schemas/intel_inherited_from'
        inherited_risk_types:
          $ref: '#/components/schemas/intel_inherited_risk_types'
        popularity_rank:
          $ref: '#/components/schemas/intel_popularity_rank'
        resolves_to_refs:
          $ref: '#/components/schemas/intel_resolves_to_refs'
        risk_score:
          $ref: '#/components/schemas/intel_risk_score'
        risk_types:
          $ref: '#/components/schemas/intel_risk_types'
    intel_domain-history:
      properties:
        categorizations:
          items:
            properties:
              categories:
                example:
                  - id: 155
                    name: Technology
              end:
                example: "2021-04-30"
                format: date
                type: string
              start:
                example: "2021-04-01"
                format: date
                type: string
            type: object
          type: array
        domain:
          $ref: '#/components/schemas/intel_domain_name'
    intel_domain_name:
      example: cloudflare.com
      type: string
    intel_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    intel_inherited_content_categories:
      $ref: '#/components/schemas/intel_categories_with_super_category_ids_example_empty'
    intel_inherited_from:
      description: Domain from which `inherited_content_categories` and `inherited_risk_types` are inherited, if applicable.
      type: string
    intel_inherited_risk_types:
      $ref: '#/components/schemas/intel_categories_with_super_category_ids_example_empty'
    intel_ip:
      anyOf:
        - $ref: '#/components/schemas/intel_ipv4'
        - $ref: '#/components/schemas/intel_ipv6'
    intel_ip-list:
      properties:
        description:
          type: string
        id:
          type: integer
        name:
          example: Malware
          type: string
    intel_ipv4:
      example: 192.0.2.0
      format: ipv4
      type: string
    intel_ipv6:
      example: '2001:0DB8::'
      format: ipv6
      type: string
    intel_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    intel_miscategorization:
      properties:
        content_adds:
          description: Content category IDs to add.
          example:
            - 82
          items:
            type: integer
          type: array
        content_removes:
          description: Content category IDs to remove.
          example:
            - 155
          items:
            type: integer
          type: array
        indicator_type:
          enum:
            - domain
            - ipv4
            - ipv6
            - url
          example: domain
          type: string
        ip:
          description: Provide only if indicator_type is `ipv4` or `ipv6`.
          type: string
        security_adds:
          description: Security category IDs to add.
          example:
            - 117
            - 131
          items:
            type: integer
          type: array
        security_removes:
          description: Security category IDs to remove.
          example:
            - 83
          items:
            type: integer
          type: array
        url:
          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/`.'
          type: string
    intel_page:
      description: Current page within paginated list of results.
      example: 1
      type: number
    intel_passive-dns-by-ip:
      properties:
        count:
          description: Total results returned based on your search parameters.
          example: 1
          type: number
        page:
          description: Current page within paginated list of results.
          example: 1
          type: number
        per_page:
          description: Number of results per page of results.
          example: 20
          type: number
        reverse_records:
          description: Reverse DNS look-ups observed during the time period.
          items:
            properties:
              first_seen:
                description: First seen date of the DNS record during the time period.
                example: "2021-04-01"
                format: date
                type: string
              hostname:
                description: Hostname that the IP was observed resolving to.
              last_seen:
                description: Last seen date of the DNS record during the time period.
                example: "2021-04-30"
                format: date
                type: string
            type: object
          type: array
    intel_per_page:
      description: Number of results per page of results.
      example: 20
      type: number
    intel_phishing-url-info:
      properties:
        categorizations:
          description: List of categorizations applied to this submission.
          items:
            properties:
              category:
                description: Name of the category applied.
                example: PHISHING
                type: string
              verification_status:
                description: Result of human review for this categorization.
                example: confirmed
                type: string
            type: object
          type: array
        model_results:
          description: List of model results for completed scans.
          items:
            properties:
              model_name:
                description: Name of the model.
                example: MACHINE_LEARNING_v2
                type: string
              model_score:
                description: Score output by the model for this submission.
                example: 0.024
                type: number
            type: object
          type: array
        rule_matches:
          description: List of signatures that matched against site content found when crawling the URL.
          items:
            properties:
              banning:
                description: For internal use.
                type: boolean
              blocking:
                description: For internal use.
                type: boolean
              description:
                description: Description of the signature that matched.
                example: Match frequently used social followers phishing kit
                type: string
              name:
                description: Name of the signature that matched.
                example: phishkit.social_followers
                type: string
            type: object
          type: array
        scan_status:
          description: Status of the most recent scan found.
          properties:
            last_processed:
              description: Timestamp of when the submission was processed.
              example: Wed, 26 Oct 2022 16:04:51 GMT
              type: string
            scan_complete:
              description: For internal use.
              type: boolean
            status_code:
              description: Status code that the crawler received when loading the submitted URL.
              type: integer
            submission_id:
              description: ID of the most recent submission.
              type: integer
          type: object
        screenshot_download_signature:
          description: For internal use.
          type: string
        screenshot_path:
          description: For internal use.
          type: string
        url:
          description: URL that was submitted.
          example: https://www.cloudflare.com
          type: string
    intel_phishing-url-info_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/intel_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/intel_phishing-url-info'
    intel_phishing-url-submit:
      properties:
        excluded_urls:
          description: URLs that were excluded from scanning because their domain is in our no-scan list.
          items:
            properties:
              url:
                description: URL that was excluded.
                example: https://developers.cloudflare.com
                type: string
            type: object
          type: array
        skipped_urls:
          description: URLs that were skipped because the same URL is currently being scanned
          items:
            properties:
              url:
                description: URL that was skipped.
                example: https://www.cloudflare.com/developer-week/
                type: string
              url_id:
                description: ID of the submission of that URL that is currently scanning.
                example: 2
                type: integer
            type: object
          type: array
        submitted_urls:
          description: URLs that were successfully submitted for scanning.
          items:
            properties:
              url:
                description: URL that was submitted.
                example: https://www.cloudflare.com
                type: string
              url_id:
                description: ID assigned to this URL submission. Used to retrieve scanning results.
                example: 1
                type: integer
            type: object
          type: array
    intel_phishing-url-submit_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/intel_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/intel_phishing-url-submit'
    intel_popularity_rank:
      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.
      type: integer
    intel_resolves_to_ref:
      properties:
        id:
          $ref: '#/components/schemas/intel_stix_identifier'
        value:
          description: IP address or domain name.
          example: 192.0.2.0
          type: string
      type: object
    intel_resolves_to_refs:
      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/intel_resolves_to_ref'
      type: array
    intel_response:
      allOf:
        - $ref: '#/components/schemas/intel_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/intel_domain-history'
              type: array
    intel_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    intel_risk_score:
      description: Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest risk).
      type: number
    intel_risk_types:
      example: []
    intel_schemas-api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/intel_messages'
        messages:
          $ref: '#/components/schemas/intel_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    intel_schemas-asn:
      properties:
        asn:
          $ref: '#/components/schemas/intel_asn'
        country:
          $ref: '#/components/schemas/intel_asn_country'
        description:
          $ref: '#/components/schemas/intel_asn_description'
        domain_count:
          type: integer
        top_domains:
          example:
            - example.com
          items:
            type: string
          type: array
        type:
          $ref: '#/components/schemas/intel_asn_type'
    intel_schemas-ip:
      properties:
        belongs_to_ref:
          description: Specifies a reference to the autonomous systems (AS) that the IP address belongs to.
          properties:
            country:
              example: US
              type: string
            description:
              example: CLOUDFLARENET
              type: string
            id:
              example: autonomous-system--2fa28d71-3549-5a38-af05-770b79ad6ea8
            type:
              description: Infrastructure type of this ASN.
              enum:
                - hosting_provider
                - isp
                - organization
              example: hosting_provider
              type: string
            value:
              type: string
          type: object
        ip:
          $ref: '#/components/schemas/intel_ip'
        risk_types:
          example:
            - id: 131
              name: Phishing
              super_category_id: 21
    intel_schemas-response:
      allOf:
        - $ref: '#/components/schemas/intel_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/intel_schemas-ip'
              type: array
    intel_schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/intel_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/intel_whois'
    intel_single_response:
      allOf:
        - $ref: '#/components/schemas/intel_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/intel_domain'
    intel_start_end_params:
      properties:
        end:
          description: Defaults to the current date.
          example: "2021-04-30"
          format: date
          type: string
        start:
          description: Defaults to 30 days before the end parameter value.
          example: "2021-04-01"
          format: date
          type: string
      type: object
    intel_stix_identifier:
      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
      type: string
    intel_url:
      description: URL(s) to filter submissions results by
      example: https://www.cloudflare.com
      format: uri
      type: string
    intel_url_param:
      properties:
        url:
          $ref: '#/components/schemas/intel_url'
      type: object
    intel_whois:
      properties:
        created_date:
          example: "2009-02-17"
          format: date
          type: string
        domain:
          $ref: '#/components/schemas/intel_domain_name'
        nameservers:
          example:
            - ns3.cloudflare.com
            - ns4.cloudflare.com
            - ns5.cloudflare.com
            - ns6.cloudflare.com
            - ns7.cloudflare.com
          items:
            type: string
          type: array
        registrant:
          example: DATA REDACTED
          type: string
        registrant_country:
          example: United States
          type: string
        registrant_email:
          example: https://domaincontact.cloudflareregistrar.com/cloudflare.com
          type: string
        registrant_org:
          example: DATA REDACTED
          type: string
        registrar:
          example: Cloudflare, Inc.
          type: string
        updated_date:
          example: "2017-05-24"
          format: date
          type: string
    legacy-jhs_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/legacy-jhs_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/legacy-jhs_result_info'
      type: object
    legacy-jhs_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/legacy-jhs_messages'
        messages:
          $ref: '#/components/schemas/legacy-jhs_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    legacy-jhs_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/legacy-jhs_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/legacy-jhs_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    legacy-jhs_api-response-single:
      allOf:
        - $ref: '#/components/schemas/legacy-jhs_api-response-common'
        - properties:
            result:
              anyOf:
                - type: object
                - type: string
              nullable: true
      type: object
    legacy-jhs_app_id:
      description: Application identifier.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      readOnly: true
      type: string
    legacy-jhs_app_id_param:
      description: Comma-delimited list of Spectrum Application Id(s). If provided, the response will be limited to Spectrum Application Id(s) that match.
      example: ea95132c15732412d22c1476fa83f27a,d122c5f4bb71e25cc9e86ab43b142e2f
      type: string
    legacy-jhs_argo_smart_routing:
      default: false
      description: |-
        Enables Argo Smart Routing for this application.
        Notes: Only available for TCP applications with traffic_type set to "direct".
      example: true
      type: boolean
    legacy-jhs_created:
      description: When the Application was created.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      readOnly: true
      type: string
    legacy-jhs_dimensions:
      description: "Can be used to break down the data by given attributes. Options are: \n\nDimension                 | Name                            | Example\n--------------------------|---------------------------------|--------------------------\nevent                     | Connection Event                | connect, progress, disconnect, originError, clientFiltered\nappID                     | Application ID                  | 40d67c87c6cd4b889a4fd57805225e85\ncoloName                  | Colo Name                       | SFO\nipVersion                 | IP version used by the client   | 4, 6."
      example:
        - event
        - appID
      items:
        enum:
          - event
          - appID
          - coloName
          - ipVersion
        type: string
      type: array
    legacy-jhs_dns:
      description: The name and type of DNS record for the Spectrum application.
      properties:
        name:
          $ref: '#/components/schemas/legacy-jhs_dns_name'
        type:
          $ref: '#/components/schemas/legacy-jhs_dns_type'
      type: object
    legacy-jhs_dns_name:
      description: The name of the DNS record associated with the application.
      example: ssh.example.com
      format: hostname
      type: string
    legacy-jhs_dns_ttl:
      description: The TTL of our resolution of your DNS record in seconds.
      minimum: 600
      type: integer
    legacy-jhs_dns_type:
      description: The type of DNS record associated with the application.
      enum:
        - CNAME
        - ADDRESS
      example: CNAME
      type: string
    legacy-jhs_edge_ips:
      default:
        connectivity: all
        type: dynamic
      description: The anycast edge IP configuration for the hostname of this application.
      oneOf:
        - properties:
            connectivity:
              description: The IP versions supported for inbound connections on Spectrum anycast IPs.
              enum:
                - all
                - ipv4
                - ipv6
              example: all
              type: string
            type:
              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: string
          type: object
        - properties:
            ips:
              description: The array of customer owned IPs we broadcast via anycast for this hostname and application.
              example:
                - 192.0.2.1
              items:
                description: Edge anycast IPs.
                example: 192.0.2.1
                type: string
              type: array
            type:
              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
              type: string
          type: object
    legacy-jhs_id:
      description: Identifier of a recommedation result.
      example: ssl_recommendation
      type: string
    legacy-jhs_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    legacy-jhs_ip_firewall:
      description: |-
        Enables IP Access Rules for this application.
        Notes: Only available for TCP applications.
      example: true
      type: boolean
    legacy-jhs_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    legacy-jhs_modified:
      description: When the Application was last modified.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      readOnly: true
      type: string
    legacy-jhs_origin_dns:
      description: The name and type of DNS record for the Spectrum application.
      properties:
        name:
          $ref: '#/components/schemas/legacy-jhs_origin_dns_name'
        ttl:
          $ref: '#/components/schemas/legacy-jhs_dns_ttl'
        type:
          $ref: '#/components/schemas/legacy-jhs_origin_dns_type'
      type: object
    legacy-jhs_origin_dns_name:
      description: The name of the DNS record associated with the origin.
      example: origin.example.com
      format: hostname
      type: string
    legacy-jhs_origin_dns_type:
      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: ""
      type: string
    legacy-jhs_origin_port:
      anyOf:
        - type: integer
        - type: string
      description: |-
        The destination port at the origin. Only specified in conjunction with origin_dns. May use an integer to specify a single origin port, for example `1000`, or a string to specify a range of origin ports, for example `"1000-2000"`.
        Notes: If specifying a port range, the number of ports in the range must match the number of ports specified in the "protocol" field.
      example: 22
      maximum: 65535
      minimum: 1
    legacy-jhs_protocol:
      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
      type: string
    legacy-jhs_proxy_protocol:
      default: "off"
      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
      example: "off"
      type: string
    legacy-jhs_response_collection:
      allOf:
        - $ref: '#/components/schemas/legacy-jhs_api-response-collection'
        - properties:
            result:
              items:
                type: object
              type: array
    legacy-jhs_response_single:
      allOf:
        - $ref: '#/components/schemas/legacy-jhs_api-response-single'
        - properties:
            result:
              type: object
          type: object
    legacy-jhs_response_single_origin_dns:
      allOf:
        - $ref: '#/components/schemas/legacy-jhs_api-response-single'
        - properties:
            result:
              properties:
                argo_smart_routing:
                  $ref: '#/components/schemas/legacy-jhs_argo_smart_routing'
                created_on:
                  $ref: '#/components/schemas/legacy-jhs_created'
                dns:
                  $ref: '#/components/schemas/legacy-jhs_dns'
                edge_ips:
                  $ref: '#/components/schemas/legacy-jhs_edge_ips'
                id:
                  $ref: '#/components/schemas/legacy-jhs_app_id'
                ip_firewall:
                  $ref: '#/components/schemas/legacy-jhs_ip_firewall'
                modified_on:
                  $ref: '#/components/schemas/legacy-jhs_modified'
                origin_dns:
                  $ref: '#/components/schemas/legacy-jhs_origin_dns'
                origin_port:
                  $ref: '#/components/schemas/legacy-jhs_origin_port'
                protocol:
                  $ref: '#/components/schemas/legacy-jhs_protocol'
                proxy_protocol:
                  $ref: '#/components/schemas/legacy-jhs_proxy_protocol'
                tls:
                  $ref: '#/components/schemas/legacy-jhs_tls'
                traffic_type:
                  $ref: '#/components/schemas/legacy-jhs_traffic_type'
    legacy-jhs_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    legacy-jhs_schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/legacy-jhs_api-response-common'
        - properties:
            result:
              items:
                type: object
              type: array
    legacy-jhs_sort:
      description: The sort order for the result set; sort fields must be included in `metrics` or `dimensions`.
      example:
        - +count
        - -bytesIngress
      items: {}
      type: array
    legacy-jhs_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      readOnly: true
      type: string
    legacy-jhs_tls:
      description: The type of TLS termination associated with the application.
      enum:
        - "off"
        - flexible
        - full
        - strict
      example: full
      type: string
    legacy-jhs_traffic_type:
      default: direct
      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
      example: direct
      type: string
    legacy-jhs_until:
      description: End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
      example: "2014-01-02T03:20:00Z"
      format: date-time
      type: string
    legacy-jhs_value:
      enum:
        - flexible
        - full
        - strict
      example: strict
      type: string
    lists_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/lists_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
      type: object
    lists_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/lists_messages'
        messages:
          $ref: '#/components/schemas/lists_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    lists_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/lists_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/lists_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    lists_bulk-operation-response-collection:
      allOf:
        - $ref: '#/components/schemas/lists_api-response-collection'
        - properties:
            result:
              $ref: '#/components/schemas/lists_operation'
          type: object
    lists_created_on:
      description: The RFC 3339 timestamp of when the list was created.
      example: "2020-01-01T08:00:00Z"
      type: string
    lists_description:
      description: An informative summary of the list.
      example: This is a note
      maxLength: 500
      type: string
    lists_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    lists_item:
      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"
      oneOf:
        - $ref: '#/components/schemas/lists_item_ip'
        - $ref: '#/components/schemas/lists_item_redirect'
        - $ref: '#/components/schemas/lists_item_hostname'
        - $ref: '#/components/schemas/lists_item_asn'
      properties:
        asn:
          $ref: '#/components/schemas/lists_item_asn'
        comment:
          $ref: '#/components/schemas/lists_item_comment'
        created_on:
          description: The RFC 3339 timestamp of when the item was created.
          example: "2020-01-01T08:00:00Z"
          readOnly: true
          type: string
        hostname:
          $ref: '#/components/schemas/lists_item_hostname'
        id:
          $ref: '#/components/schemas/lists_list_id'
        ip:
          $ref: '#/components/schemas/lists_item_ip'
        modified_on:
          description: The RFC 3339 timestamp of when the item was last modified.
          example: "2020-01-10T14:00:00Z"
          readOnly: true
          type: string
        redirect:
          $ref: '#/components/schemas/lists_item_redirect'
      type: object
    lists_item-response-collection:
      allOf:
        - $ref: '#/components/schemas/lists_api-response-collection'
        - properties:
            result:
              $ref: '#/components/schemas/lists_item'
          type: object
    lists_item_asn:
      description: A non-negative 32 bit integer
      example: 5567
      type: integer
    lists_item_comment:
      description: An informative summary of the list item.
      example: Private IP address
      type: string
    lists_item_hostname:
      description: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
      properties:
        url_hostname:
          example: example.com
          type: string
      required:
        - url_hostname
    lists_item_id:
      description: The unique ID of the item in the List.
      example: 34b12448945f11eaa1b71c4d701ab86e
      type: string
    lists_item_ip:
      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
      type: string
    lists_item_redirect:
      description: The definition of the redirect.
      properties:
        include_subdomains:
          default: false
          type: boolean
        preserve_path_suffix:
          default: false
          type: boolean
        preserve_query_string:
          default: false
          type: boolean
        source_url:
          example: example.com/arch
          type: string
        status_code:
          default: 301
          enum:
            - 301
            - 302
            - 307
            - 308
          type: integer
        subpath_matching:
          default: false
          type: boolean
        target_url:
          example: https://archlinux.org/
          type: string
      required:
        - source_url
        - target_url
    lists_items:
      items:
        $ref: '#/components/schemas/lists_item'
      type: array
    lists_items-list-response-collection:
      allOf:
        - $ref: '#/components/schemas/lists_api-response-collection'
        - properties:
            result:
              $ref: '#/components/schemas/lists_items'
            result_info:
              properties:
                cursors:
                  properties:
                    after:
                      example: yyy
                      type: string
                    before:
                      example: xxx
                      type: string
                  type: object
              type: object
          type: object
    lists_items-update-request-collection:
      items:
        allOf:
          - properties:
              asn:
                $ref: '#/components/schemas/lists_item_asn'
              comment:
                $ref: '#/components/schemas/lists_item_comment'
              hostname:
                $ref: '#/components/schemas/lists_item_hostname'
              ip:
                $ref: '#/components/schemas/lists_item_ip'
              redirect:
                $ref: '#/components/schemas/lists_item_redirect'
            type: object
      type: array
    lists_kind:
      description: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).
      enum:
        - ip
        - redirect
        - hostname
        - asn
      example: ip
    lists_list:
      properties:
        created_on:
          $ref: '#/components/schemas/lists_created_on'
        description:
          $ref: '#/components/schemas/lists_description'
        id:
          $ref: '#/components/schemas/lists_list_id'
        kind:
          $ref: '#/components/schemas/lists_kind'
        modified_on:
          $ref: '#/components/schemas/lists_modified_on'
        name:
          $ref: '#/components/schemas/lists_name'
        num_items:
          $ref: '#/components/schemas/lists_num_items'
        num_referencing_filters:
          $ref: '#/components/schemas/lists_num_referencing_filters'
      type: object
    lists_list-delete-response-collection:
      allOf:
        - $ref: '#/components/schemas/lists_api-response-collection'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/lists_item_id'
              type: object
          type: object
      type: object
    lists_list-response-collection:
      allOf:
        - $ref: '#/components/schemas/lists_api-response-collection'
        - properties:
            result:
              $ref: '#/components/schemas/lists_list'
          type: object
      type: object
    lists_list_id:
      description: The unique ID of the list.
      example: 2c0fc9fa937b11eaa1b71c4d701ab86e
      maxLength: 32
      minLength: 32
      readOnly: true
      type: string
    lists_lists-async-response:
      allOf:
        - $ref: '#/components/schemas/lists_api-response-collection'
        - properties:
            result:
              properties:
                operation_id:
                  $ref: '#/components/schemas/lists_operation_id'
              type: object
          type: object
    lists_lists-response-collection:
      allOf:
        - $ref: '#/components/schemas/lists_api-response-collection'
        - properties:
            result:
              items:
                allOf:
                  - $ref: '#/components/schemas/lists_list'
                  - required:
                      - id
                      - name
                      - kind
                      - num_items
                      - created_on
                      - modified_on
                    type: object
              type: array
          type: object
      type: object
    lists_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    lists_modified_on:
      description: The RFC 3339 timestamp of when the list was last modified.
      example: "2020-01-10T14:00:00Z"
      type: string
    lists_name:
      description: An informative name for the list. Use this name in filter and rule expressions.
      example: list1
      maxLength: 50
      pattern: ^[a-zA-Z0-9_]+$
      type: string
    lists_num_items:
      description: The number of items in the list.
      example: 10
      type: number
    lists_num_referencing_filters:
      description: The number of [filters](/operations/filters-list-filters) referencing the list.
      example: 2
      type: number
    lists_operation:
      properties:
        completed:
          description: The RFC 3339 timestamp of when the operation was completed.
          example: "2020-01-01T08:00:00Z"
          readOnly: true
          type: string
        error:
          description: A message describing the error when the status is `failed`.
          example: This list is at the maximum number of items
          readOnly: true
          type: string
        id:
          $ref: '#/components/schemas/lists_operation_id'
        status:
          description: The current status of the asynchronous operation.
          enum:
            - pending
            - running
            - completed
            - failed
          example: failed
          readOnly: true
          type: string
      required:
        - id
        - status
      type: object
    lists_operation_id:
      description: The unique operation ID of the asynchronous action.
      example: 4da8780eeb215e6cb7f48dd981c4ea02
      readOnly: true
      type: string
    load-balancing_Host:
      description: The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.
      items:
        example: example.com
        type: string
      type: array
    load-balancing_adaptive_routing:
      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:
          default: false
          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.
          example: true
          type: boolean
      type: object
    load-balancing_address:
      description: The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.
      example: 0.0.0.0
      type: string
    load-balancing_allow_insecure:
      default: false
      description: Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
      example: true
      type: boolean
    load-balancing_analytics:
      properties:
        id:
          default: 1
          type: integer
        origins:
          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:
            $ref: '#/components/schemas/load-balancing_origin-analytics'
          type: array
        pool:
          example:
            changed: true
            healthy: true
            id: 74bc6a8b9b0dda3d651707a2928bad0c
            minimum_origins: 1
            name: some-pool
          type: object
        timestamp:
          example: "2014-01-01T05:20:00.12345Z"
          format: date-time
          type: string
      type: object
    load-balancing_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/load-balancing_result_info'
      type: object
    load-balancing_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/load-balancing_messages'
        messages:
          $ref: '#/components/schemas/load-balancing_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    load-balancing_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/load-balancing_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/load-balancing_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    load-balancing_api-response-single:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-common'
        - properties:
            result:
              anyOf:
                - nullable: true
                  type: object
                - nullable: true
                  type: string
      type: object
    load-balancing_check_regions:
      description: A list of regions from which to run health checks. Null means every Cloudflare data center.
      example:
        - WEU
        - ENAM
      items:
        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
        type: string
      nullable: true
      type: array
    load-balancing_components-schemas-description:
      description: Object description.
      example: Load Balancer for www.example.com
      type: string
    load-balancing_components-schemas-enabled:
      default: true
      description: Whether to enable (the default) this load balancer.
      example: true
      type: boolean
    load-balancing_components-schemas-id_response:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
              type: object
    load-balancing_components-schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    load-balancing_components-schemas-name:
      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
      type: string
    load-balancing_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/load-balancing_analytics'
              type: array
    load-balancing_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-single'
        - properties:
            result:
              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
              type: object
    load-balancing_consecutive_down:
      default: 0
      description: To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.
      type: integer
    load-balancing_consecutive_up:
      default: 0
      description: To be marked healthy the monitored origin must pass this healthcheck N consecutive times.
      type: integer
    load-balancing_country_pools:
      additionalProperties:
        description: A `string:[string]` object of key-values. Country code maps to list of pool IDs.
        items:
          type: string
        type: array
      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
      type: object
    load-balancing_default_pools:
      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:
        description: A pool ID.
        type: string
      type: array
    load-balancing_description:
      description: Object description.
      example: Login page monitor
      type: string
    load-balancing_disabled_at:
      description: This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.
      format: date-time
      readOnly: true
      type: string
    load-balancing_enabled:
      default: true
      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).
      example: false
      type: boolean
    load-balancing_expected_body:
      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
      type: string
    load-balancing_expected_codes:
      default: "200"
      description: The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
      example: 2xx
      type: string
    load-balancing_fallback_pool:
      description: The pool ID to use when all other pools are detected as unhealthy.
      type: string
    load-balancing_filter_options:
      description: Filter options for a particular resource type (pool or origin). Use null to reset.
      nullable: true
      properties:
        disable:
          default: false
          description: If set true, disable notifications for this type of resource (pool or origin).
          type: boolean
        healthy:
          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
          type: boolean
      type: object
    load-balancing_follow_redirects:
      default: false
      description: Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
      example: true
      type: boolean
    load-balancing_header:
      additionalProperties:
        items:
          type: string
        type: array
      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
      type: object
    load-balancing_health_details:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-single'
        - properties:
            result:
              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
              properties:
                pool_id:
                  description: Pool ID
                  example: 17b5962d775c646f3f9725cbc7a53df4
                  type: string
                pop_health:
                  description: List of regions and associated health status.
                  properties:
                    healthy:
                      description: Whether health check in region is healthy.
                      example: true
                      type: boolean
                    origins:
                      items:
                        $ref: '#/components/schemas/load-balancing_origin-health'
                      type: array
                  type: object
              type: object
    load-balancing_id_response:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/load-balancing_identifier'
              type: object
    load-balancing_identifier:
      example: f1aba936b94213e5b8dca0c0dbf1f9cc
      type: string
    load-balancing_interval:
      default: 60
      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.
      type: integer
    load-balancing_latitude:
      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.
      type: number
    load-balancing_load-balancer:
      properties:
        adaptive_routing:
          $ref: '#/components/schemas/load-balancing_adaptive_routing'
        country_pools:
          $ref: '#/components/schemas/load-balancing_country_pools'
        created_on:
          $ref: '#/components/schemas/load-balancing_timestamp'
        default_pools:
          $ref: '#/components/schemas/load-balancing_default_pools'
        description:
          $ref: '#/components/schemas/load-balancing_components-schemas-description'
        enabled:
          $ref: '#/components/schemas/load-balancing_components-schemas-enabled'
        fallback_pool:
          $ref: '#/components/schemas/load-balancing_fallback_pool'
        id:
          $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
        location_strategy:
          $ref: '#/components/schemas/load-balancing_location_strategy'
        modified_on:
          $ref: '#/components/schemas/load-balancing_timestamp'
        name:
          $ref: '#/components/schemas/load-balancing_components-schemas-name'
        networks:
          $ref: '#/components/schemas/load-balancing_networks'
        pop_pools:
          $ref: '#/components/schemas/load-balancing_pop_pools'
        proxied:
          $ref: '#/components/schemas/load-balancing_proxied'
        random_steering:
          $ref: '#/components/schemas/load-balancing_random_steering'
        region_pools:
          $ref: '#/components/schemas/load-balancing_region_pools'
        rules:
          $ref: '#/components/schemas/load-balancing_rules'
        session_affinity:
          $ref: '#/components/schemas/load-balancing_session_affinity'
        session_affinity_attributes:
          $ref: '#/components/schemas/load-balancing_session_affinity_attributes'
        session_affinity_ttl:
          $ref: '#/components/schemas/load-balancing_session_affinity_ttl'
        steering_policy:
          $ref: '#/components/schemas/load-balancing_steering_policy'
        ttl:
          $ref: '#/components/schemas/load-balancing_ttl'
      type: object
    load-balancing_load-balancer_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
      type: string
    load-balancing_load-balancer_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/load-balancing_load-balancer'
              type: array
    load-balancing_load-balancer_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/load-balancing_load-balancer'
    load-balancing_load_shedding:
      description: Configures load shedding policies and percentages for the pool.
      properties:
        default_percent:
          default: 0
          description: The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.
          maximum: 100
          minimum: 0
          type: number
        default_policy:
          default: random
          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
          type: string
        session_percent:
          default: 0
          description: The percent of existing sessions to shed from the pool, according to the session policy.
          maximum: 100
          minimum: 0
          type: number
        session_policy:
          default: hash
          description: Only the hash policy is supported for existing sessions (to avoid exponential decay).
          enum:
            - hash
          type: string
      type: object
    load-balancing_location_strategy:
      description: Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected.
      properties:
        mode:
          default: pop
          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
          example: resolver_ip
          type: string
        prefer_ecs:
          default: proximity
          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
          example: always
          type: string
      type: object
    load-balancing_longitude:
      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.
      type: number
    load-balancing_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    load-balancing_method:
      default: GET
      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.
      example: GET
      type: string
    load-balancing_minimum_origins:
      default: 1
      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.
      type: integer
    load-balancing_monitor:
      allOf:
        - $ref: '#/components/schemas/load-balancing_monitor-editable'
        - properties:
            created_on:
              $ref: '#/components/schemas/load-balancing_timestamp'
            id:
              $ref: '#/components/schemas/load-balancing_identifier'
            modified_on:
              $ref: '#/components/schemas/load-balancing_timestamp'
          type: object
    load-balancing_monitor-editable:
      properties:
        allow_insecure:
          $ref: '#/components/schemas/load-balancing_allow_insecure'
        consecutive_down:
          $ref: '#/components/schemas/load-balancing_consecutive_down'
        consecutive_up:
          $ref: '#/components/schemas/load-balancing_consecutive_up'
        description:
          $ref: '#/components/schemas/load-balancing_description'
        expected_body:
          $ref: '#/components/schemas/load-balancing_expected_body'
        expected_codes:
          $ref: '#/components/schemas/load-balancing_expected_codes'
        follow_redirects:
          $ref: '#/components/schemas/load-balancing_follow_redirects'
        header:
          $ref: '#/components/schemas/load-balancing_header'
        interval:
          $ref: '#/components/schemas/load-balancing_interval'
        method:
          $ref: '#/components/schemas/load-balancing_method'
        path:
          $ref: '#/components/schemas/load-balancing_path'
        port:
          $ref: '#/components/schemas/load-balancing_port'
        probe_zone:
          $ref: '#/components/schemas/load-balancing_probe_zone'
        retries:
          $ref: '#/components/schemas/load-balancing_retries'
        timeout:
          $ref: '#/components/schemas/load-balancing_timeout'
        type:
          $ref: '#/components/schemas/load-balancing_type'
      type: object
    load-balancing_monitor-response-collection:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/load-balancing_monitor'
              type: array
    load-balancing_monitor-response-single:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/load-balancing_monitor'
    load-balancing_monitor_id:
      description: The ID of the Monitor to use for checking the health of origins within this pool.
      type: string
    load-balancing_name:
      description: A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
      example: primary-dc-1
      type: string
    load-balancing_networks:
      description: List of networks where Load Balancer or Pool is enabled.
      items:
        example:
          - cloudflare
          - jdcloud
        type: string
      type: array
    load-balancing_notification_email:
      description: This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. 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
      type: string
    load-balancing_notification_filter:
      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/load-balancing_filter_options'
        pool:
          $ref: '#/components/schemas/load-balancing_filter_options'
      type: object
    load-balancing_origin:
      properties:
        address:
          $ref: '#/components/schemas/load-balancing_address'
        disabled_at:
          $ref: '#/components/schemas/load-balancing_disabled_at'
        enabled:
          $ref: '#/components/schemas/load-balancing_schemas-enabled'
        header:
          $ref: '#/components/schemas/load-balancing_schemas-header'
        name:
          $ref: '#/components/schemas/load-balancing_schemas-name'
        virtual_network_id:
          $ref: '#/components/schemas/load-balancing_virtual_network_id'
        weight:
          $ref: '#/components/schemas/load-balancing_weight'
      type: object
    load-balancing_origin-analytics:
      properties:
        address:
          $ref: '#/components/schemas/load-balancing_address'
        changed:
          $ref: '#/components/schemas/load-balancing_origin-changed'
        enabled:
          $ref: '#/components/schemas/load-balancing_schemas-enabled'
        failure_reason:
          $ref: '#/components/schemas/load-balancing_origin-failure-reason'
        healthy:
          $ref: '#/components/schemas/load-balancing_origin-healthy'
        ip:
          $ref: '#/components/schemas/load-balancing_origin-ip'
        name:
          $ref: '#/components/schemas/load-balancing_schemas-name'
      type: object
    load-balancing_origin-changed:
      description: Whether the origin has changed health status.
      example: true
      type: boolean
    load-balancing_origin-failure-reason:
      description: Failure reason for un-healthy origin health check.
      example: No failures
      type: string
    load-balancing_origin-health:
      properties:
        ip:
          properties:
            failure_reason:
              description: Failure reason.
              example: No failure reasons
              type: string
            healthy:
              description: Origin health status.
              example: true
              type: boolean
            response_code:
              description: Response code from origin health check.
              example: 200
              type: number
            rtt:
              description: Origin RTT (Round Trip Time) response.
              example: 201.5ms
              type: string
          type: object
      type: object
    load-balancing_origin-healthy:
      description: Whether the origin is reported as healthy.
      example: true
      type: boolean
    load-balancing_origin-ip:
      description: The IP address (IPv4 or IPv6) of the origin.
      example: 198.51.100.4
      type: string
    load-balancing_origin_health_data:
      description: The origin ipv4/ipv6 address or domain name mapped to it's health data.
      example:
        failure_reason: No failures
        healthy: true
        response_code: 200
        rtt: 66ms
      properties:
        failure_reason:
          type: string
        healthy:
          type: boolean
        response_code:
          type: number
        rtt:
          type: string
      type: object
    load-balancing_origin_healthy:
      default: true
      description: If true, filter events where the origin status is healthy. If false, filter events where the origin status is unhealthy.
      example: true
      type: boolean
    load-balancing_origin_steering:
      description: Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
      properties:
        policy:
          default: random
          description: |-
            The type of origin steering policy to use.
            - `"random"`: Select an origin randomly.
            - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
            - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
            - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
          enum:
            - random
            - hash
            - least_outstanding_requests
            - least_connections
          type: string
      type: object
    load-balancing_origins:
      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/load-balancing_origin'
      type: array
    load-balancing_patch_pools_notification_email:
      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: ""
      type: string
    load-balancing_path:
      default: /
      description: The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.
      example: /health
      type: string
    load-balancing_pool:
      properties:
        check_regions:
          $ref: '#/components/schemas/load-balancing_check_regions'
        created_on:
          $ref: '#/components/schemas/load-balancing_timestamp'
        description:
          $ref: '#/components/schemas/load-balancing_schemas-description'
        disabled_at:
          $ref: '#/components/schemas/load-balancing_schemas-disabled_at'
        enabled:
          $ref: '#/components/schemas/load-balancing_enabled'
        id:
          $ref: '#/components/schemas/load-balancing_schemas-identifier'
        latitude:
          $ref: '#/components/schemas/load-balancing_latitude'
        load_shedding:
          $ref: '#/components/schemas/load-balancing_load_shedding'
        longitude:
          $ref: '#/components/schemas/load-balancing_longitude'
        minimum_origins:
          $ref: '#/components/schemas/load-balancing_minimum_origins'
        modified_on:
          $ref: '#/components/schemas/load-balancing_timestamp'
        monitor:
          $ref: '#/components/schemas/load-balancing_monitor_id'
        name:
          $ref: '#/components/schemas/load-balancing_name'
        networks:
          $ref: '#/components/schemas/load-balancing_networks'
        notification_email:
          $ref: '#/components/schemas/load-balancing_notification_email'
        notification_filter:
          $ref: '#/components/schemas/load-balancing_notification_filter'
        origin_steering:
          $ref: '#/components/schemas/load-balancing_origin_steering'
        origins:
          $ref: '#/components/schemas/load-balancing_origins'
      type: object
    load-balancing_pool_name:
      description: The name for the pool to filter.
      example: primary-dc
      type: string
    load-balancing_pop_pools:
      additionalProperties:
        description: A `string:[string]` object of key-values. PoP code maps to list of pool IDs.
        items:
          type: string
        type: array
      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
      type: object
    load-balancing_port:
      default: 0
      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).'
      type: integer
    load-balancing_preview_id:
      example: f1aba936b94213e5b8dca0c0dbf1f9cc
    load-balancing_preview_response:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-single'
        - properties:
            result:
              properties:
                pools:
                  additionalProperties:
                    description: The pool name associated with the pool ID.
                    type: string
                  description: Monitored pool IDs mapped to their respective names.
                  example:
                    abwlnp5jbqn45ecgxd03erbgtxtqai0d: WNAM Datacenter
                    ve8h9lrcip5n5bbga9yqmdws28ay5d0l: EEU Datacenter
                  type: object
                preview_id:
                  $ref: '#/components/schemas/load-balancing_identifier'
              type: object
    load-balancing_preview_result:
      additionalProperties:
        properties:
          healthy:
            type: boolean
          origins:
            items:
              additionalProperties:
                $ref: '#/components/schemas/load-balancing_origin_health_data'
              maxProperties: 1
              minProperties: 1
              type: object
            type: array
        type: object
      description: Resulting health data from a preview operation.
      example:
        abwlnp5jbqn45ecgxd03erbgtxtqai0d:
          healthy: true
          origins:
            - originone.example.com.:
                failure_reason: No failures
                healthy: true
                response_code: 200
                rtt: 66ms
      type: object
    load-balancing_preview_result_response:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/load-balancing_preview_result'
    load-balancing_probe_zone:
      description: Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.
      example: example.com
      type: string
    load-balancing_proxied:
      default: false
      description: Whether the hostname should be gray clouded (false) or orange clouded (true).
      example: true
      type: boolean
    load-balancing_random_steering:
      description: |-
        Configures pool weights.
        - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
        - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
        - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.
      properties:
        default_weight:
          default: 1
          description: The default weight for pools in the load balancer that are not specified in the pool_weights map.
          example: 0.2
          maximum: 1
          minimum: 0
          multipleOf: 0.1
          type: number
        pool_weights:
          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
          properties:
            key:
              description: Pool ID
              type: string
            value:
              description: Weight
              type: number
          type: object
      type: object
    load-balancing_references_response:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-collection'
        - properties:
            result:
              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:
                properties:
                  reference_type:
                    enum:
                      - '*'
                      - referral
                      - referrer
                    type: string
                  resource_id:
                    type: string
                  resource_name:
                    type: string
                  resource_type:
                    type: string
                type: object
              type: array
    load-balancing_region_code:
      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
      type: string
    load-balancing_region_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-single'
        - properties:
            result:
              type: object
    load-balancing_region_pools:
      additionalProperties:
        description: A `string:[string]` object of key-values. Region code maps to list of pool IDs.
        items:
          type: string
        type: array
      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
      type: object
    load-balancing_resource_reference:
      description: A reference to a load balancer resource.
      properties:
        reference_type:
          description: When listed as a reference, the type (direction) of the reference.
          enum:
            - referral
            - referrer
          type: string
        references:
          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:
            description: A reference to a load balancer resource.
            type: object
          type: array
        resource_id:
          example: 17b5962d775c646f3f9725cbc7a53df4
        resource_name:
          description: The human-identifiable name of the resource.
          example: primary-dc-1
          type: string
        resource_type:
          description: The type of the resource.
          enum:
            - load_balancer
            - monitor
            - pool
          example: pool
          type: string
      type: object
    load-balancing_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    load-balancing_retries:
      default: 2
      description: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
      type: integer
    load-balancing_rules:
      description: 'BETA Field Not General Access: A list of rules for this load balancer to execute.'
      items:
        additionalProperties: false
        description: A rule object containing conditions and overrides for this load balancer to evaluate.
        properties:
          condition:
            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"
            type: string
          disabled:
            default: false
            description: Disable this specific rule. It will no longer be evaluated by this load balancer.
            type: boolean
          fixed_response:
            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:
                description: The http 'Content-Type' header to include in the response.
                example: application/json
                maxLength: 32
                type: string
              location:
                description: The http 'Location' header to include in the response.
                example: www.example.com
                maxLength: 2048
                type: string
              message_body:
                description: Text to include as the http body.
                example: Testing Hello
                maxLength: 1024
                type: string
              status_code:
                description: The http status code to respond with.
                type: integer
            type: object
          name:
            description: Name of this rule. Only used for human readability.
            example: route the path /testing to testing datacenter.
            maxLength: 200
            type: string
          overrides:
            description: A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.
            properties:
              adaptive_routing:
                $ref: '#/components/schemas/load-balancing_adaptive_routing'
              country_pools:
                $ref: '#/components/schemas/load-balancing_country_pools'
              default_pools:
                $ref: '#/components/schemas/load-balancing_default_pools'
              fallback_pool:
                $ref: '#/components/schemas/load-balancing_fallback_pool'
              location_strategy:
                $ref: '#/components/schemas/load-balancing_location_strategy'
              pop_pools:
                $ref: '#/components/schemas/load-balancing_pop_pools'
              random_steering:
                $ref: '#/components/schemas/load-balancing_random_steering'
              region_pools:
                $ref: '#/components/schemas/load-balancing_region_pools'
              session_affinity:
                $ref: '#/components/schemas/load-balancing_session_affinity'
              session_affinity_attributes:
                $ref: '#/components/schemas/load-balancing_session_affinity_attributes'
              session_affinity_ttl:
                $ref: '#/components/schemas/load-balancing_session_affinity_ttl'
              steering_policy:
                $ref: '#/components/schemas/load-balancing_steering_policy'
              ttl:
                $ref: '#/components/schemas/load-balancing_ttl'
            type: object
          priority:
            default: 0
            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.
            minimum: 0
            type: integer
          terminates:
            default: false
            description: If this rule's condition is true, this causes rule evaluation to stop after processing this rule.
            type: boolean
        type: object
      type: array
    load-balancing_schemas-description:
      description: A human-readable description of the pool.
      example: Primary data center - Provider XYZ
      type: string
    load-balancing_schemas-disabled_at:
      description: This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
      format: date-time
      readOnly: true
      type: string
    load-balancing_schemas-enabled:
      default: true
      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.
      example: true
      type: boolean
    load-balancing_schemas-header:
      description: The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.
      properties:
        Host:
          $ref: '#/components/schemas/load-balancing_Host'
      type: object
    load-balancing_schemas-id_response:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/load-balancing_schemas-identifier'
              type: object
    load-balancing_schemas-identifier:
      example: 17b5962d775c646f3f9725cbc7a53df4
      type: string
    load-balancing_schemas-name:
      description: A human-identifiable name for the origin.
      example: app-server-1
      type: string
    load-balancing_schemas-preview_id:
      example: p1aba936b94213e5b8dca0c0dbf1f9cc
      type: string
    load-balancing_schemas-references_response:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-collection'
        - properties:
            result:
              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:
                properties:
                  reference_type:
                    enum:
                      - '*'
                      - referral
                      - referrer
                    type: string
                  resource_id:
                    type: string
                  resource_name:
                    type: string
                  resource_type:
                    type: string
                type: object
              type: array
    load-balancing_schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/load-balancing_pool'
              type: array
    load-balancing_schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/load-balancing_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/load-balancing_pool'
    load-balancing_search:
      properties:
        resources:
          description: A list of resources matching the search query.
          items:
            $ref: '#/components/schemas/load-balancing_resource_reference'
          type: array
      type: object
    load-balancing_search_params:
      properties:
        query:
          default: ""
          description: Search query term.
          example: primary
          type: string
        references:
          default: ""
          description: The type of references to include ("*" for all).
          enum:
            - ""
            - '*'
            - referral
            - referrer
          example: '*'
          type: string
      type: object
    load-balancing_search_result:
      properties:
        result:
          $ref: '#/components/schemas/load-balancing_search'
      type: object
    load-balancing_session_affinity:
      default: ""
      description: |-
        Specifies the type of session affinity the load balancer should use unless specified as `"none"` or "" (default). The supported types are:
        - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used.
        - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address.
        - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.
      enum:
        - none
        - cookie
        - ip_cookie
        - header
        - ""
      example: cookie
      type: string
    load-balancing_session_affinity_attributes:
      description: Configures attributes for session affinity.
      properties:
        drain_duration:
          description: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
          example: 100
          type: number
        headers:
          default: none
          description: 'Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.'
          items:
            description: An HTTP header name.
            maxLength: 100
            minLength: 1
            pattern: ^[a-zA-Z0-9_-]+$
            type: string
          type: array
          uniqueItems: true
        require_all_headers:
          default: false
          description: |-
            When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
            - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.
            - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.
          type: boolean
        samesite:
          default: Auto
          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
          example: Auto
          type: string
        secure:
          default: Auto
          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
          example: Auto
          type: string
        zero_downtime_failover:
          default: none
          description: |-
            Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:
            - `"none"`: No failover takes place for sessions pinned to the origin (default).
            - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping.
            - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.
          enum:
            - none
            - temporary
            - sticky
          example: sticky
          type: string
      type: object
    load-balancing_session_affinity_ttl:
      description: |-
        Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are:
        - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800].
        - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.
      example: 1800
      type: number
    load-balancing_steering_policy:
      default: ""
      description: |-
        Steering Policy for this load balancer.
        - `"off"`: Use `default_pools`.
        - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
        - `"random"`: Select a pool randomly.
        - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
        - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
        - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
        - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
        - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.
      enum:
        - "off"
        - geo
        - random
        - dynamic_latency
        - proximity
        - least_outstanding_requests
        - least_connections
        - ""
      example: dynamic_latency
      type: string
    load-balancing_subdivision_code_a2:
      description: Two-letter subdivision code followed in ISO 3166-2.
      example: CA
      type: string
    load-balancing_timeout:
      default: 5
      description: The timeout (in seconds) before marking the health check as failed.
      type: integer
    load-balancing_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      readOnly: true
      type: string
    load-balancing_ttl:
      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
      type: number
    load-balancing_type:
      default: http
      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
      example: https
      type: string
    load-balancing_until:
      description: End date and time of requesting data period in the ISO8601 format.
      example: "2016-11-11T13:00:00Z"
      format: date-time
      type: string
    load-balancing_virtual_network_id:
      description: The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.
      example: a5624d4e-044a-4ff0-b3e1-e2465353d4b4
      type: string
    load-balancing_weight:
      default: 1
      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.
        - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests.
        - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections.
      example: 0.6
      maximum: 1
      minimum: 0
      multipleOf: 0.01
      type: number
    logcontrol_account_identifier:
      $ref: '#/components/schemas/logcontrol_identifier'
    logcontrol_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/logcontrol_messages'
        messages:
          $ref: '#/components/schemas/logcontrol_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    logcontrol_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/logcontrol_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/logcontrol_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    logcontrol_api-response-single:
      allOf:
        - $ref: '#/components/schemas/logcontrol_api-response-common'
      type: object
    logcontrol_cmb_config:
      nullable: true
      properties:
        regions:
          $ref: '#/components/schemas/logcontrol_regions'
      type: object
    logcontrol_cmb_config_response_single:
      allOf:
        - $ref: '#/components/schemas/logcontrol_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/logcontrol_cmb_config'
    logcontrol_flag:
      description: The log retention flag for Logpull API.
      example: true
      type: boolean
    logcontrol_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    logcontrol_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    logcontrol_regions:
      description: Comma-separated list of regions.
      example: eu
      maxLength: 256
      pattern: ^[a-z,]*$
      type: string
    logcontrol_retention_flag:
      nullable: true
      properties:
        flag:
          $ref: '#/components/schemas/logcontrol_flag'
      type: object
    logcontrol_retention_flag_response_single:
      allOf:
        - $ref: '#/components/schemas/logcontrol_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/logcontrol_retention_flag'
    logcontrol_zone_identifier:
      $ref: '#/components/schemas/logcontrol_identifier'
    logpush_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/logpush_messages'
        messages:
          $ref: '#/components/schemas/logpush_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    logpush_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/logpush_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/logpush_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    logpush_api-response-single:
      allOf:
        - $ref: '#/components/schemas/logpush_api-response-common'
      type: object
    logpush_dataset:
      description: Name of the dataset. A list of supported datasets can be found on the [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).
      example: http_requests
      maxLength: 256
      nullable: true
      pattern: ^[a-zA-Z0-9_\-]*$
      type: string
    logpush_destination_conf:
      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
      format: uri
      maxLength: 4096
      type: string
    logpush_destination_exists_response:
      allOf:
        - $ref: '#/components/schemas/logpush_api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                exists:
                  example: false
                  type: boolean
              type: object
    logpush_enabled:
      description: Flag that indicates if the job is enabled.
      example: false
      type: boolean
    logpush_error_message:
      description: 'If not null, the job is currently failing. Failures are usually repetitive (example: no permissions to write to destination bucket). Only the last failure is recorded. On successful execution of a job the error_message and last_error are set to null.'
      format: date-time
      nullable: true
      type: string
    logpush_fields:
      description: Comma-separated list of fields.
      example: ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID
      type: string
    logpush_filter:
      description: Filters to drill down into specific events.
      example: '{"where":{"and":[{"key":"ClientCountry","operator":"neq","value":"ca"}]}}'
      type: string
    logpush_frequency:
      default: high
      deprecated: true
      description: This field is deprecated. Please use `max_upload_*` parameters instead. 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
      example: high
      nullable: true
      type: string
    logpush_get_ownership_response:
      allOf:
        - $ref: '#/components/schemas/logpush_api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                filename:
                  example: logs/challenge-filename.txt
                  type: string
                message:
                  example: ""
                  type: string
                valid:
                  example: true
                  type: boolean
              type: object
    logpush_id:
      description: Unique id of the job.
      minimum: 1
      type: integer
    logpush_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    logpush_instant_logs_job:
      nullable: true
      properties:
        destination_conf:
          $ref: '#/components/schemas/logpush_schemas-destination_conf'
        fields:
          $ref: '#/components/schemas/logpush_fields'
        filter:
          $ref: '#/components/schemas/logpush_filter'
        sample:
          $ref: '#/components/schemas/logpush_sample'
        session_id:
          $ref: '#/components/schemas/logpush_session_id'
      type: object
    logpush_instant_logs_job_response_collection:
      allOf:
        - $ref: '#/components/schemas/logpush_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/logpush_instant_logs_job'
              type: array
    logpush_instant_logs_job_response_single:
      allOf:
        - $ref: '#/components/schemas/logpush_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/logpush_instant_logs_job'
    logpush_kind:
      default: ""
      description: The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs. Currently, Edge Log Delivery is only supported for the `http_requests` dataset.
      enum:
        - edge
      example: ""
      nullable: true
      type: string
    logpush_last_complete:
      description: Records the last time for which logs have been successfully pushed. If the last successful push was for logs range 2018-07-23T10:00:00Z to 2018-07-23T10:01:00Z then the value of this field will be 2018-07-23T10:01:00Z. If the job has never run or has just been enabled and hasn't run yet then the field will be empty.
      format: date-time
      nullable: true
      type: string
    logpush_last_error:
      description: Records the last time the job failed. If not null, the job is currently failing. If null, the job has either never failed or has run successfully at least once since last failure. See also the error_message field.
      format: date-time
      nullable: true
      type: string
    logpush_logpull_options:
      deprecated: true
      description: This field is deprecated. Use `output_options` instead. Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.
      example: fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339
      format: uri-reference
      maxLength: 4096
      nullable: true
      type: string
    logpush_logpush_field_response_collection:
      allOf:
        - $ref: '#/components/schemas/logpush_api-response-common'
        - properties:
            result:
              items:
                nullable: true
                properties:
                  key:
                    example: value
                    type: string
                type: object
              type: object
    logpush_logpush_job:
      nullable: true
      properties:
        dataset:
          $ref: '#/components/schemas/logpush_dataset'
        destination_conf:
          $ref: '#/components/schemas/logpush_destination_conf'
        enabled:
          $ref: '#/components/schemas/logpush_enabled'
        error_message:
          $ref: '#/components/schemas/logpush_error_message'
        frequency:
          $ref: '#/components/schemas/logpush_frequency'
        id:
          $ref: '#/components/schemas/logpush_id'
        kind:
          $ref: '#/components/schemas/logpush_kind'
        last_complete:
          $ref: '#/components/schemas/logpush_last_complete'
        last_error:
          $ref: '#/components/schemas/logpush_last_error'
        logpull_options:
          $ref: '#/components/schemas/logpush_logpull_options'
        max_upload_bytes:
          $ref: '#/components/schemas/logpush_max_upload_bytes'
        max_upload_interval_seconds:
          $ref: '#/components/schemas/logpush_max_upload_interval_seconds'
        max_upload_records:
          $ref: '#/components/schemas/logpush_max_upload_records'
        name:
          $ref: '#/components/schemas/logpush_name'
        output_options:
          $ref: '#/components/schemas/logpush_output_options'
      type: object
    logpush_logpush_job_response_collection:
      allOf:
        - $ref: '#/components/schemas/logpush_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/logpush_logpush_job'
              type: array
    logpush_logpush_job_response_single:
      allOf:
        - $ref: '#/components/schemas/logpush_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/logpush_logpush_job'
    logpush_max_upload_bytes:
      description: The maximum uncompressed file size of a batch of logs. This setting value must be between `5 MB` and `1 GB`, or `0` to disable it. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size. This parameter is not available for jobs with `edge` as its kind.
      example: 5e+06
      maximum: 1e+09
      minimum: 5e+06
      nullable: true
      type: integer
    logpush_max_upload_interval_seconds:
      default: 30
      description: The maximum interval in seconds for log batches. This setting must be between 30 and 300 seconds (5 minutes), or `0` to disable it. Note that you cannot specify a minimum interval for log batches; this means that log files may be sent in shorter intervals than this. This parameter is only used for jobs with `edge` as its kind.
      example: 30
      maximum: 300
      minimum: 30
      nullable: true
      type: integer
    logpush_max_upload_records:
      default: 100000
      description: The maximum number of log lines per batch. This setting must be between 1000 and 1,000,000 lines, or `0` to disable it. Note that you cannot specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this. This parameter is not available for jobs with `edge` as its kind.
      example: 1000
      maximum: 1e+06
      minimum: 1000
      nullable: true
      type: integer
    logpush_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    logpush_name:
      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
      maxLength: 512
      nullable: true
      pattern: ^[a-zA-Z0-9\-\.]*$
      type: string
    logpush_output_options:
      description: The structured replacement for `logpull_options`. When including this field, the `logpull_option` field will be ignored.
      nullable: true
      properties:
        CVE-2021-4428:
          default: false
          description: If set to true, will cause all occurrences of `${` in the generated files to be replaced with `x{`.
          nullable: true
          type: boolean
        batch_prefix:
          default: ""
          description: String to be prepended before each batch.
          nullable: true
          type: string
        batch_suffix:
          default: ""
          description: String to be appended after each batch.
          nullable: true
          type: string
        field_delimiter:
          default: ','
          description: String to join fields. This field be ignored when `record_template` is set.
          nullable: true
          type: string
        field_names:
          description: List of field names to be included in the Logpush output. For the moment, there is no option to add all fields at once, so you must specify all the fields names you are interested in.
          example:
            - ClientIP
            - EdgeStartTimestamp
            - RayID
          items:
            type: string
          type: array
        output_type:
          default: ndjson
          description: Specifies the output type, such as `ndjson` or `csv`. This sets default values for the rest of the settings, depending on the chosen output type. Some formatting rules, like string quoting, are different between output types.
          enum:
            - ndjson
            - csv
          example: ndjson
          type: string
        record_delimiter:
          default: ""
          description: String to be inserted in-between the records as separator.
          nullable: true
          type: string
        record_prefix:
          default: '{'
          description: String to be prepended before each record.
          nullable: true
          type: string
        record_suffix:
          default: |
            }
          description: String to be appended after each record.
          nullable: true
          type: string
        record_template:
          default: ""
          description: String to use as template for each record instead of the default comma-separated list. All fields used in the template must be present in `field_names` as well, otherwise they will end up as null. Format as a Go `text/template` without any standard functions, like conditionals, loops, sub-templates, etc.
          nullable: true
          type: string
        sample_rate:
          default: 1
          description: Floating number to specify sampling rate. Sampling is applied on top of filtering, and regardless of the current `sample_interval` of the data.
          format: float
          maximum: 1
          minimum: 0
          nullable: true
          type: number
        timestamp_format:
          default: unixnano
          description: String to specify the format for timestamps, such as `unixnano`, `unix`, or `rfc3339`.
          enum:
            - unixnano
            - unix
            - rfc3339
          type: string
      type: object
    logpush_ownership_challenge:
      description: Ownership challenge token to prove destination ownership.
      example: "00000000000000000000"
      maxLength: 4096
      pattern: ^[a-zA-Z0-9/\+\.\-_]*$
      type: string
    logpush_sample:
      description: 'The sample parameter is the sample rate of the records set by the client: "sample": 1 is 100% of records "sample": 10 is 10% and so on.'
      example: 1
      type: integer
    logpush_schemas-destination_conf:
      description: Unique WebSocket address that will receive messages from Cloudflare’s edge.
      example: wss://logs.cloudflare.com/instant-logs/ws/sessions/99d471b1ca3c23cc8e30b6acec5db987
      format: uri
      maxLength: 4096
      type: string
    logpush_session_id:
      description: Unique session id of the job.
      example: 99d471b1ca3c23cc8e30b6acec5db987
      type: string
    logpush_validate_ownership_response:
      allOf:
        - $ref: '#/components/schemas/logpush_api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                valid:
                  example: true
                  type: boolean
              type: object
    logpush_validate_response:
      allOf:
        - $ref: '#/components/schemas/logpush_api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                message:
                  example: ""
                  type: string
                valid:
                  example: true
                  type: boolean
              type: object
    logshare_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/logshare_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/logshare_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    logshare_count:
      description: When `?count=` is provided, the response will contain up to `count` results. Since results are not sorted, you are likely to get different data for repeated requests. `count` must be an integer > 0.
      minimum: 1
      type: integer
    logshare_end:
      anyOf:
        - type: string
        - type: integer
      description: Sets the (exclusive) end of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. `end` must be at least five minutes earlier than now and must be later than `start`. Difference between `start` and `end` must be not greater than one hour.
      example: "2018-05-20T10:01:00Z"
    logshare_fields:
      description: 'The `/received` route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. Most customers require only a small subset of fields, but that subset varies from customer to customer; 2. Flat schema is much easier to work with downstream (importing into BigTable etc); 3. Performance (time to process, file size). If `?fields=` is not specified, default field set is returned. This default field set may change at any time. When `?fields=` is provided, each record is returned with the specified fields. `fields` must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified does not matter, and the order of fields in the response is not specified.'
      example: ClientIP,RayID,EdgeStartTimestamp
      type: string
    logshare_fields_response:
      properties:
        key:
          example: value
          type: string
      type: object
    logshare_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    logshare_logs_response_json_lines:
      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}
    logshare_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    logshare_ray_identifier:
      description: Ray identifier.
      example: 41ddf1740f67442d
      maxLength: 16
      readOnly: true
      type: string
    logshare_sample:
      description: 'When `?sample=` is provided, a sample of matching records is returned. If `sample=0.1` then 10% of records will be returned. Sampling is random: repeated calls will not only return different records, but likely will also vary slightly in number of returned records. When `?count=` is also specified, `count` is applied to the number of returned records, not the sampled records. So, with `sample=0.05` and `count=7`, when there is a total of 100 records available, approximately five will be returned. When there are 1000 records, seven will be returned. When there are 10,000 records, seven will be returned.'
      example: 0.1
      maximum: 1
      minimum: 0
      type: number
    logshare_start:
      anyOf:
        - type: string
        - type: integer
      description: Sets the (inclusive) beginning of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than seven days.
      example: "2018-05-20T10:00:00Z"
    logshare_timestamps:
      default: unixnano
      description: 'By default, timestamps in responses are returned as Unix nanosecond integers. The `?timestamps=` argument can be set to change the format in which response timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns timestamps as strings.'
      enum:
        - unix
        - unixnano
        - rfc3339
      example: unixnano
      type: string
    logshare_zone_identifier:
      $ref: '#/components/schemas/logshare_identifier'
    magic-transit_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/magic-transit_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/magic-transit_result_info'
      type: object
    magic-transit_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/magic-transit_messages'
        messages:
          $ref: '#/components/schemas/magic-transit_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    magic-transit_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/magic-transit_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/magic-transit_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    magic-transit_asn:
      description: AS number associated with the node object.
      type: string
    magic-transit_colo:
      properties:
        city:
          $ref: '#/components/schemas/magic-transit_colo_city'
        name:
          $ref: '#/components/schemas/magic-transit_colo_name'
      type: object
    magic-transit_colo_city:
      description: Source colo city.
      example: Denver, CO, US
      type: string
    magic-transit_colo_name:
      description: Source colo name.
      example: den01
      type: string
    magic-transit_colo_result:
      properties:
        colo:
          $ref: '#/components/schemas/magic-transit_colo'
        error:
          $ref: '#/components/schemas/magic-transit_error'
        hops:
          items:
            $ref: '#/components/schemas/magic-transit_hop_result'
          type: array
        target_summary:
          $ref: '#/components/schemas/magic-transit_target_summary'
        traceroute_time_ms:
          $ref: '#/components/schemas/magic-transit_traceroute_time_ms'
      type: object
    magic-transit_colos:
      description: If no source colo names specified, all colos will be used. China colos are unavailable for traceroutes.
      example:
        - den
        - sin
      items:
        description: Source colo name.
        type: string
      type: array
    magic-transit_error:
      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: ""
      type: string
    magic-transit_hop_result:
      properties:
        nodes:
          description: An array of node objects.
          items:
            $ref: '#/components/schemas/magic-transit_node_result'
          type: array
        packets_lost:
          $ref: '#/components/schemas/magic-transit_packets_lost'
        packets_sent:
          $ref: '#/components/schemas/magic-transit_packets_sent'
        packets_ttl:
          $ref: '#/components/schemas/magic-transit_packets_ttl'
      type: object
    magic-transit_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    magic-transit_ip:
      description: IP address of the node.
      type: string
    magic-transit_labels:
      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
      type: array
    magic-transit_max_rtt_ms:
      description: Maximum RTT in ms.
      type: number
    magic-transit_max_ttl:
      default: 15
      description: Max TTL.
      maximum: 64
      minimum: 0
      type: integer
    magic-transit_mean_rtt_ms:
      description: Mean RTT in ms.
      type: number
    magic-transit_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    magic-transit_min_rtt_ms:
      description: Minimum RTT in ms.
      type: number
    magic-transit_name:
      description: Host name of the address, this may be the same as the IP address.
      type: string
    magic-transit_node_result:
      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/magic-transit_asn'
        ip:
          $ref: '#/components/schemas/magic-transit_ip'
        labels:
          $ref: '#/components/schemas/magic-transit_labels'
        max_rtt_ms:
          $ref: '#/components/schemas/magic-transit_max_rtt_ms'
        mean_rtt_ms:
          $ref: '#/components/schemas/magic-transit_mean_rtt_ms'
        min_rtt_ms:
          $ref: '#/components/schemas/magic-transit_min_rtt_ms'
        name:
          $ref: '#/components/schemas/magic-transit_name'
        packet_count:
          $ref: '#/components/schemas/magic-transit_packet_count'
        std_dev_rtt_ms:
          $ref: '#/components/schemas/magic-transit_std_dev_rtt_ms'
      type: object
    magic-transit_options:
      example:
        max_ttl: 15
        packet_type: icmp
      properties:
        max_ttl:
          $ref: '#/components/schemas/magic-transit_max_ttl'
        packet_type:
          $ref: '#/components/schemas/magic-transit_packet_type'
        packets_per_ttl:
          $ref: '#/components/schemas/magic-transit_packets_per_ttl'
        port:
          $ref: '#/components/schemas/magic-transit_port'
        wait_time:
          $ref: '#/components/schemas/magic-transit_wait_time'
    magic-transit_packet_count:
      description: Number of packets with a response from this node.
      type: integer
    magic-transit_packet_type:
      default: icmp
      description: Type of packet sent.
      enum:
        - icmp
        - tcp
        - udp
        - gre
        - gre+icmp
      example: icmp
      type: string
    magic-transit_packets_lost:
      description: Number of packets where no response was received.
      type: integer
    magic-transit_packets_per_ttl:
      default: 3
      description: Number of packets sent at each TTL.
      maximum: 10
      minimum: 0
      type: integer
    magic-transit_packets_sent:
      description: Number of packets sent with specified TTL.
      type: integer
    magic-transit_packets_ttl:
      description: The time to live (TTL).
      type: integer
    magic-transit_port:
      default: 0
      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.
      maximum: 65535
      minimum: 0
      type: integer
    magic-transit_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    magic-transit_std_dev_rtt_ms:
      description: Standard deviation of the RTTs in ms.
      type: number
    magic-transit_target:
      description: The target hostname, IPv6, or IPv6 address.
      example: 1.1.1.1
      type: string
    magic-transit_target_result:
      properties:
        colos:
          items:
            $ref: '#/components/schemas/magic-transit_colo_result'
          type: array
        target:
          $ref: '#/components/schemas/magic-transit_target'
      type: object
    magic-transit_target_summary:
      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
      type: object
    magic-transit_targets:
      example:
        - 203.0.113.1
        - cloudflare.com
      items:
        description: Hosts as a hostname or IPv4/IPv6 address represented by strings.
        example: 203.0.113.1
        type: string
      maxLength: 10
      type: array
    magic-transit_traceroute_response_collection:
      allOf:
        - $ref: '#/components/schemas/magic-transit_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/magic-transit_target_result'
              type: array
    magic-transit_traceroute_time_ms:
      description: Total time of traceroute in ms.
      type: integer
    magic-transit_wait_time:
      default: 1
      description: Set the time (in seconds) to wait for a response to a probe.
      maximum: 5
      minimum: 1
      type: integer
    magic-visibility_account_identifier:
      example: 6f91088a406011ed95aed352566e8d4c
      type: string
    magic-visibility_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/magic-visibility_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/magic-visibility_result_info'
      type: object
    magic-visibility_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/magic-visibility_messages'
        messages:
          $ref: '#/components/schemas/magic-visibility_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    magic-visibility_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/magic-visibility_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/magic-visibility_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    magic-visibility_api-response-single:
      allOf:
        - $ref: '#/components/schemas/magic-visibility_api-response-common'
        - properties:
            result:
              anyOf:
                - nullable: true
                  type: object
                - nullable: true
                  type: string
      type: object
    magic-visibility_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    magic-visibility_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    magic-visibility_mnm_config:
      properties:
        default_sampling:
          $ref: '#/components/schemas/magic-visibility_mnm_config_default_sampling'
        name:
          $ref: '#/components/schemas/magic-visibility_mnm_config_name'
        router_ips:
          $ref: '#/components/schemas/magic-visibility_mnm_config_router_ips'
        warp_devices:
          $ref: '#/components/schemas/magic-visibility_mnm_config_warp_devices'
      required:
        - name
        - default_sampling
        - router_ips
        - warp_devices
      type: object
    magic-visibility_mnm_config_default_sampling:
      default: 1
      description: Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
      minimum: 1
      type: number
    magic-visibility_mnm_config_name:
      description: The account name.
      example: cloudflare user's account
      type: string
    magic-visibility_mnm_config_router_ip:
      description: IPv4 CIDR of the router sourcing flow data. Only /32 addresses are currently supported.
      example: 203.0.113.1
      type: string
    magic-visibility_mnm_config_router_ips:
      items:
        $ref: '#/components/schemas/magic-visibility_mnm_config_router_ip'
      type: array
    magic-visibility_mnm_config_single_response:
      allOf:
        - $ref: '#/components/schemas/magic-visibility_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic-visibility_mnm_config'
          type: object
    magic-visibility_mnm_config_warp_device:
      description: Object representing a warp device with an ID and name.
      properties:
        id:
          description: Unique identifier for the warp device.
          example: 5360368d-b351-4791-abe1-93550dabd351
          type: string
        name:
          description: Name of the warp device.
          example: My warp device
          type: string
        router_ip:
          description: IPv4 CIDR of the router sourcing flow data associated with this warp device. Only /32 addresses are currently supported.
          example: 203.0.113.1
          type: string
      required:
        - id
        - name
        - router_ip
      type: object
    magic-visibility_mnm_config_warp_devices:
      items:
        $ref: '#/components/schemas/magic-visibility_mnm_config_warp_device'
      type: array
    magic-visibility_mnm_rule:
      nullable: true
      properties:
        automatic_advertisement:
          $ref: '#/components/schemas/magic-visibility_mnm_rule_automatic_advertisement'
        bandwidth_threshold:
          $ref: '#/components/schemas/magic-visibility_mnm_rule_bandwidth_threshold'
        duration:
          $ref: '#/components/schemas/magic-visibility_mnm_rule_duration'
        id:
          $ref: '#/components/schemas/magic-visibility_rule_identifier'
        name:
          $ref: '#/components/schemas/magic-visibility_mnm_rule_name'
        packet_threshold:
          $ref: '#/components/schemas/magic-visibility_mnm_rule_packet_threshold'
        prefixes:
          $ref: '#/components/schemas/magic-visibility_mnm_rule_ip_prefixes'
      required:
        - name
        - prefixes
        - automatic_advertisement
        - duration
      type: object
    magic-visibility_mnm_rule_advertisable_response:
      nullable: true
      properties:
        automatic_advertisement:
          $ref: '#/components/schemas/magic-visibility_mnm_rule_automatic_advertisement'
      required:
        - automatic_advertisement
      type: object
    magic-visibility_mnm_rule_advertisement_single_response:
      allOf:
        - $ref: '#/components/schemas/magic-visibility_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic-visibility_mnm_rule_advertisable_response'
          type: object
    magic-visibility_mnm_rule_automatic_advertisement:
      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"
      nullable: true
      type: boolean
    magic-visibility_mnm_rule_bandwidth_threshold:
      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
      type: number
    magic-visibility_mnm_rule_duration:
      default: 1m
      description: The amount of time that the rule threshold must be exceeded to send an alert notification. The final value must be equivalent to one of the following 8 values ["1m","5m","10m","15m","20m","30m","45m","60m"]. The format is AhBmCsDmsEusFns where A, B, C, D, E and F durations are optional; however at least one unit must be provided.
      example: 300s
      type: string
    magic-visibility_mnm_rule_ip_prefix:
      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
      type: string
    magic-visibility_mnm_rule_ip_prefixes:
      items:
        $ref: '#/components/schemas/magic-visibility_mnm_rule_ip_prefix'
      type: array
    magic-visibility_mnm_rule_name:
      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
      type: string
    magic-visibility_mnm_rule_packet_threshold:
      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
      type: number
    magic-visibility_mnm_rules_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic-visibility_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/magic-visibility_mnm_rule'
              nullable: true
              type: array
    magic-visibility_mnm_rules_single_response:
      allOf:
        - $ref: '#/components/schemas/magic-visibility_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic-visibility_mnm_rule'
          type: object
    magic-visibility_pcaps_byte_limit:
      description: The maximum number of bytes to capture. This field only applies to `full` packet captures.
      example: 500000
      maximum: 1e+09
      minimum: 1
      type: number
    magic-visibility_pcaps_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic-visibility_api-response-collection'
        - properties:
            result:
              items:
                anyOf:
                  - $ref: '#/components/schemas/magic-visibility_pcaps_response_simple'
                  - $ref: '#/components/schemas/magic-visibility_pcaps_response_full'
              type: array
    magic-visibility_pcaps_colo_name:
      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
      type: string
    magic-visibility_pcaps_destination_conf:
      description: The full URI for the bucket. This field only applies to `full` packet captures.
      example: s3://pcaps-bucket?region=us-east-1
      type: string
    magic-visibility_pcaps_error_message:
      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.
      type: string
    magic-visibility_pcaps_filter_v1:
      description: The packet capture filter. When this field is empty, all packets are captured.
      properties:
        destination_address:
          description: The destination IP address of the packet.
          example: 1.2.3.4
          type: string
        destination_port:
          description: The destination port of the packet.
          example: 80
          type: number
        protocol:
          description: The protocol number of the packet.
          example: 6
          type: number
        source_address:
          description: The source IP address of the packet.
          example: 1.2.3.4
          type: string
        source_port:
          description: The source port of the packet.
          example: 123
          type: number
      type: object
    magic-visibility_pcaps_id:
      description: The ID for the packet capture.
      example: 66802ca5668e47a2b82c2e6746e45037
      maxLength: 32
      minLength: 32
      type: string
    magic-visibility_pcaps_ownership_challenge:
      description: The ownership challenge filename stored in the bucket.
      example: ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt
      type: string
    magic-visibility_pcaps_ownership_collection:
      allOf:
        - $ref: '#/components/schemas/magic-visibility_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/magic-visibility_pcaps_ownership_response'
              nullable: true
              type: array
    magic-visibility_pcaps_ownership_request:
      properties:
        destination_conf:
          $ref: '#/components/schemas/magic-visibility_pcaps_destination_conf'
      required:
        - destination_conf
      type: object
    magic-visibility_pcaps_ownership_response:
      properties:
        destination_conf:
          $ref: '#/components/schemas/magic-visibility_pcaps_destination_conf'
        filename:
          $ref: '#/components/schemas/magic-visibility_pcaps_ownership_challenge'
        id:
          description: The bucket ID associated with the packet captures API.
          example: 9883874ecac311ec8475433579a6bf5f
          maxLength: 32
          minLength: 32
          type: string
        status:
          description: The status of the ownership challenge. Can be pending, success or failed.
          enum:
            - pending
            - success
            - failed
          example: success
          type: string
        submitted:
          description: The RFC 3339 timestamp when the bucket was added to packet captures API.
          example: "2020-01-01T08:00:00Z"
          type: string
        validated:
          description: The RFC 3339 timestamp when the bucket was validated.
          example: "2020-01-01T08:00:00Z"
          type: string
      required:
        - id
        - status
        - submitted
        - destination_conf
        - filename
      type: object
    magic-visibility_pcaps_ownership_single_response:
      allOf:
        - $ref: '#/components/schemas/magic-visibility_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/magic-visibility_pcaps_ownership_response'
    magic-visibility_pcaps_ownership_validate_request:
      properties:
        destination_conf:
          $ref: '#/components/schemas/magic-visibility_pcaps_destination_conf'
        ownership_challenge:
          $ref: '#/components/schemas/magic-visibility_pcaps_ownership_challenge'
      required:
        - destination_conf
        - ownership_challenge
      type: object
    magic-visibility_pcaps_packet_limit:
      description: The limit of packets contained in a packet capture.
      example: 10000
      maximum: 10000
      minimum: 1
      type: number
    magic-visibility_pcaps_request_full:
      properties:
        byte_limit:
          $ref: '#/components/schemas/magic-visibility_pcaps_byte_limit'
        colo_name:
          $ref: '#/components/schemas/magic-visibility_pcaps_colo_name'
        destination_conf:
          $ref: '#/components/schemas/magic-visibility_pcaps_destination_conf'
        filter_v1:
          $ref: '#/components/schemas/magic-visibility_pcaps_filter_v1'
        packet_limit:
          $ref: '#/components/schemas/magic-visibility_pcaps_packet_limit'
        system:
          $ref: '#/components/schemas/magic-visibility_pcaps_system'
        time_limit:
          $ref: '#/components/schemas/magic-visibility_pcaps_time_limit'
        type:
          $ref: '#/components/schemas/magic-visibility_pcaps_type'
      required:
        - time_limit
        - type
        - system
        - colo_name
        - destination_conf
      type: object
    magic-visibility_pcaps_request_pcap:
      anyOf:
        - $ref: '#/components/schemas/magic-visibility_pcaps_request_simple'
        - $ref: '#/components/schemas/magic-visibility_pcaps_request_full'
    magic-visibility_pcaps_request_simple:
      properties:
        filter_v1:
          $ref: '#/components/schemas/magic-visibility_pcaps_filter_v1'
        packet_limit:
          $ref: '#/components/schemas/magic-visibility_pcaps_packet_limit'
        system:
          $ref: '#/components/schemas/magic-visibility_pcaps_system'
        time_limit:
          $ref: '#/components/schemas/magic-visibility_pcaps_time_limit'
        type:
          $ref: '#/components/schemas/magic-visibility_pcaps_type'
      required:
        - time_limit
        - packet_limit
        - type
        - system
      type: object
    magic-visibility_pcaps_response_full:
      properties:
        byte_limit:
          $ref: '#/components/schemas/magic-visibility_pcaps_byte_limit'
        colo_name:
          $ref: '#/components/schemas/magic-visibility_pcaps_colo_name'
        destination_conf:
          $ref: '#/components/schemas/magic-visibility_pcaps_destination_conf'
        error_message:
          $ref: '#/components/schemas/magic-visibility_pcaps_error_message'
        filter_v1:
          $ref: '#/components/schemas/magic-visibility_pcaps_filter_v1'
        id:
          $ref: '#/components/schemas/magic-visibility_pcaps_id'
        status:
          $ref: '#/components/schemas/magic-visibility_pcaps_status'
        submitted:
          $ref: '#/components/schemas/magic-visibility_pcaps_submitted'
        system:
          $ref: '#/components/schemas/magic-visibility_pcaps_system'
        time_limit:
          $ref: '#/components/schemas/magic-visibility_pcaps_time_limit'
        type:
          $ref: '#/components/schemas/magic-visibility_pcaps_type'
      type: object
    magic-visibility_pcaps_response_simple:
      properties:
        filter_v1:
          $ref: '#/components/schemas/magic-visibility_pcaps_filter_v1'
        id:
          $ref: '#/components/schemas/magic-visibility_pcaps_id'
        status:
          $ref: '#/components/schemas/magic-visibility_pcaps_status'
        submitted:
          $ref: '#/components/schemas/magic-visibility_pcaps_submitted'
        system:
          $ref: '#/components/schemas/magic-visibility_pcaps_system'
        time_limit:
          $ref: '#/components/schemas/magic-visibility_pcaps_time_limit'
        type:
          $ref: '#/components/schemas/magic-visibility_pcaps_type'
      type: object
    magic-visibility_pcaps_single_response:
      allOf:
        - $ref: '#/components/schemas/magic-visibility_api-response-single'
        - properties:
            result:
              anyOf:
                - $ref: '#/components/schemas/magic-visibility_pcaps_response_simple'
                - $ref: '#/components/schemas/magic-visibility_pcaps_response_full'
    magic-visibility_pcaps_status:
      description: The status of the packet capture request.
      enum:
        - unknown
        - success
        - pending
        - running
        - conversion_pending
        - conversion_running
        - complete
        - failed
      example: success
      type: string
    magic-visibility_pcaps_submitted:
      description: The RFC 3339 timestamp when the packet capture was created.
      example: "2020-01-01T08:00:00Z"
      type: string
    magic-visibility_pcaps_system:
      description: The system used to collect packet captures.
      enum:
        - magic-transit
      example: magic-transit
      type: string
    magic-visibility_pcaps_time_limit:
      description: The packet capture duration in seconds.
      example: 300
      maximum: 300
      minimum: 1
      type: number
    magic-visibility_pcaps_type:
      description: The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.
      enum:
        - simple
        - full
      example: simple
      type: string
    magic-visibility_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    magic-visibility_rule_identifier:
      description: The id of the rule. Must be unique.
      example: 2890e6fa406311ed9b5a23f70f6fb8cf
      type: string
    magic_account_app:
      description: Custom app defined for an account.
      properties:
        account_app_id:
          $ref: '#/components/schemas/magic_account_app_id'
        hostnames:
          $ref: '#/components/schemas/magic_app_hostnames'
        ip_subnets:
          $ref: '#/components/schemas/magic_app_subnets'
        name:
          $ref: '#/components/schemas/magic_app_name'
        type:
          $ref: '#/components/schemas/magic_app_type'
      required:
        - account_app_id
      title: Account App
      type: object
    magic_account_app_id:
      description: Magic account app ID.
      example: ac60d3d0435248289d446cedd870bcf4
      type: string
    magic_acl:
      description: Bidirectional ACL policy for network traffic within a site.
      properties:
        description:
          description: Description for the ACL.
          example: Allows local traffic between PIN pads and cash register.
          type: string
        forward_locally:
          $ref: '#/components/schemas/magic_forward_locally'
        id:
          $ref: '#/components/schemas/magic_identifier'
        lan_1:
          $ref: '#/components/schemas/magic_lan-acl-configuration'
        lan_2:
          $ref: '#/components/schemas/magic_lan-acl-configuration'
        name:
          description: The name of the ACL.
          example: PIN Pad - Cash Register
          type: string
        protocols:
          items:
            description: Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.
            enum:
              - tcp
              - udp
              - icmp
            type: string
          type: array
      type: object
    magic_acl-subnet:
      oneOf:
        - $ref: '#/components/schemas/magic_ip-address'
        - $ref: '#/components/schemas/magic_cidr'
    magic_acl_deleted_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic_acl'
    magic_acl_modified_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic_acl'
    magic_acl_single_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic_acl'
    magic_acl_update_request:
      properties:
        description:
          description: Description for the ACL.
          example: Allows local traffic between PIN pads and cash register.
          type: string
        forward_locally:
          $ref: '#/components/schemas/magic_forward_locally'
        lan_1:
          $ref: '#/components/schemas/magic_lan-acl-configuration'
        lan_2:
          $ref: '#/components/schemas/magic_lan-acl-configuration'
        name:
          description: The name of the ACL.
          example: PIN Pad - Cash Register
          type: string
        protocols:
          items:
            description: Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.
            enum:
              - tcp
              - udp
              - icmp
            type: string
          type: array
      type: object
    magic_acls_add_single_request:
      description: Bidirectional ACL policy for local network traffic within a site.
      properties:
        description:
          description: Description for the ACL.
          example: Allows local traffic between PIN pads and cash register.
          type: string
        forward_locally:
          $ref: '#/components/schemas/magic_forward_locally'
        lan_1:
          $ref: '#/components/schemas/magic_lan-acl-configuration'
        lan_2:
          $ref: '#/components/schemas/magic_lan-acl-configuration'
        name:
          description: The name of the ACL.
          example: PIN Pad - Cash Register
          type: string
        protocols:
          items:
            description: Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.
            enum:
              - tcp
              - udp
              - icmp
            type: string
          type: array
      required:
        - name
        - lan_1
        - lan_2
      type: object
    magic_acls_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/magic_acl'
              type: array
    magic_allow_null_cipher:
      description: When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2).
      example: true
      type: boolean
    magic_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/magic_messages'
        messages:
          $ref: '#/components/schemas/magic_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    magic_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/magic_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/magic_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    magic_api-response-single:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-common'
        - properties:
            result:
              anyOf:
                - nullable: true
                  type: object
                - nullable: true
                  type: string
      type: object
    magic_app:
      description: Collection of Hostnames and/or IP Subnets to associate with traffic decisions.
      oneOf:
        - $ref: '#/components/schemas/magic_account_app'
        - $ref: '#/components/schemas/magic_managed_app'
      type: object
    magic_app_add_single_request:
      anyOf:
        - required:
            - hostnames
          title: Hostnames
        - required:
            - ip_subnets
          title: Subnets
      properties:
        hostnames:
          $ref: '#/components/schemas/magic_app_hostnames'
        ip_subnets:
          $ref: '#/components/schemas/magic_app_subnets'
        name:
          $ref: '#/components/schemas/magic_app_name'
        type:
          $ref: '#/components/schemas/magic_app_type'
      required:
        - name
        - type
      type: object
    magic_app_breakout:
      description: Whether to breakout traffic to the app's endpoints directly. Null preserves default behavior.
      example: true
      type: boolean
    magic_app_config:
      allOf:
        - properties:
            breakout:
              $ref: '#/components/schemas/magic_app_breakout'
            id:
              $ref: '#/components/schemas/magic_identifier'
            priority:
              $ref: '#/components/schemas/magic_app_priority'
            site_id:
              $ref: '#/components/schemas/magic_identifier'
          required:
            - id
            - site_id
        - oneOf:
            - properties:
                account_app_id:
                  $ref: '#/components/schemas/magic_account_app_id'
              required:
                - account_app_id
              title: Account App
            - properties:
                managed_app_id:
                  $ref: '#/components/schemas/magic_managed_app_id'
              required:
                - managed_app_id
              title: Managed App
      description: Traffic decision configuration for an app.
      type: object
    magic_app_config_add_single_request:
      allOf:
        - oneOf:
            - properties:
                account_app_id:
                  $ref: '#/components/schemas/magic_account_app_id'
              required:
                - account_app_id
              title: Account App
            - properties:
                managed_app_id:
                  $ref: '#/components/schemas/magic_managed_app_id'
              required:
                - managed_app_id
              title: Managed App
        - anyOf:
            - required:
                - breakout
              title: Breakout
            - required:
                - priority
              title: Prioritize
        - properties:
            breakout:
              $ref: '#/components/schemas/magic_app_breakout'
            priority:
              $ref: '#/components/schemas/magic_app_priority'
      type: object
    magic_app_config_single_response:
      allOf:
        - $ref: '#/components/schemas/magic_apps-response-object'
        - properties:
            result:
              $ref: '#/components/schemas/magic_app_config'
    magic_app_config_update_request:
      properties:
        account_app_id:
          $ref: '#/components/schemas/magic_account_app_id'
        breakout:
          $ref: '#/components/schemas/magic_app_breakout'
        managed_app_id:
          $ref: '#/components/schemas/magic_managed_app_id'
        priority:
          $ref: '#/components/schemas/magic_app_priority'
      type: object
    magic_app_configs_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_apps-response-object'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/magic_app_config'
              type: array
    magic_app_hostnames:
      description: FQDNs to associate with traffic decisions.
      items:
        example: auth.cloudflare.com
        type: string
      type: array
    magic_app_name:
      description: Display name for the app.
      example: Cloudflare Dashboard
      type: string
    magic_app_priority:
      description: Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)
      maximum: 1
      minimum: 0
      type: integer
    magic_app_single_response:
      allOf:
        - $ref: '#/components/schemas/magic_apps-response-object'
        - properties:
            result:
              $ref: '#/components/schemas/magic_account_app'
    magic_app_subnets:
      description: CIDRs to associate with traffic decisions.
      items:
        allOf:
          - $ref: '#/components/schemas/magic_cidr'
          - example: 1.1.1.1/32
      type: array
    magic_app_type:
      description: Category of the app.
      example: Development
      type: string
    magic_app_update_request:
      anyOf:
        - required:
            - name
          title: Update App Name
        - required:
            - type
          title: Update App Type
        - required:
            - hostnames
          title: Update App Hostnames
        - required:
            - ip_subnets
          title: Update App Subnets
      properties:
        hostnames:
          $ref: '#/components/schemas/magic_app_hostnames'
        ip_subnets:
          $ref: '#/components/schemas/magic_app_subnets'
        name:
          $ref: '#/components/schemas/magic_app_name'
        type:
          $ref: '#/components/schemas/magic_app_type'
      type: object
    magic_apps-response-array:
      properties:
        errors:
          $ref: '#/components/schemas/magic_messages'
        messages:
          $ref: '#/components/schemas/magic_messages'
        result:
          items: {}
          nullable: true
          type: array
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    magic_apps-response-object:
      properties:
        errors:
          $ref: '#/components/schemas/magic_messages'
        messages:
          $ref: '#/components/schemas/magic_messages'
        result:
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    magic_apps_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_apps-response-array'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/magic_app'
              type: array
    magic_cidr:
      description: A valid CIDR notation representing an IP range.
      example: 192.0.2.0/24
      type: string
    magic_cloudflare_gre_endpoint:
      description: The IP address assigned to the Cloudflare side of the GRE tunnel.
      example: 203.0.113.1
      type: string
    magic_cloudflare_ipsec_endpoint:
      description: The IP address assigned to the Cloudflare side of the IPsec tunnel.
      example: 203.0.113.1
      type: string
    magic_colo_name:
      description: Scope colo name.
      example: den01
      type: string
    magic_colo_names:
      description: List of colo names for the ECMP scope.
      items:
        $ref: '#/components/schemas/magic_colo_name'
      type: array
    magic_colo_region:
      description: Scope colo region.
      example: APAC
      type: string
    magic_colo_regions:
      description: List of colo regions for the ECMP scope.
      items:
        $ref: '#/components/schemas/magic_colo_region'
      type: array
    magic_components-schemas-description:
      description: An optional description forthe IPsec tunnel.
      example: Tunnel for ISP X
      type: string
    magic_components-schemas-modified_tunnels_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                modified:
                  example: true
                  type: boolean
                modified_interconnects:
                  items:
                    $ref: '#/components/schemas/magic_interconnect'
                  type: array
    magic_components-schemas-name:
      description: The name of the interconnect. The name cannot share a name with other tunnels.
      example: pni_ord
      type: string
    magic_components-schemas-tunnel_modified_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                modified:
                  example: true
                  type: boolean
                modified_interconnect:
                  $ref: '#/components/schemas/magic_interconnect'
              type: object
    magic_components-schemas-tunnel_single_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                interconnect:
                  $ref: '#/components/schemas/magic_interconnect'
              type: object
    magic_components-schemas-tunnel_update_request:
      properties:
        description:
          $ref: '#/components/schemas/magic_interconnect_components-schemas-description'
        gre:
          $ref: '#/components/schemas/magic_gre'
        health_check:
          $ref: '#/components/schemas/magic_schemas-health_check'
        interface_address:
          $ref: '#/components/schemas/magic_interface_address'
        mtu:
          $ref: '#/components/schemas/magic_schemas-mtu'
      type: object
    magic_components-schemas-tunnels_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                interconnects:
                  items:
                    $ref: '#/components/schemas/magic_interconnect'
                  type: array
    magic_connector-id:
      description: Magic Connector identifier tag.
      example: ac60d3d0435248289d446cedd870bcf4
      type: string
    magic_created_on:
      description: When the route was created.
      example: "2017-06-14T00:00:00Z"
      format: date-time
      readOnly: true
      type: string
    magic_customer_gre_endpoint:
      description: The IP address assigned to the customer side of the GRE tunnel.
      example: 203.0.113.1
      type: string
    magic_customer_ipsec_endpoint:
      description: The IP address assigned to the customer side of the IPsec tunnel. Not required, but must be set for proactive traceroutes to work.
      example: 203.0.113.1
      type: string
    magic_description:
      description: An optional human provided description of the static route.
      example: New route for new prefix 203.0.113.1
      type: string
    magic_forward_locally:
      description: The desired forwarding action for this ACL policy. If set to "false", the policy will forward traffic to Cloudflare. If set to "true", the policy will forward traffic locally on the Magic Connector. If not included in request, will default to false.
      type: boolean
    magic_gre:
      description: The configuration specific to GRE interconnects.
      properties:
        cloudflare_endpoint:
          description: The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect.
          example: 203.0.113.1
          type: string
      type: object
    magic_gre-tunnel:
      properties:
        cloudflare_gre_endpoint:
          $ref: '#/components/schemas/magic_cloudflare_gre_endpoint'
        created_on:
          $ref: '#/components/schemas/magic_schemas-created_on'
        customer_gre_endpoint:
          $ref: '#/components/schemas/magic_customer_gre_endpoint'
        description:
          $ref: '#/components/schemas/magic_schemas-description'
        health_check:
          $ref: '#/components/schemas/magic_health_check'
        id:
          $ref: '#/components/schemas/magic_schemas-identifier'
        interface_address:
          $ref: '#/components/schemas/magic_interface_address'
        modified_on:
          $ref: '#/components/schemas/magic_schemas-modified_on'
        mtu:
          $ref: '#/components/schemas/magic_mtu'
        name:
          $ref: '#/components/schemas/magic_name'
        ttl:
          $ref: '#/components/schemas/magic_ttl'
      required:
        - name
        - customer_gre_endpoint
        - cloudflare_gre_endpoint
        - interface_address
      type: object
    magic_health_check:
      properties:
        direction:
          default: unidirectional
          description: The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel. Note in the case of bidirecitonal healthchecks, the target field in health_check is ignored as the interface_address is used to send traffic into the tunnel.
          enum:
            - unidirectional
            - bidirectional
          example: bidirectional
          type: string
        enabled:
          default: true
          description: Determines whether to run healthchecks for a tunnel.
          example: true
          type: boolean
        rate:
          default: mid
          description: How frequent the health check is run. The default value is `mid`.
          enum:
            - low
            - mid
            - high
          example: low
          type: string
        target:
          description: The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
          example: 203.0.113.1
          type: string
        type:
          default: reply
          description: The type of healthcheck to run, reply or request. The default value is `reply`.
          enum:
            - reply
            - request
          example: request
          type: string
      type: object
    magic_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    magic_interconnect:
      properties:
        colo_name:
          $ref: '#/components/schemas/magic_components-schemas-name'
        created_on:
          $ref: '#/components/schemas/magic_schemas-created_on'
        description:
          $ref: '#/components/schemas/magic_interconnect_components-schemas-description'
        gre:
          $ref: '#/components/schemas/magic_gre'
        health_check:
          $ref: '#/components/schemas/magic_schemas-health_check'
        id:
          $ref: '#/components/schemas/magic_schemas-identifier'
        interface_address:
          $ref: '#/components/schemas/magic_interface_address'
        modified_on:
          $ref: '#/components/schemas/magic_schemas-modified_on'
        mtu:
          $ref: '#/components/schemas/magic_schemas-mtu'
        name:
          $ref: '#/components/schemas/magic_components-schemas-name'
      type: object
    magic_interconnect_components-schemas-description:
      description: An optional description of the interconnect.
      example: Tunnel for Interconnect to ORD
      type: string
    magic_interface_address:
      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
      type: string
    magic_ip-address:
      description: A valid IPv4 address.
      example: 192.0.2.1
      type: string
    magic_ipsec-tunnel:
      properties:
        allow_null_cipher:
          $ref: '#/components/schemas/magic_allow_null_cipher'
        cloudflare_endpoint:
          $ref: '#/components/schemas/magic_cloudflare_ipsec_endpoint'
        created_on:
          $ref: '#/components/schemas/magic_schemas-created_on'
        customer_endpoint:
          $ref: '#/components/schemas/magic_customer_ipsec_endpoint'
        description:
          $ref: '#/components/schemas/magic_components-schemas-description'
        id:
          $ref: '#/components/schemas/magic_schemas-identifier'
        interface_address:
          $ref: '#/components/schemas/magic_interface_address'
        modified_on:
          $ref: '#/components/schemas/magic_schemas-modified_on'
        name:
          $ref: '#/components/schemas/magic_schemas-name'
        psk_metadata:
          $ref: '#/components/schemas/magic_psk_metadata'
        replay_protection:
          $ref: '#/components/schemas/magic_replay_protection'
        tunnel_health_check:
          $ref: '#/components/schemas/magic_tunnel_health_check'
      required:
        - name
        - cloudflare_endpoint
        - interface_address
      type: object
    magic_lan:
      properties:
        ha_link:
          description: mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha_link.
          type: boolean
        id:
          $ref: '#/components/schemas/magic_identifier'
        name:
          type: string
        nat:
          $ref: '#/components/schemas/magic_nat'
        physport:
          $ref: '#/components/schemas/magic_port'
        routed_subnets:
          items:
            $ref: '#/components/schemas/magic_routed_subnet'
          type: array
        site_id:
          $ref: '#/components/schemas/magic_identifier'
        static_addressing:
          $ref: '#/components/schemas/magic_lan_static_addressing'
        vlan_tag:
          $ref: '#/components/schemas/magic_vlan_tag'
      type: object
    magic_lan-acl-configuration:
      properties:
        lan_id:
          description: The identifier for the LAN you want to create an ACL policy with.
          type: string
        lan_name:
          description: The name of the LAN based on the provided lan_id.
          type: string
        ports:
          description: Array of ports on the provided LAN that will be included in the ACL. If no ports are provided, communication on any port on this LAN is allowed.
          items:
            $ref: '#/components/schemas/magic_port'
          type: array
        subnets:
          description: Array of subnet IPs within the LAN that will be included in the ACL. If no subnets are provided, communication on any subnets on this LAN are allowed.
          items:
            $ref: '#/components/schemas/magic_acl-subnet'
          type: array
      required:
        - lan_id
      type: object
    magic_lan_deleted_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic_lan'
    magic_lan_dhcp_relay:
      properties:
        server_addresses:
          description: List of DHCP server IPs.
          items:
            $ref: '#/components/schemas/magic_ip-address'
          type: array
      type: object
    magic_lan_dhcp_server:
      properties:
        dhcp_pool_end:
          $ref: '#/components/schemas/magic_ip-address'
        dhcp_pool_start:
          $ref: '#/components/schemas/magic_ip-address'
        dns_server:
          $ref: '#/components/schemas/magic_ip-address'
        reservations:
          additionalProperties:
            description: IP address associated with the MAC address
            type: string
          description: Mapping of MAC addresses to IP addresses
          example:
            "00:11:22:33:44:55": 192.0.2.100
            AA:BB:CC:DD:EE:FF: 192.168.1.101
          type: object
      type: object
    magic_lan_modified_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic_lan'
    magic_lan_single_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic_lan'
    magic_lan_static_addressing:
      description: If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static_address is required along with secondary and virtual address.
      properties:
        address:
          $ref: '#/components/schemas/magic_cidr'
        dhcp_relay:
          $ref: '#/components/schemas/magic_lan_dhcp_relay'
        dhcp_server:
          $ref: '#/components/schemas/magic_lan_dhcp_server'
        secondary_address:
          $ref: '#/components/schemas/magic_cidr'
        virtual_address:
          $ref: '#/components/schemas/magic_cidr'
      required:
        - address
      type: object
    magic_lan_update_request:
      properties:
        name:
          type: string
        nat:
          $ref: '#/components/schemas/magic_nat'
        physport:
          $ref: '#/components/schemas/magic_port'
        routed_subnets:
          items:
            $ref: '#/components/schemas/magic_routed_subnet'
          type: array
        static_addressing:
          $ref: '#/components/schemas/magic_lan_static_addressing'
        vlan_tag:
          $ref: '#/components/schemas/magic_vlan_tag'
      type: object
    magic_lans_add_single_request:
      properties:
        ha_link:
          description: mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha_link.
          type: boolean
        name:
          type: string
        nat:
          $ref: '#/components/schemas/magic_nat'
        physport:
          $ref: '#/components/schemas/magic_port'
        routed_subnets:
          items:
            $ref: '#/components/schemas/magic_routed_subnet'
          type: array
        static_addressing:
          $ref: '#/components/schemas/magic_lan_static_addressing'
        vlan_tag:
          $ref: '#/components/schemas/magic_vlan_tag'
      required:
        - physport
        - vlan_tag
      type: object
    magic_lans_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/magic_lan'
              type: array
    magic_managed_app:
      description: Managed app defined by Cloudflare.
      properties:
        hostnames:
          $ref: '#/components/schemas/magic_app_hostnames'
        ip_subnets:
          $ref: '#/components/schemas/magic_app_subnets'
        managed_app_id:
          $ref: '#/components/schemas/magic_managed_app_id'
        name:
          $ref: '#/components/schemas/magic_app_name'
        type:
          $ref: '#/components/schemas/magic_app_type'
      required:
        - managed_app_id
      title: Managed App
      type: object
    magic_managed_app_id:
      description: Managed app ID.
      example: cloudflare
      type: string
    magic_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    magic_modified_on:
      description: When the route was last modified.
      example: "2017-06-14T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    magic_modified_tunnels_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                modified:
                  example: true
                  type: boolean
                modified_gre_tunnels:
                  items:
                    $ref: '#/components/schemas/magic_gre-tunnel'
                  type: array
    magic_mtu:
      default: 1476
      description: Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576.
      type: integer
    magic_multiple_route_delete_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                deleted:
                  example: true
                  type: boolean
                deleted_routes:
                  items:
                    $ref: '#/components/schemas/magic_route'
                  type: array
    magic_multiple_route_modified_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                modified:
                  example: true
                  type: boolean
                modified_routes:
                  items:
                    $ref: '#/components/schemas/magic_route'
                  type: array
    magic_name:
      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
      type: string
    magic_nat:
      properties:
        static_prefix:
          $ref: '#/components/schemas/magic_cidr'
      type: object
    magic_nexthop:
      description: The next-hop IP Address for the static route.
      example: 203.0.113.1
      type: string
    magic_port:
      example: 1
      type: integer
    magic_prefix:
      description: IP Prefix in Classless Inter-Domain Routing format.
      example: 192.0.2.0/24
      type: string
    magic_priority:
      description: Priority of the static route.
      type: integer
    magic_psk:
      description: A randomly generated or provided string for use in the IPsec tunnel.
      example: O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy
      type: string
    magic_psk_generation_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                ipsec_tunnel_id:
                  $ref: '#/components/schemas/magic_identifier'
                psk:
                  $ref: '#/components/schemas/magic_psk'
                psk_metadata:
                  $ref: '#/components/schemas/magic_psk_metadata'
    magic_psk_metadata:
      description: The PSK metadata that includes when the PSK was generated.
      properties:
        last_generated_on:
          $ref: '#/components/schemas/magic_schemas-modified_on'
      type: object
    magic_replay_protection:
      default: false
      description: If `true`, then IPsec replay protection will be supported in the Cloudflare-to-customer direction.
      example: false
      type: boolean
    magic_route:
      properties:
        created_on:
          $ref: '#/components/schemas/magic_created_on'
        description:
          $ref: '#/components/schemas/magic_description'
        id:
          $ref: '#/components/schemas/magic_identifier'
        modified_on:
          $ref: '#/components/schemas/magic_modified_on'
        nexthop:
          $ref: '#/components/schemas/magic_nexthop'
        prefix:
          $ref: '#/components/schemas/magic_prefix'
        priority:
          $ref: '#/components/schemas/magic_priority'
        scope:
          $ref: '#/components/schemas/magic_scope'
        weight:
          $ref: '#/components/schemas/magic_weight'
      required:
        - prefix
        - nexthop
        - priority
      type: object
    magic_route_add_single_request:
      properties:
        description:
          $ref: '#/components/schemas/magic_description'
        nexthop:
          $ref: '#/components/schemas/magic_nexthop'
        prefix:
          $ref: '#/components/schemas/magic_prefix'
        priority:
          $ref: '#/components/schemas/magic_priority'
        scope:
          $ref: '#/components/schemas/magic_scope'
        weight:
          $ref: '#/components/schemas/magic_weight'
      required:
        - prefix
        - nexthop
        - priority
      type: object
    magic_route_delete_id:
      allOf:
        - properties:
            id:
              $ref: '#/components/schemas/magic_identifier'
          required:
            - id
    magic_route_delete_many_request:
      properties:
        routes:
          items:
            $ref: '#/components/schemas/magic_route_delete_id'
          type: array
      required:
        - routes
      type: object
    magic_route_deleted_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                deleted:
                  example: true
                  type: boolean
                deleted_route:
                  $ref: '#/components/schemas/magic_route'
              type: object
    magic_route_modified_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                modified:
                  example: true
                  type: boolean
                modified_route:
                  $ref: '#/components/schemas/magic_route'
              type: object
    magic_route_single_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                route:
                  $ref: '#/components/schemas/magic_route'
              type: object
    magic_route_update_many_request:
      properties:
        routes:
          items:
            $ref: '#/components/schemas/magic_route_update_single_request'
          type: array
      required:
        - routes
      type: object
    magic_route_update_request:
      allOf:
        - $ref: '#/components/schemas/magic_route_add_single_request'
    magic_route_update_single_request:
      allOf:
        - properties:
            id:
              $ref: '#/components/schemas/magic_identifier'
          required:
            - id
        - $ref: '#/components/schemas/magic_route_add_single_request'
    magic_routed_subnet:
      properties:
        nat:
          $ref: '#/components/schemas/magic_nat'
        next_hop:
          $ref: '#/components/schemas/magic_ip-address'
        prefix:
          $ref: '#/components/schemas/magic_cidr'
      required:
        - prefix
        - next_hop
      type: object
    magic_routes_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                routes:
                  items:
                    $ref: '#/components/schemas/magic_route'
                  type: array
    magic_schemas-created_on:
      description: The date and time the tunnel was created.
      example: "2017-06-14T00:00:00Z"
      format: date-time
      readOnly: true
      type: string
    magic_schemas-description:
      description: An optional description of the GRE tunnel.
      example: Tunnel for ISP X
      type: string
    magic_schemas-health_check:
      properties:
        enabled:
          default: true
          description: Determines whether to run healthchecks for a tunnel.
          example: true
          type: boolean
        rate:
          default: mid
          description: How frequent the health check is run. The default value is `mid`.
          enum:
            - low
            - mid
            - high
          example: low
          type: string
        target:
          description: The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`.
          example: 203.0.113.1
          type: string
        type:
          default: reply
          description: The type of healthcheck to run, reply or request. The default value is `reply`.
          enum:
            - reply
            - request
          example: request
          type: string
      type: object
    magic_schemas-identifier:
      description: Tunnel identifier tag.
      example: c4a7362d577a6c3019a474fd6f485821
      maxLength: 32
      readOnly: true
      type: string
    magic_schemas-modified_on:
      description: The date and time the tunnel was last modified.
      example: "2017-06-14T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    magic_schemas-modified_tunnels_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                modified:
                  example: true
                  type: boolean
                modified_ipsec_tunnels:
                  items:
                    $ref: '#/components/schemas/magic_ipsec-tunnel'
                  type: array
    magic_schemas-mtu:
      default: 1476
      description: The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.
      type: integer
    magic_schemas-name:
      description: The name of the IPsec tunnel. The name cannot share a name with other tunnels.
      example: IPsec_1
      type: string
    magic_schemas-tunnel_add_request:
      allOf:
        - $ref: '#/components/schemas/magic_schemas-tunnel_add_single_request'
    magic_schemas-tunnel_add_single_request:
      properties:
        cloudflare_endpoint:
          $ref: '#/components/schemas/magic_cloudflare_ipsec_endpoint'
        customer_endpoint:
          $ref: '#/components/schemas/magic_customer_ipsec_endpoint'
        description:
          $ref: '#/components/schemas/magic_components-schemas-description'
        health_check:
          $ref: '#/components/schemas/magic_health_check'
        interface_address:
          $ref: '#/components/schemas/magic_interface_address'
        name:
          $ref: '#/components/schemas/magic_schemas-name'
        psk:
          $ref: '#/components/schemas/magic_psk'
        replay_protection:
          $ref: '#/components/schemas/magic_replay_protection'
      required:
        - name
        - cloudflare_endpoint
        - interface_address
      type: object
    magic_schemas-tunnel_deleted_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                deleted:
                  example: true
                  type: boolean
                deleted_ipsec_tunnel:
                  $ref: '#/components/schemas/magic_ipsec-tunnel'
              type: object
    magic_schemas-tunnel_modified_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                modified:
                  example: true
                  type: boolean
                modified_ipsec_tunnel:
                  $ref: '#/components/schemas/magic_ipsec-tunnel'
              type: object
    magic_schemas-tunnel_single_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                ipsec_tunnel:
                  $ref: '#/components/schemas/magic_ipsec-tunnel'
              type: object
    magic_schemas-tunnel_update_request:
      allOf:
        - $ref: '#/components/schemas/magic_schemas-tunnel_add_single_request'
    magic_schemas-tunnels_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                ipsec_tunnels:
                  items:
                    $ref: '#/components/schemas/magic_ipsec-tunnel'
                  type: array
    magic_scope:
      description: Used only for ECMP routes.
      properties:
        colo_names:
          $ref: '#/components/schemas/magic_colo_names'
        colo_regions:
          $ref: '#/components/schemas/magic_colo_regions'
      type: object
    magic_secondary-connector-id:
      description: Magic Connector identifier tag. Used when high availability mode is on.
      example: 8d67040d3835dbcf46ce29da440dc482
      type: string
    magic_site:
      properties:
        connector_id:
          $ref: '#/components/schemas/magic_connector-id'
        description:
          type: string
        ha_mode:
          description: Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode.
          example: true
          type: boolean
        id:
          $ref: '#/components/schemas/magic_identifier'
        location:
          $ref: '#/components/schemas/magic_site-location'
        name:
          $ref: '#/components/schemas/magic_site-name'
        secondary_connector_id:
          $ref: '#/components/schemas/magic_secondary-connector-id'
      type: object
    magic_site-location:
      description: Location of site in latitude and longitude.
      properties:
        lat:
          description: Latitude
          example: 37.6192
          type: string
        lon:
          description: Longitude
          example: 122.3816
          type: string
      type: object
    magic_site-name:
      description: The name of the site.
      example: site_1
      type: string
    magic_site_deleted_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic_site'
    magic_site_modified_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic_site'
    magic_site_single_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic_site'
    magic_site_update_request:
      properties:
        connector_id:
          $ref: '#/components/schemas/magic_connector-id'
        description:
          type: string
        location:
          $ref: '#/components/schemas/magic_site-location'
        name:
          $ref: '#/components/schemas/magic_site-name'
        secondary_connector_id:
          $ref: '#/components/schemas/magic_secondary-connector-id'
      type: object
    magic_sites_add_single_request:
      properties:
        connector_id:
          $ref: '#/components/schemas/magic_connector-id'
        description:
          type: string
        ha_mode:
          description: Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode.
          example: true
          type: boolean
        location:
          $ref: '#/components/schemas/magic_site-location'
        name:
          $ref: '#/components/schemas/magic_site-name'
        secondary_connector_id:
          $ref: '#/components/schemas/magic_secondary-connector-id'
      required:
        - name
      type: object
    magic_sites_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/magic_site'
              type: array
    magic_ttl:
      default: 64
      description: Time To Live (TTL) in number of hops of the GRE tunnel.
      type: integer
    magic_tunnel_add_single_request:
      properties:
        cloudflare_gre_endpoint:
          $ref: '#/components/schemas/magic_cloudflare_gre_endpoint'
        customer_gre_endpoint:
          $ref: '#/components/schemas/magic_customer_gre_endpoint'
        description:
          $ref: '#/components/schemas/magic_schemas-description'
        health_check:
          $ref: '#/components/schemas/magic_health_check'
        interface_address:
          $ref: '#/components/schemas/magic_interface_address'
        mtu:
          $ref: '#/components/schemas/magic_mtu'
        name:
          $ref: '#/components/schemas/magic_name'
        ttl:
          $ref: '#/components/schemas/magic_ttl'
      required:
        - name
        - customer_gre_endpoint
        - cloudflare_gre_endpoint
        - interface_address
      type: object
    magic_tunnel_deleted_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                deleted:
                  example: true
                  type: boolean
                deleted_gre_tunnel:
                  $ref: '#/components/schemas/magic_gre-tunnel'
              type: object
    magic_tunnel_health_check:
      properties:
        enabled:
          default: true
          description: Determines whether to run healthchecks for a tunnel.
          example: true
          type: boolean
        rate:
          default: mid
          description: How frequent the health check is run. The default value is `mid`.
          enum:
            - low
            - mid
            - high
          example: low
          type: string
        target:
          description: The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`.
          example: 203.0.113.1
          type: string
        type:
          default: reply
          description: The type of healthcheck to run, reply or request. The default value is `reply`.
          enum:
            - reply
            - request
          example: request
          type: string
      type: object
    magic_tunnel_modified_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                modified:
                  example: true
                  type: boolean
                modified_gre_tunnel:
                  $ref: '#/components/schemas/magic_gre-tunnel'
              type: object
    magic_tunnel_single_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                gre_tunnel:
                  $ref: '#/components/schemas/magic_gre-tunnel'
              type: object
    magic_tunnel_update_request:
      allOf:
        - $ref: '#/components/schemas/magic_tunnel_add_single_request'
    magic_tunnels_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              properties:
                gre_tunnels:
                  items:
                    $ref: '#/components/schemas/magic_gre-tunnel'
                  type: array
    magic_vlan_tag:
      description: VLAN port number.
      example: 0
      type: integer
    magic_wan:
      properties:
        id:
          $ref: '#/components/schemas/magic_identifier'
        name:
          type: string
        physport:
          $ref: '#/components/schemas/magic_port'
        priority:
          description: Priority of WAN for traffic loadbalancing.
          type: integer
        site_id:
          $ref: '#/components/schemas/magic_identifier'
        static_addressing:
          $ref: '#/components/schemas/magic_wan_static_addressing'
        vlan_tag:
          $ref: '#/components/schemas/magic_vlan_tag'
      type: object
    magic_wan_deleted_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic_wan'
    magic_wan_modified_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic_wan'
    magic_wan_single_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/magic_wan'
    magic_wan_static_addressing:
      description: (optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode.
      properties:
        address:
          $ref: '#/components/schemas/magic_cidr'
        gateway_address:
          $ref: '#/components/schemas/magic_ip-address'
        secondary_address:
          $ref: '#/components/schemas/magic_cidr'
      required:
        - address
        - gateway_address
      type: object
    magic_wan_update_request:
      properties:
        name:
          type: string
        physport:
          $ref: '#/components/schemas/magic_port'
        priority:
          type: integer
        static_addressing:
          $ref: '#/components/schemas/magic_wan_static_addressing'
        vlan_tag:
          $ref: '#/components/schemas/magic_vlan_tag'
      type: object
    magic_wans_add_single_request:
      properties:
        name:
          type: string
        physport:
          $ref: '#/components/schemas/magic_port'
        priority:
          type: integer
        static_addressing:
          $ref: '#/components/schemas/magic_wan_static_addressing'
        vlan_tag:
          $ref: '#/components/schemas/magic_vlan_tag'
      required:
        - physport
        - vlan_tag
      type: object
    magic_wans_collection_response:
      allOf:
        - $ref: '#/components/schemas/magic_api-response-single'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/magic_wan'
              type: array
    magic_weight:
      description: Optional weight of the ECMP scope - if provided.
      type: integer
    mconn_account_id:
      description: Account identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    mconn_admin_connector:
      properties:
        account_id:
          $ref: '#/components/schemas/mconn_account_id'
        activated:
          type: boolean
        cohort:
          type: string
        desired_version:
          type: string
        device_id:
          $ref: '#/components/schemas/mconn_uuid'
        id:
          $ref: '#/components/schemas/mconn_uuid'
        interrupt_window_duration_hours:
          type: number
        interrupt_window_hour_of_day:
          type: number
        last_heartbeat:
          type: string
        last_seen_version:
          type: string
        last_updated:
          type: string
        notes:
          type: string
        pinned_version:
          type: string
        timezone:
          type: string
        upgrade_asap:
          type: boolean
        upgrade_attempts:
          type: number
      required:
        - id
        - account_id
        - notes
        - activated
        - last_updated
        - timezone
        - interrupt_window_hour_of_day
        - interrupt_window_duration_hours
        - upgrade_asap
        - upgrade_attempts
      type: object
    mconn_admin_connector_create_request:
      $ref: '#/components/schemas/mconn_admin_connector_fields'
    mconn_admin_connector_create_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_connector'
    mconn_admin_connector_delete_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_connector'
    mconn_admin_connector_fetch_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_connector'
    mconn_admin_connector_fields:
      properties:
        account_id:
          type: number
        activated:
          type: boolean
        cohort:
          type: string
        desired_version:
          type: string
        device_id:
          type: string
        interrupt_window_duration_hours:
          type: number
        interrupt_window_hour_of_day:
          type: number
        last_heartbeat:
          type: string
        last_seen_version:
          type: string
        last_updated:
          type: string
        notes:
          type: string
        pinned_version:
          type: string
        timezone:
          type: string
        upgrade_asap:
          type: boolean
        upgrade_attempts:
          type: number
      type: object
    mconn_admin_connector_list_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/mconn_admin_connector'
              type: array
    mconn_admin_connector_replace_request:
      $ref: '#/components/schemas/mconn_admin_connector_fields'
    mconn_admin_connector_replace_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_connector'
    mconn_admin_connector_update_request:
      $ref: '#/components/schemas/mconn_admin_connector_fields'
    mconn_admin_connector_update_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_connector'
    mconn_admin_device:
      properties:
        crypt_key:
          type: string
        crypt_key_rotation_finished_at:
          type: string
        crypt_key_rotation_output:
          type: string
        crypt_key_rotation_started_at:
          type: string
        crypt_key_rotation_status_code:
          type: number
        ek_cert:
          type: string
        id:
          $ref: '#/components/schemas/mconn_uuid'
        imaged_at:
          type: string
        last_crypt_key:
          type: string
        last_updated:
          type: string
        license_key_sha256:
          type: string
        metadata:
          type: string
        serial_number:
          type: string
      required:
        - id
        - metadata
        - crypt_key
        - last_updated
      type: object
    mconn_admin_device_create_request:
      $ref: '#/components/schemas/mconn_admin_device_fields'
    mconn_admin_device_create_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_device'
    mconn_admin_device_delete_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_device'
    mconn_admin_device_fetch_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_device'
    mconn_admin_device_fields:
      properties:
        crypt_key:
          type: string
        crypt_key_rotation_finished_at:
          type: string
        crypt_key_rotation_output:
          type: string
        crypt_key_rotation_started_at:
          type: string
        crypt_key_rotation_status_code:
          type: number
        ek_cert:
          type: string
        imaged_at:
          type: string
        last_crypt_key:
          type: string
        last_updated:
          type: string
        license_key_sha256:
          type: string
        metadata:
          type: string
        serial_number:
          type: string
      type: object
    mconn_admin_device_list_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/mconn_admin_device'
              type: array
    mconn_admin_device_replace_request:
      $ref: '#/components/schemas/mconn_admin_device_fields'
    mconn_admin_device_replace_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_device'
    mconn_admin_device_update_request:
      $ref: '#/components/schemas/mconn_admin_device_fields'
    mconn_admin_device_update_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_device'
    mconn_admin_flare:
      properties:
        id:
          $ref: '#/components/schemas/mconn_uuid'
        triggered_at:
          type: string
      required:
        - id
        - triggered_at
      type: object
    mconn_admin_flare_replace_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_flare'
    mconn_admin_macros_diagnose_connector_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_macros_diagnose_connector_result'
    mconn_admin_macros_diagnose_connector_result:
      properties:
        connector:
          $ref: '#/components/schemas/mconn_admin_connector'
        device:
          $ref: '#/components/schemas/mconn_admin_device'
        site:
          $ref: '#/components/schemas/mconn_admin_site'
      type: object
    mconn_admin_macros_provision_licensed_connector_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_macros_provision_licensed_connector_result'
    mconn_admin_macros_provision_licensed_connector_result:
      properties:
        connector:
          $ref: '#/components/schemas/mconn_admin_connector'
        device:
          $ref: '#/components/schemas/mconn_admin_device'
        license_key:
          type: string
      required:
        - license_key
        - device
        - connector
      type: object
    mconn_admin_macros_provision_physical_connector_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_macros_provision_physical_connector_result'
    mconn_admin_macros_provision_physical_connector_result:
      properties:
        connector:
          $ref: '#/components/schemas/mconn_admin_connector'
      required:
        - connector
      type: object
    mconn_admin_site:
      properties:
        id:
          $ref: '#/components/schemas/mconn_uuid'
      required:
        - id
      type: object
    mconn_admin_upgrade_slot:
      properties:
        connector_id:
          $ref: '#/components/schemas/mconn_uuid'
        id:
          type: number
        started_at:
          type: string
      required:
        - id
      type: object
    mconn_admin_upgrade_slots_fetch_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/mconn_admin_upgrade_slot'
              type: array
    mconn_admin_upgrade_slots_replace_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/mconn_admin_upgrade_slot'
              type: array
    mconn_bad_response:
      allOf:
        - $ref: '#/components/schemas/mconn_response'
        - properties:
            errors:
              items:
                $ref: '#/components/schemas/mconn_coded_message'
              minLength: 1
              type: array
            result:
              $ref: '#/components/schemas/mconn_none'
    mconn_coded_message:
      properties:
        code:
          minimum: 1000
          type: integer
        message:
          type: string
      required:
        - code
        - message
      type: object
    mconn_conduit_connector:
      properties:
        account_id:
          $ref: '#/components/schemas/mconn_account_id'
      required:
        - account_id
      type: object
    mconn_conduit_fetch_connector_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_conduit_fetch_connector_result'
    mconn_conduit_fetch_connector_result:
      $ref: '#/components/schemas/mconn_conduit_connector'
    mconn_controller_attestation_session:
      properties:
        ak_public:
          type: string
        connector:
          $ref: '#/components/schemas/mconn_controller_connector_identity'
        device:
          $ref: '#/components/schemas/mconn_controller_device_identity'
        nonce:
          type: string
      required:
        - ak_public
        - device
        - nonce
      type: object
    mconn_controller_begin_attestation_session_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_begin_attestation_session_result'
    mconn_controller_begin_attestation_session_result:
      $ref: '#/components/schemas/mconn_controller_attestation_session'
    mconn_controller_connector:
      properties:
        account_id:
          $ref: '#/components/schemas/mconn_account_id'
        activated:
          type: boolean
        desired_version:
          type: string
        id:
          $ref: '#/components/schemas/mconn_uuid'
        interrupt_window_duration_hours:
          type: number
        interrupt_window_hour_of_day:
          type: number
        last_heartbeat:
          type: string
        last_seen_version:
          type: string
        pinned_version:
          type: string
        timezone:
          type: string
        upgrade_asap:
          type: boolean
        upgrade_attempts:
          type: number
      required:
        - id
        - account_id
        - activated
        - timezone
        - interrupt_window_hour_of_day
        - interrupt_window_duration_hours
        - upgrade_asap
        - upgrade_attempts
      type: object
    mconn_controller_connector_identity:
      properties:
        account_id:
          $ref: '#/components/schemas/mconn_account_id'
        activated:
          type: boolean
        id:
          $ref: '#/components/schemas/mconn_uuid'
      required:
        - id
        - account_id
        - activated
      type: object
    mconn_controller_device:
      properties:
        crypt_key:
          type: string
        id:
          $ref: '#/components/schemas/mconn_uuid'
        imaged_at:
          type: string
        last_crypt_key:
          type: string
        license_key_sha256:
          type: string
        serial_number:
          type: string
      required:
        - id
        - crypt_key
      type: object
    mconn_controller_device_identity:
      properties:
        id:
          $ref: '#/components/schemas/mconn_uuid'
        imaged_at:
          type: string
        serial_number:
          type: string
      required:
        - id
      type: object
    mconn_controller_end_attestation_session_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_end_attestation_session_result'
    mconn_controller_end_attestation_session_result:
      $ref: '#/components/schemas/mconn_controller_attestation_session'
    mconn_controller_fetch_cloudflared_token_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_fetch_cloudflared_token_result'
    mconn_controller_fetch_cloudflared_token_result:
      type: string
    mconn_controller_fetch_connector_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_fetch_connector_result'
    mconn_controller_fetch_connector_result:
      $ref: '#/components/schemas/mconn_controller_connector'
    mconn_controller_fetch_device_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_fetch_device_result'
    mconn_controller_fetch_device_result:
      $ref: '#/components/schemas/mconn_controller_device'
    mconn_controller_fetch_flare_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_fetch_flare_result'
    mconn_controller_fetch_flare_result:
      $ref: '#/components/schemas/mconn_controller_flare'
    mconn_controller_fetch_upgrade_slots_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/mconn_controller_upgrade_slot'
              type: array
    mconn_controller_flare:
      properties:
        triggered_at:
          type: string
      required:
        - triggered_at
      type: object
    mconn_controller_identify_ek_cert_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_identify_ek_cert_result'
    mconn_controller_identify_ek_cert_result:
      properties:
        connector:
          $ref: '#/components/schemas/mconn_controller_connector_identity'
        device:
          $ref: '#/components/schemas/mconn_controller_device_identity'
      type: object
    mconn_controller_identify_license_key_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_identify_license_key_result'
    mconn_controller_identify_license_key_result:
      properties:
        connector:
          $ref: '#/components/schemas/mconn_controller_connector_identity'
        device:
          $ref: '#/components/schemas/mconn_controller_device_identity'
      type: object
    mconn_controller_update_connector_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_update_connector_result'
    mconn_controller_update_connector_result:
      type: object
    mconn_controller_update_device_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_update_device_result'
    mconn_controller_update_device_result:
      type: object
    mconn_controller_upgrade_slot:
      properties:
        connector_id:
          $ref: '#/components/schemas/mconn_uuid'
        id:
          type: number
        started_at:
          type: string
      required:
        - id
      type: object
    mconn_create_attestation_session_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_attestation_session'
    mconn_create_connector_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_admin_connector'
    mconn_customer_connector:
      properties:
        activated:
          type: boolean
        device:
          $ref: '#/components/schemas/mconn_customer_device'
        id:
          $ref: '#/components/schemas/mconn_uuid'
        interrupt_window_duration_hours:
          type: number
        interrupt_window_hour_of_day:
          type: number
        last_heartbeat:
          type: string
        last_seen_version:
          type: string
        last_updated:
          type: string
        notes:
          type: string
        timezone:
          type: string
      required:
        - id
        - notes
        - activated
        - last_updated
        - timezone
        - interrupt_window_hour_of_day
        - interrupt_window_duration_hours
      type: object
    mconn_customer_connector_fetch_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_customer_connector'
    mconn_customer_connector_fields:
      properties:
        activated:
          type: boolean
        interrupt_window_duration_hours:
          type: number
        interrupt_window_hour_of_day:
          type: number
        notes:
          type: string
        timezone:
          type: string
      type: object
    mconn_customer_connector_list_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/mconn_customer_connector'
              type: array
    mconn_customer_connector_update_request:
      $ref: '#/components/schemas/mconn_customer_connector_fields'
    mconn_customer_connector_update_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_customer_connector'
    mconn_customer_device:
      properties:
        id:
          $ref: '#/components/schemas/mconn_uuid'
        serial_number:
          type: string
      required:
        - id
      type: object
    mconn_delete_attestation_session_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_attestation_session'
    mconn_delete_controller_flare_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_controller_flare'
    mconn_good_response:
      allOf:
        - $ref: '#/components/schemas/mconn_response'
        - properties:
            errors:
              items:
                $ref: '#/components/schemas/mconn_coded_message'
              maxLength: 0
              type: array
    mconn_heartbeat_response:
      $ref: '#/components/schemas/mconn_good_response'
    mconn_none:
      nullable: true
      type: object
    mconn_partner_device:
      properties:
        id:
          $ref: '#/components/schemas/mconn_uuid'
      required:
        - id
      type: object
    mconn_partner_device_register_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              $ref: '#/components/schemas/mconn_partner_device'
    mconn_read_controller_connector_token_response:
      allOf:
        - $ref: '#/components/schemas/mconn_good_response'
        - properties:
            result:
              type: string
    mconn_response:
      properties:
        messages:
          items:
            $ref: '#/components/schemas/mconn_coded_message'
          type: array
        success:
          type: boolean
      required:
        - result
        - success
        - errors
        - messages
      type: object
    mconn_uuid:
      type: string
    mq_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/mq_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/mq_result_info'
      type: object
    mq_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/mq_messages'
        messages:
          $ref: '#/components/schemas/mq_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful.
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    mq_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/mq_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/mq_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful.
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    mq_batch_size:
      description: The maximum number of messages to include in a batch.
      example: 50
      type: number
    mq_bucket-config:
      additionalProperties:
        $ref: '#/components/schemas/mq_config-detail'
      example:
        my-bucket:
          b588b5d5-0647-4e81-bb8c-800fad2239a0:
            queue: 98fa6c35-dead-beef-a42b-8d12196e0000
            rules:
              - actions:
                  - PutObject
                  - DeleteObject
                prefix: img/
                suffix: .jpg
          deadbeef-1234-4e81-5678-abadfeedbead:
            queue: 11111111-dead-beef-0000-109238eeffff
            rules:
              - actions:
                  - CopyObject
                suffix: .mov
      type: object
    mq_config-detail:
      additionalProperties:
        $ref: '#/components/schemas/mq_detail'
      type: object
    mq_consumer:
      properties:
        created_on:
          readOnly: true
          type: string
        environment:
          readOnly: true
          type: string
        queue_name:
          readOnly: true
          type: string
        service:
          readOnly: true
          type: string
        settings:
          properties:
            batch_size:
              $ref: '#/components/schemas/mq_batch_size'
            max_retries:
              $ref: '#/components/schemas/mq_max_retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/mq_max_wait_time_ms'
          type: object
      type: object
    mq_consumer_created:
      properties:
        created_on:
          readOnly: true
          type: string
        dead_letter_queue:
          $ref: '#/components/schemas/mq_dlq_name'
        environment:
          readOnly: true
          type: string
        queue_name:
          readOnly: true
          type: string
        script_name:
          readOnly: true
          type: string
        settings:
          properties:
            batch_size:
              $ref: '#/components/schemas/mq_batch_size'
            max_retries:
              $ref: '#/components/schemas/mq_max_retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/mq_max_wait_time_ms'
          type: object
      type: object
    mq_consumer_updated:
      properties:
        created_on:
          readOnly: true
          type: string
        dead_letter_queue:
          example: updated-example-dlq
        environment:
          readOnly: true
          type: string
        queue_name:
          readOnly: true
          type: string
        script_name:
          readOnly: true
          type: string
        settings:
          properties:
            batch_size:
              example: 100
              type: number
            max_retries:
              $ref: '#/components/schemas/mq_max_retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/mq_max_wait_time_ms'
          type: object
      type: object
    mq_detail:
      properties:
        queue:
          description: Queue ID that will receive notifications based on the configured rules
          example: 98fa6c35-dead-beef-a42b-8d12196e0000
          type: string
        rules:
          description: Array of rules to drive notifications
          items:
            $ref: '#/components/schemas/mq_rule'
          type: array
      required:
        - queue
        - rules
      type: object
    mq_dlq_name:
      description: The name of the dead letter queue.
      example: example-dlq
      type: string
    mq_identifier:
      description: Identifier.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    mq_lease_id:
      example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0
      readOnly: true
      type: string
    mq_max_retries:
      description: The maximum number of retries
      example: 3
      type: number
    mq_max_wait_time_ms:
      example: 5000
      type: number
    mq_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    mq_name:
      example: example-queue
      type: string
    mq_producer:
      properties:
        environment:
          readOnly: true
          type: string
        service:
          readOnly: true
          type: string
      type: object
    mq_queue:
      properties:
        consumers:
          items:
            $ref: '#/components/schemas/mq_consumer'
          readOnly: true
          type: array
        consumers_total_count:
          readOnly: true
          type: number
        created_on:
          readOnly: true
          type: string
        modified_on:
          readOnly: true
          type: string
        producers:
          items:
            $ref: '#/components/schemas/mq_producer'
          readOnly: true
          type: array
        producers_total_count:
          readOnly: true
          type: number
        queue_id:
          readOnly: true
          type: string
        queue_name:
          $ref: '#/components/schemas/mq_name'
      type: object
    mq_queue_created:
      properties:
        created_on:
          readOnly: true
          type: string
        modified_on:
          readOnly: true
          type: string
        queue_id:
          readOnly: true
          type: string
        queue_name:
          $ref: '#/components/schemas/mq_name'
      type: object
    mq_queue_message:
      properties:
        attempts:
          example: 1
          readOnly: true
          type: number
        body:
          example: hello world
          readOnly: true
          type: string
        id:
          example: b01b5594f784d0165c2985833f5660dd
          readOnly: true
          type: string
        lease_id:
          $ref: '#/components/schemas/mq_lease_id'
        metadata:
          example:
            CF-Content-Type: text
            CF-sourceMessageSource: dash
          readOnly: true
          type: object
        timestamp_ms:
          example: 1.710950954154e+12
          readOnly: true
          type: number
      type: object
    mq_queue_updated:
      properties:
        created_on:
          readOnly: true
          type: string
        modified_on:
          readOnly: true
          type: string
        queue_id:
          readOnly: true
          type: string
        queue_name:
          $ref: '#/components/schemas/mq_renamed_name'
      type: object
    mq_r2-action:
      enum:
        - PutObject
        - CopyObject
        - DeleteObject
        - CompleteMultipartUpload
        - AbortMultipartUpload
      type: string
    mq_renamed_name:
      example: renamed-example-queue
      type: string
    mq_result_info:
      properties:
        count:
          description: Total number of results for the requested service.
          example: 1
          type: number
        page:
          description: Current page within paginated list of results.
          example: 1
          type: number
        per_page:
          description: Number of results per page of results.
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters.
          example: 2000
          type: number
      type: object
    mq_rule:
      properties:
        actions:
          description: Array of R2 object actions that will trigger notifications
          example:
            - PutObject
            - CopyObject
          items:
            $ref: '#/components/schemas/mq_r2-action'
          type: array
          uniqueItems: true
        prefix:
          description: Notifications will be sent only for objects with this prefix
          example: img/
          type: string
        suffix:
          description: Notifications will be sent only for objects with this suffix
          example: .jpeg
          type: string
      required:
        - actions
      type: object
    mq_script-response-collection:
      allOf:
        - $ref: '#/components/schemas/mq_api-response-common'
        - properties:
            result:
              items:
                properties:
                  created_on:
                    readOnly: true
                  etag:
                    readOnly: true
                  id:
                    readOnly: true
                  modified_on:
                    readOnly: true
                  usage_model:
                    readOnly: true
              type: array
    mq_visibility_timeout:
      description: The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.
      example: 6000
      type: number
    observatory_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/observatory_api-response-common'
      type: object
    observatory_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/observatory_messages'
        messages:
          $ref: '#/components/schemas/observatory_messages'
        success:
          description: Whether the API call was successful.
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    observatory_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/observatory_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/observatory_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    observatory_api-response-single:
      allOf:
        - $ref: '#/components/schemas/observatory_api-response-common'
      type: object
    observatory_availabilities:
      properties:
        quota:
          properties:
            plan:
              description: Cloudflare plan.
              example: free
              type: string
            quotasPerPlan:
              description: The number of tests available per plan.
              properties:
                value:
                  $ref: '#/components/schemas/observatory_plan-properties-info'
              type: object
            remainingSchedules:
              description: The number of remaining schedules available.
              example: 1
              type: number
            remainingTests:
              description: The number of remaining tests available.
              example: 30
              type: number
            scheduleQuotasPerPlan:
              description: The number of schedules available per plan.
              properties:
                value:
                  $ref: '#/components/schemas/observatory_plan-properties-info'
              type: object
          type: object
        regions:
          items:
            $ref: '#/components/schemas/observatory_labeled_region'
          type: array
        regionsPerPlan:
          description: Available regions.
          properties:
            business:
              items:
                $ref: '#/components/schemas/observatory_labeled_region'
              type: array
            enterprise:
              items:
                $ref: '#/components/schemas/observatory_labeled_region'
              type: array
            free:
              items:
                $ref: '#/components/schemas/observatory_labeled_region'
              type: array
            pro:
              items:
                $ref: '#/components/schemas/observatory_labeled_region'
              type: array
          type: object
      type: object
    observatory_availabilities-response:
      allOf:
        - $ref: '#/components/schemas/observatory_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/observatory_availabilities'
    observatory_count-response:
      allOf:
        - $ref: '#/components/schemas/observatory_api-response-single'
        - properties:
            result:
              properties:
                count:
                  description: Number of items affected.
                  example: 1
                  type: number
              type: object
    observatory_create-schedule-response:
      allOf:
        - $ref: '#/components/schemas/observatory_api-response-single'
        - properties:
            result:
              properties:
                schedule:
                  $ref: '#/components/schemas/observatory_schedule'
                test:
                  $ref: '#/components/schemas/observatory_page_test'
              type: object
    observatory_device_type:
      description: The type of device.
      enum:
        - DESKTOP
        - MOBILE
      example: DESKTOP
      type: string
    observatory_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    observatory_labeled_region:
      description: A test region with a label.
      properties:
        label:
          example: Iowa, USA
          type: string
        value:
          $ref: '#/components/schemas/observatory_region'
      type: object
    observatory_lighthouse_error_code:
      description: The error code of the Lighthouse result.
      enum:
        - NOT_REACHABLE
        - DNS_FAILURE
        - NOT_HTML
        - LIGHTHOUSE_TIMEOUT
        - UNKNOWN
      example: NOT_REACHABLE
      type: string
    observatory_lighthouse_report:
      description: The Lighthouse report.
      properties:
        cls:
          description: Cumulative Layout Shift.
          example: 100
          type: number
        deviceType:
          $ref: '#/components/schemas/observatory_device_type'
        error:
          properties:
            code:
              $ref: '#/components/schemas/observatory_lighthouse_error_code'
            detail:
              description: Detailed error message.
              example: 'Details: net::ERR_CONNECTION_CLOSED'
              type: string
            finalDisplayedUrl:
              description: The final URL displayed to the user.
              example: example.com
              type: string
          type: object
        fcp:
          description: First Contentful Paint.
          example: 100
          type: number
        jsonReportUrl:
          description: The URL to the full Lighthouse JSON report.
          type: string
        lcp:
          description: Largest Contentful Paint.
          example: 100
          type: number
        performanceScore:
          description: The Lighthouse performance score.
          example: 90
          type: number
        si:
          description: Speed Index.
          example: 100
          type: number
        state:
          $ref: '#/components/schemas/observatory_lighthouse_state'
        tbt:
          description: Total Blocking Time.
          example: 100
          type: number
        ttfb:
          description: Time To First Byte.
          example: 100
          type: number
        tti:
          description: Time To Interactive.
          example: 100
          type: number
      type: object
    observatory_lighthouse_state:
      description: The state of the Lighthouse report.
      enum:
        - RUNNING
        - COMPLETE
        - FAILED
      example: COMPLETE
      type: string
    observatory_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    observatory_page-test-response-collection:
      allOf:
        - $ref: '#/components/schemas/observatory_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/observatory_page_test'
              type: array
        - properties:
            result_info:
              $ref: '#/components/schemas/observatory_result_info'
    observatory_page-test-response-single:
      allOf:
        - $ref: '#/components/schemas/observatory_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/observatory_page_test'
    observatory_page_test:
      properties:
        date:
          $ref: '#/components/schemas/observatory_timestamp'
        desktopReport:
          $ref: '#/components/schemas/observatory_lighthouse_report'
        id:
          $ref: '#/components/schemas/observatory_uuid'
        mobileReport:
          $ref: '#/components/schemas/observatory_lighthouse_report'
        region:
          $ref: '#/components/schemas/observatory_labeled_region'
        scheduleFrequency:
          $ref: '#/components/schemas/observatory_schedule_frequency'
        url:
          $ref: '#/components/schemas/observatory_url'
      type: object
    observatory_pages-response-collection:
      allOf:
        - $ref: '#/components/schemas/observatory_api-response-collection'
        - properties:
            result:
              items:
                properties:
                  region:
                    $ref: '#/components/schemas/observatory_labeled_region'
                  scheduleFrequency:
                    $ref: '#/components/schemas/observatory_schedule_frequency'
                  tests:
                    items:
                      $ref: '#/components/schemas/observatory_page_test'
                    type: array
                  url:
                    $ref: '#/components/schemas/observatory_url'
              type: array
    observatory_plan-properties-info:
      description: Counts per account plan.
      properties:
        business:
          example: 1
          type: integer
        enterprise:
          example: 1
          type: integer
        free:
          example: 1
          type: integer
        pro:
          example: 1
          type: integer
      type: object
    observatory_region:
      description: A test region.
      enum:
        - asia-east1
        - asia-northeast1
        - asia-northeast2
        - asia-south1
        - asia-southeast1
        - australia-southeast1
        - europe-north1
        - europe-southwest1
        - europe-west1
        - europe-west2
        - europe-west3
        - europe-west4
        - europe-west8
        - europe-west9
        - me-west1
        - southamerica-east1
        - us-central1
        - us-east1
        - us-east4
        - us-south1
        - us-west1
      example: us-central1
      type: string
    observatory_result_info:
      properties:
        count:
          example: 5
          type: integer
        page:
          example: 1
          type: integer
        per_page:
          example: 5
          type: integer
        total_count:
          example: 3
          type: integer
      type: object
    observatory_schedule:
      description: The test schedule.
      properties:
        frequency:
          $ref: '#/components/schemas/observatory_schedule_frequency'
        region:
          $ref: '#/components/schemas/observatory_region'
        url:
          $ref: '#/components/schemas/observatory_url'
      type: object
    observatory_schedule-response-single:
      allOf:
        - $ref: '#/components/schemas/observatory_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/observatory_schedule'
    observatory_schedule_frequency:
      description: The frequency of the test.
      enum:
        - DAILY
        - WEEKLY
      example: DAILY
      type: string
    observatory_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      type: string
    observatory_trend:
      properties:
        cls:
          description: Cumulative Layout Shift trend.
          items:
            nullable: true
            type: number
          type: array
        fcp:
          description: First Contentful Paint trend.
          items:
            nullable: true
            type: number
          type: array
        lcp:
          description: Largest Contentful Paint trend.
          items:
            nullable: true
            type: number
          type: array
        performanceScore:
          description: The Lighthouse score trend.
          items:
            nullable: true
            type: number
          type: array
        si:
          description: Speed Index trend.
          items:
            nullable: true
            type: number
          type: array
        tbt:
          description: Total Blocking Time trend.
          items:
            nullable: true
            type: number
          type: array
        ttfb:
          description: Time To First Byte trend.
          items:
            nullable: true
            type: number
          type: array
        tti:
          description: Time To Interactive trend.
          items:
            nullable: true
            type: number
          type: array
      type: object
    observatory_trend-response:
      allOf:
        - $ref: '#/components/schemas/observatory_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/observatory_trend'
    observatory_url:
      description: A URL.
      example: example.com
      type: string
    observatory_uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    page-shield_api-get-response-collection:
      allOf:
        - $ref: '#/components/schemas/page-shield_api-response-common'
        - properties:
            result:
              nullable: true
              type: object
      type: object
    page-shield_api-list-response-collection:
      allOf:
        - $ref: '#/components/schemas/page-shield_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/page-shield_result_info'
          required:
            - result_info
      type: object
    page-shield_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/page-shield_messages'
        messages:
          $ref: '#/components/schemas/page-shield_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
      type: object
    page-shield_api-response-common-failure:
      properties:
        errors:
          $ref: '#/components/schemas/page-shield_messages'
        messages:
          $ref: '#/components/schemas/page-shield_messages'
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
      type: object
    page-shield_api-response-single:
      allOf:
        - $ref: '#/components/schemas/page-shield_api-response-common'
        - properties:
            result:
              anyOf:
                - type: object
                - items: {}
                  type: array
                - type: string
      type: object
    page-shield_connection:
      properties:
        added_at:
          example: "2021-08-18T10:51:10.09615Z"
          format: date-time
          type: string
        domain_reported_malicious:
          example: false
          type: boolean
        first_page_url:
          example: blog.cloudflare.com/page
          type: string
        first_seen_at:
          example: "2021-08-18T10:51:08Z"
          format: date-time
          type: string
        host:
          example: blog.cloudflare.com
          type: string
        id:
          $ref: '#/components/schemas/page-shield_id'
        last_seen_at:
          example: "2021-09-02T09:57:54Z"
          format: date-time
          type: string
        malicious_domain_categories:
          example:
            - Malware
          items:
            type: string
          type: array
        malicious_url_categories:
          example:
            - Malware
          items:
            type: string
          type: array
        page_urls:
          example:
            - blog.cloudflare.com/page1
            - blog.cloudflare.com/page2
          items:
            type: string
          type: array
        url:
          example: https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js
          type: string
        url_contains_cdn_cgi_path:
          example: false
          type: boolean
        url_reported_malicious:
          example: false
          type: boolean
      required:
        - id
        - url
        - added_at
        - first_seen_at
        - last_seen_at
        - host
        - url_contains_cdn_cgi_path
    page-shield_cookie:
      properties:
        domain_attribute:
          example: cloudflare.com
          type: string
        expires_attribute:
          example: "2021-10-02T09:57:54Z"
          format: date-time
          type: string
        first_seen_at:
          example: "2021-08-18T10:51:08Z"
          format: date-time
          type: string
        host:
          example: blog.cloudflare.com
          type: string
        http_only_attribute:
          example: true
          type: boolean
        id:
          $ref: '#/components/schemas/page-shield_id'
        last_seen_at:
          example: "2021-09-02T09:57:54Z"
          format: date-time
          type: string
        max_age_attribute:
          example: 3600
          type: integer
        name:
          example: session_id
          type: string
        page_urls:
          example:
            - blog.cloudflare.com/page1
            - blog.cloudflare.com/page2
          items:
            type: string
          type: array
        path_attribute:
          example: /
          type: string
        same_site_attribute:
          enum:
            - lax
            - strict
            - none
          example: strict
          type: string
        secure_attribute:
          example: true
          type: boolean
        type:
          enum:
            - first_party
            - unknown
          example: first_party
          type: string
      required:
        - id
        - type
        - name
        - host
        - first_seen_at
        - last_seen_at
    page-shield_cryptomining_score:
      description: The cryptomining score of the JavaScript content.
      maximum: 99
      minimum: 1
      nullable: true
      type: integer
    page-shield_dataflow_score:
      description: The dataflow score of the JavaScript content.
      maximum: 99
      minimum: 1
      nullable: true
      type: integer
    page-shield_enabled:
      description: When true, indicates that Page Shield is enabled.
      example: true
      type: boolean
    page-shield_fetched_at:
      description: The timestamp of when the script was last fetched.
      nullable: true
      type: string
    page-shield_get-zone-connection-response:
      allOf:
        - $ref: '#/components/schemas/page-shield_api-get-response-collection'
        - properties:
            result:
              $ref: '#/components/schemas/page-shield_connection'
          required:
            - result
    page-shield_get-zone-cookie-response:
      allOf:
        - $ref: '#/components/schemas/page-shield_api-get-response-collection'
        - properties:
            result:
              $ref: '#/components/schemas/page-shield_cookie'
          required:
            - result
    page-shield_get-zone-policy-response:
      allOf:
        - $ref: '#/components/schemas/page-shield_api-get-response-collection'
        - properties:
            result:
              $ref: '#/components/schemas/page-shield_policy-with-id'
          required:
            - result
    page-shield_get-zone-script-response:
      allOf:
        - $ref: '#/components/schemas/page-shield_api-get-response-collection'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/page-shield_script'
                - properties:
                    versions:
                      example:
                        - cryptomining_score: 20
                          dataflow_score: 2
                          fetched_at: "2021-08-18T10:51:08Z"
                          hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b423
                          js_integrity_score: 2
                          magecart_score: 10
                          malware_score: 5
                          obfuscation_score: 10
                      items:
                        $ref: '#/components/schemas/page-shield_version'
                      nullable: true
                      type: array
          required:
            - result
    page-shield_get-zone-settings-response:
      properties:
        enabled:
          $ref: '#/components/schemas/page-shield_enabled'
        updated_at:
          $ref: '#/components/schemas/page-shield_updated_at'
        use_cloudflare_reporting_endpoint:
          $ref: '#/components/schemas/page-shield_use_cloudflare_reporting_endpoint'
        use_connection_url_path:
          $ref: '#/components/schemas/page-shield_use_connection_url_path'
      required:
        - enabled
        - updated_at
        - use_cloudflare_reporting_endpoint
        - use_connection_url_path
    page-shield_hash:
      description: The computed hash of the analyzed script.
      maxLength: 64
      minLength: 64
      nullable: true
      type: string
    page-shield_id:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    page-shield_js_integrity_score:
      description: The integrity score of the JavaScript content.
      maximum: 99
      minimum: 1
      nullable: true
      type: integer
    page-shield_list-zone-connections-response:
      allOf:
        - $ref: '#/components/schemas/page-shield_api-list-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/page-shield_connection'
              type: array
          type: object
    page-shield_list-zone-cookies-response:
      allOf:
        - $ref: '#/components/schemas/page-shield_api-list-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/page-shield_cookie'
              type: array
          required:
            - result
          type: object
    page-shield_list-zone-policies-response:
      allOf:
        - $ref: '#/components/schemas/page-shield_api-list-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/page-shield_policy-with-id'
              type: array
          required:
            - result
          type: object
    page-shield_list-zone-scripts-response:
      allOf:
        - $ref: '#/components/schemas/page-shield_api-list-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/page-shield_script'
              type: array
          required:
            - result
          type: object
    page-shield_magecart_score:
      description: The magecart score of the JavaScript content.
      maximum: 99
      minimum: 1
      nullable: true
      type: integer
    page-shield_malware_score:
      description: The malware score of the JavaScript content.
      maximum: 99
      minimum: 1
      nullable: true
      type: integer
    page-shield_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    page-shield_obfuscation_score:
      description: The obfuscation score of the JavaScript content.
      maximum: 99
      minimum: 1
      nullable: true
      type: integer
    page-shield_policy:
      properties:
        action:
          $ref: '#/components/schemas/page-shield_policy-action'
        description:
          $ref: '#/components/schemas/page-shield_policy-description'
        enabled:
          $ref: '#/components/schemas/page-shield_policy-enabled'
        expression:
          $ref: '#/components/schemas/page-shield_policy-expression'
        value:
          $ref: '#/components/schemas/page-shield_policy-value'
      required:
        - description
        - action
        - expression
        - enabled
        - value
    page-shield_policy-action:
      description: The action to take if the expression matches
      enum:
        - allow
        - log
      example: allow
      type: string
    page-shield_policy-description:
      description: A description for the policy
      example: Checkout page CSP policy
      type: string
    page-shield_policy-enabled:
      description: Whether the policy is enabled
      example: true
      type: boolean
    page-shield_policy-expression:
      description: The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax
      example: ends_with(http.request.uri.path, "/checkout")
      type: string
    page-shield_policy-value:
      description: The policy which will be applied
      example: script-src 'none';
      type: string
    page-shield_policy-with-id:
      allOf:
        - $ref: '#/components/schemas/page-shield_policy'
        - properties:
            id:
              $ref: '#/components/schemas/page-shield_id'
          required:
            - id
      required:
        - id
        - description
        - action
        - expression
        - enabled
        - value
    page-shield_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
        total_pages:
          description: Total number of pages
          example: 100
          type: number
      required:
        - page
        - per_page
        - count
        - total_count
        - total_pages
      type: object
    page-shield_script:
      properties:
        added_at:
          example: "2021-08-18T10:51:10.09615Z"
          format: date-time
          type: string
        cryptomining_score:
          $ref: '#/components/schemas/page-shield_cryptomining_score'
        dataflow_score:
          $ref: '#/components/schemas/page-shield_dataflow_score'
        domain_reported_malicious:
          example: false
          type: boolean
        fetched_at:
          $ref: '#/components/schemas/page-shield_fetched_at'
        first_page_url:
          example: blog.cloudflare.com/page
          type: string
        first_seen_at:
          example: "2021-08-18T10:51:08Z"
          format: date-time
          type: string
        hash:
          $ref: '#/components/schemas/page-shield_hash'
        host:
          example: blog.cloudflare.com
          type: string
        id:
          $ref: '#/components/schemas/page-shield_id'
        js_integrity_score:
          $ref: '#/components/schemas/page-shield_js_integrity_score'
        last_seen_at:
          example: "2021-09-02T09:57:54Z"
          format: date-time
          type: string
        magecart_score:
          $ref: '#/components/schemas/page-shield_magecart_score'
        malicious_domain_categories:
          example:
            - Malware
          items:
            type: string
          type: array
        malicious_url_categories:
          example:
            - Malware
          items:
            type: string
          type: array
        malware_score:
          $ref: '#/components/schemas/page-shield_malware_score'
        obfuscation_score:
          $ref: '#/components/schemas/page-shield_obfuscation_score'
        page_urls:
          example:
            - blog.cloudflare.com/page1
            - blog.cloudflare.com/page2
          items:
            type: string
          type: array
        url:
          example: https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js
          type: string
        url_contains_cdn_cgi_path:
          example: false
          type: boolean
        url_reported_malicious:
          example: false
          type: boolean
      required:
        - id
        - url
        - added_at
        - first_seen_at
        - last_seen_at
        - host
        - url_contains_cdn_cgi_path
    page-shield_update-zone-settings-response:
      properties:
        enabled:
          $ref: '#/components/schemas/page-shield_enabled'
        updated_at:
          $ref: '#/components/schemas/page-shield_updated_at'
        use_cloudflare_reporting_endpoint:
          $ref: '#/components/schemas/page-shield_use_cloudflare_reporting_endpoint'
        use_connection_url_path:
          $ref: '#/components/schemas/page-shield_use_connection_url_path'
      required:
        - enabled
        - updated_at
        - use_cloudflare_reporting_endpoint
        - use_connection_url_path
    page-shield_updated_at:
      description: The timestamp of when Page Shield was last updated.
      example: "2022-10-12T17:56:52.083582+01:00"
      type: string
    page-shield_use_cloudflare_reporting_endpoint:
      description: When true, CSP reports will be sent to https://csp-reporting.cloudflare.com/cdn-cgi/script_monitor/report
      example: true
      type: boolean
    page-shield_use_connection_url_path:
      description: When true, the paths associated with connections URLs will also be analyzed.
      example: true
      type: boolean
    page-shield_version:
      description: The version of the analyzed script.
      properties:
        cryptomining_score:
          $ref: '#/components/schemas/page-shield_cryptomining_score'
        dataflow_score:
          $ref: '#/components/schemas/page-shield_dataflow_score'
        fetched_at:
          $ref: '#/components/schemas/page-shield_fetched_at'
        hash:
          $ref: '#/components/schemas/page-shield_hash'
        js_integrity_score:
          $ref: '#/components/schemas/page-shield_js_integrity_score'
        magecart_score:
          $ref: '#/components/schemas/page-shield_magecart_score'
        malware_score:
          $ref: '#/components/schemas/page-shield_malware_score'
        obfuscation_score:
          $ref: '#/components/schemas/page-shield_obfuscation_score'
      type: object
    page-shield_zone_settings_response_single:
      allOf:
        - $ref: '#/components/schemas/page-shield_api-response-single'
        - properties:
            result:
              type: object
    pages_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/pages_messages'
        messages:
          $ref: '#/components/schemas/pages_messages'
        success:
          description: Whether the API call was successful
          enum:
            - false
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    pages_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/pages_messages'
          example:
            - code: 7003
              message: No route for the URI.
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/pages_messages'
          example: []
        result:
          nullable: true
          type: object
        success:
          description: Whether the API call was successful.
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    pages_api-response-pagination:
      properties:
        result_info:
          properties:
            count:
              description: The number of items on the current page.
              example: 1
              type: integer
            page:
              description: The page currently being requested.
              example: 1
              type: integer
            per_page:
              description: The number of items per page being returned.
              example: 100
              type: integer
            total_count:
              description: The total count of items.
              example: 1
              type: integer
            total_pages:
              description: The total count of pages.
              example: 1
              type: integer
          required:
            - page
            - per_page
            - count
            - total_count
          type: object
      type: object
    pages_api-response-single:
      allOf:
        - $ref: '#/components/schemas/pages_api-response-common'
        - properties:
            result:
              nullable: true
              type: object
      type: object
    pages_build_config:
      description: Configs for the project build process.
      properties:
        build_caching:
          description: Enable build caching for the project.
          example: true
          nullable: true
          type: boolean
        build_command:
          description: Command used to build project.
          example: npm run build
          nullable: true
          type: string
        destination_dir:
          description: Output directory of the build.
          example: build
          nullable: true
          type: string
        root_dir:
          description: Directory to run the command.
          example: /
          nullable: true
          type: string
        web_analytics_tag:
          description: The classifying tag for analytics.
          example: cee1c73f6e4743d0b5e6bb1a0bcaabcc
          nullable: true
          type: string
        web_analytics_token:
          description: The auth token for analytics.
          example: 021e1057c18547eca7b79f2516f06o7x
          nullable: true
          type: string
      type: object
    pages_deployment-list-response:
      allOf:
        - $ref: '#/components/schemas/pages_api-response-common'
        - $ref: '#/components/schemas/pages_api-response-pagination'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/pages_deployments'
              type: array
    pages_deployment-new-deployment:
      allOf:
        - $ref: '#/components/schemas/pages_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/pages_deployments'
    pages_deployment-response-details:
      allOf:
        - $ref: '#/components/schemas/pages_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/pages_deployments'
    pages_deployment-response-logs:
      allOf:
        - $ref: '#/components/schemas/pages_api-response-common'
        - properties:
            result:
              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
              properties:
                data:
                  items:
                    properties:
                      line:
                        readOnly: true
                        type: string
                      ts:
                        readOnly: true
                        type: string
                    type: object
                  type: array
                includes_container_logs:
                  readOnly: true
                  type: boolean
                total:
                  readOnly: true
                  type: integer
              type: object
          type: object
    pages_deployment-response-stage-logs:
      allOf:
        - $ref: '#/components/schemas/pages_api-response-common'
        - properties:
            result:
              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
              type: object
    pages_deployment_configs:
      description: Configs for deployments in a project.
      properties:
        preview:
          anyOf:
            - $ref: '#/components/schemas/pages_deployment_configs_values'
          description: Configs for preview deploys.
          type: object
        production:
          anyOf:
            - $ref: '#/components/schemas/pages_deployment_configs_values'
          description: Configs for production deploys.
          type: object
      type: object
    pages_deployment_configs_values:
      properties:
        ai_bindings:
          additionalProperties:
            description: AI binding.
            nullable: true
            properties:
              project_id:
                type: string
            type: object
          description: Constellation bindings used for Pages Functions.
          example:
            AI_BINDING:
              project_id: some-project-id
          nullable: true
          type: object
        analytics_engine_datasets:
          additionalProperties:
            description: Analytics Engine binding.
            nullable: true
            properties:
              dataset:
                description: Name of the dataset.
                example: api_analytics
                type: string
            type: object
          description: Analytics Engine bindings used for Pages Functions.
          example:
            ANALYTICS_ENGINE_BINDING:
              dataset: api_analytics
          nullable: true
          type: object
        browsers:
          additionalProperties:
            description: Browser binding.
            nullable: true
            type: object
          description: Browser bindings used for Pages Functions.
          example:
            BROWSER: {}
          nullable: true
          type: object
        compatibility_date:
          description: Compatibility date used for Pages Functions.
          example: "2022-01-01"
          type: string
        compatibility_flags:
          description: Compatibility flags used for Pages Functions.
          example:
            - url_standard
          items:
            type: string
          type: array
        d1_databases:
          additionalProperties:
            description: D1 binding.
            nullable: true
            properties:
              id:
                description: UUID of the D1 database.
                example: 445e2955-951a-43f8-a35b-a4d0c8138f63
                type: string
            type: object
          description: D1 databases used for Pages Functions.
          example:
            D1_BINDING:
              id: 445e2955-951a-43f8-a35b-a4d0c8138f63
          nullable: true
          type: object
        durable_object_namespaces:
          additionalProperties:
            description: Durabble Object binding.
            nullable: true
            properties:
              namespace_id:
                description: ID of the Durabble Object namespace.
                example: 5eb63bbbe01eeed093cb22bb8f5acdc3
                type: string
            type: object
          description: Durabble Object namespaces used for Pages Functions.
          example:
            DO_BINDING:
              namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3
          nullable: true
          type: object
        env_vars:
          additionalProperties:
            description: Environment variable.
            example:
              type: plain_text
              value: hello world
            nullable: true
            properties:
              type:
                description: The type of environment variable.
                enum:
                  - plain_text
                  - secret_text
                type: string
              value:
                description: Environment variable value.
                type: string
            required:
              - value
            type: object
          description: Environment variables for build configs.
          nullable: true
          type: object
        hyperdrive_bindings:
          additionalProperties:
            description: Hyperdrive binding.
            nullable: true
            properties:
              id:
                example: a76a99bc342644deb02c38d66082262a
                type: string
            type: object
          description: Hyperdrive bindings used for Pages Functions.
          example:
            HYPERDRIVE:
              id: a76a99bc342644deb02c38d66082262a
          nullable: true
          type: object
        kv_namespaces:
          additionalProperties:
            description: KV namespace binding.
            nullable: true
            properties:
              namespace_id:
                description: ID of the KV namespace.
                example: 5eb63bbbe01eeed093cb22bb8f5acdc3
                type: string
            type: object
          description: KV namespaces used for Pages Functions.
          example:
            KV_BINDING:
              namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3
          nullable: true
          type: object
        mtls_certificates:
          additionalProperties:
            description: mTLS binding.
            nullable: true
            properties:
              certificate_id:
                example: d7cdd17c-916f-4cb7-aabe-585eb382ec4e
                type: string
            type: object
          description: mTLS bindings used for Pages Functions.
          example:
            MTLS:
              certificate_id: d7cdd17c-916f-4cb7-aabe-585eb382ec4e
          nullable: true
          type: object
        placement:
          description: Placement setting used for Pages Functions.
          example:
            mode: smart
          nullable: true
          properties:
            mode:
              description: Placement mode.
              example: smart
              type: string
          type: object
        queue_producers:
          additionalProperties:
            description: Queue Producer binding.
            nullable: true
            properties:
              name:
                description: Name of the Queue.
                example: some-queue
                type: string
            type: object
          description: Queue Producer bindings used for Pages Functions.
          example:
            QUEUE_PRODUCER_BINDING:
              name: some-queue
          nullable: true
          type: object
        r2_buckets:
          additionalProperties:
            description: R2 binding.
            nullable: true
            properties:
              jurisdiction:
                description: Jurisdiction of the R2 bucket.
                example: eu
                nullable: true
                type: string
              name:
                description: Name of the R2 bucket.
                example: some-bucket
                type: string
            type: object
          description: R2 buckets used for Pages Functions.
          example:
            R2_BINDING:
              name: some-bucket
          nullable: true
          type: object
        services:
          additionalProperties:
            description: Service binding.
            nullable: true
            properties:
              entrypoint:
                description: The entrypoint to bind to.
                nullable: true
                type: string
              environment:
                description: The Service environment.
                type: string
              service:
                description: The Service name.
                type: string
            type: object
          description: Services used for Pages Functions.
          example:
            SERVICE_BINDING:
              entrypoint: MyHandler
              environment: production
              service: example-worker
          nullable: true
          type: object
        vectorize_bindings:
          additionalProperties:
            description: Vectorize binding.
            nullable: true
            properties:
              index_name:
                example: my_index
                type: string
            type: object
          description: Vectorize bindings used for Pages Functions.
          example:
            VECTORIZE:
              index_name: my_index
          nullable: true
          type: object
      type: object
    pages_deployment_stage_name:
      description: Deployment stage name.
      example: deploy
      pattern: queued|initialize|clone_repo|build|deploy
      type: string
    pages_deployments:
      properties:
        aliases:
          description: A list of alias URLs pointing to this deployment.
          example:
            - https://branchname.projectname.pages.dev
          items:
            type: string
          nullable: true
          readOnly: true
          type: array
        build_config:
          $ref: '#/components/schemas/pages_build_config'
        created_on:
          description: When the deployment was created.
          example: "2021-03-09T00:55:03.923456Z"
          format: date-time
          readOnly: true
          type: string
        deployment_trigger:
          description: Info about what caused the deployment.
          properties:
            metadata:
              description: Additional info about the trigger.
              properties:
                branch:
                  description: Where the trigger happened.
                  example: main
                  readOnly: true
                  type: string
                commit_hash:
                  description: Hash of the deployment trigger commit.
                  example: ad9ccd918a81025731e10e40267e11273a263421
                  readOnly: true
                  type: string
                commit_message:
                  description: Message of the deployment trigger commit.
                  example: Update index.html
                  readOnly: true
                  type: string
              type: object
            type:
              description: What caused the deployment.
              example: ad_hoc
              pattern: push|ad_hoc
              readOnly: true
              type: string
          readOnly: true
          type: object
        env_vars:
          additionalProperties:
            description: Environment variable.
            nullable: true
            properties:
              type:
                description: The type of environment variable.
                type: string
              value:
                description: Environment variable value.
                type: string
            required:
              - value
            type: object
          description: A dict of env variables to build this deploy.
          example:
            BUILD_VERSION:
              value: "3.3"
            ENV:
              value: STAGING
          readOnly: true
          type: object
        environment:
          description: Type of deploy.
          example: preview
          pattern: preview|production
          readOnly: true
          type: string
        id:
          description: Id of the deployment.
          example: f64788e9-fccd-4d4a-a28a-cb84f88f6
          readOnly: true
          type: string
        is_skipped:
          description: If the deployment has been skipped.
          example: true
          readOnly: true
          type: boolean
        latest_stage:
          $ref: '#/components/schemas/pages_stage'
        modified_on:
          description: When the deployment was last modified.
          example: 2021-03-09T00:58:59.045655
          format: date-time
          readOnly: true
          type: string
        project_id:
          description: Id of the project.
          example: 7b162ea7-7367-4d67-bcde-1160995d5
          readOnly: true
          type: string
        project_name:
          description: Name of the project.
          example: ninjakittens
          readOnly: true
          type: string
        short_id:
          description: Short Id (8 character) of the deployment.
          example: f64788e9
          readOnly: true
          type: string
        source:
          $ref: '#/components/schemas/pages_source'
        stages:
          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:
              name: initialize
              started_on:
              status: idle
            - ended_on:
              name: clone_repo
              started_on:
              status: idle
            - ended_on:
              name: build
              started_on:
              status: idle
            - ended_on:
              name: deploy
              started_on:
              status: idle
          items:
            $ref: '#/components/schemas/pages_stage'
          readOnly: true
          type: array
        url:
          description: The live URL to view this deployment.
          example: https://f64788e9.ninjakittens.pages.dev
          readOnly: true
          type: string
      type: object
    pages_domain-object:
      properties:
        certificate_authority:
          enum:
            - google
            - lets_encrypt
          example: lets_encrypt
          readOnly: true
          type: string
        created_on:
          readOnly: true
          type: string
        domain_id:
          readOnly: true
          type: string
        id:
          readOnly: true
          type: string
        name:
          example: example.com
          type: string
        status:
          enum:
            - initializing
            - pending
            - active
            - deactivated
            - blocked
            - error
          readOnly: true
          type: string
        validation_data:
          properties:
            error_message:
              type: string
            method:
              enum:
                - http
                - txt
              type: string
            status:
              enum:
                - initializing
                - pending
                - active
                - deactivated
                - error
              type: string
            txt_name:
              type: string
            txt_value:
              type: string
          readOnly: true
          type: object
        verification_data:
          properties:
            error_message:
              type: string
            status:
              enum:
                - pending
                - active
                - deactivated
                - blocked
                - error
              type: string
          readOnly: true
          type: object
        zone_tag:
          readOnly: true
          type: string
      type: object
    pages_domain-response-collection:
      allOf:
        - $ref: '#/components/schemas/pages_api-response-common'
        - $ref: '#/components/schemas/pages_api-response-pagination'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/pages_domain-object'
              type: array
    pages_domain-response-single:
      allOf:
        - $ref: '#/components/schemas/pages_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/pages_domain-object'
    pages_domain_name:
      description: Name of the domain.
      example: this-is-my-domain-01.com
      pattern: ^[a-z0-9][a-z0-9-]*$
      type: string
    pages_domains-post:
      properties:
        name:
          example: example.com
          type: string
      type: object
    pages_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    pages_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    pages_project-object:
      properties:
        build_config:
          $ref: '#/components/schemas/pages_build_config'
        canonical_deployment:
          allOf:
            - $ref: '#/components/schemas/pages_deployments'
            - description: Most recent deployment to the repo.
              nullable: true
              readOnly: true
              type: object
        created_on:
          description: When the project was created.
          example: "2017-01-01T00:00:00Z"
          format: date-time
          readOnly: true
          type: string
        deployment_configs:
          $ref: '#/components/schemas/pages_deployment_configs'
        domains:
          description: A list of associated custom domains for the project.
          example:
            - customdomain.com
            - customdomain.org
          items:
            type: string
          readOnly: true
          type: array
        id:
          description: Id of the project.
          example: 7b162ea7-7367-4d67-bcde-1160995d5
          readOnly: true
          type: string
        latest_deployment:
          allOf:
            - $ref: '#/components/schemas/pages_deployments'
            - description: Most recent deployment to the repo.
              nullable: true
              readOnly: true
              type: object
        name:
          description: Name of the project.
          example: NextJS Blog
          type: string
        production_branch:
          description: Production branch of the project. Used to identify production deployments.
          example: main
          type: string
        source:
          $ref: '#/components/schemas/pages_source'
        subdomain:
          description: The Cloudflare subdomain associated with the project.
          example: helloworld.pages.dev
          readOnly: true
          type: string
      type: object
    pages_project-patch:
      allOf:
        - $ref: '#/components/schemas/pages_project-object'
        - example:
            deployment_configs:
              production:
                compatibility_date: "2022-01-01"
                compatibility_flags:
                  - url_standard
                env_vars:
                  BUILD_VERSION:
                    value: "3.3"
                  delete_this_env_var:
                  secret_var:
                    type: secret_text
                    value: A_CMS_API_TOKEN
          type: object
    pages_project-response:
      allOf:
        - $ref: '#/components/schemas/pages_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/pages_project-object'
    pages_project_name:
      description: Name of the project.
      example: this-is-my-project-01
      pattern: ^[a-z0-9][a-z0-9-]*$
      type: string
    pages_projects-response:
      allOf:
        - $ref: '#/components/schemas/pages_api-response-common'
        - $ref: '#/components/schemas/pages_api-response-pagination'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/pages_deployments'
              type: array
    pages_source:
      properties:
        config:
          properties:
            deployments_enabled:
              type: boolean
            owner:
              type: string
            path_excludes:
              items:
                type: string
              type: array
            path_includes:
              items:
                type: string
              type: array
            pr_comments_enabled:
              type: boolean
            preview_branch_excludes:
              items:
                type: string
              type: array
            preview_branch_includes:
              items:
                type: string
              type: array
            preview_deployment_setting:
              enum:
                - all
                - none
                - custom
              type: string
            production_branch:
              type: string
            production_deployments_enabled:
              type: boolean
            repo_name:
              type: string
          type: object
        type:
          type: string
      readOnly: true
      type: object
    pages_stage:
      description: The status of the deployment.
      properties:
        ended_on:
          description: When the stage ended.
          example: 2021-03-09T00:58:59.045655
          format: date-time
          nullable: true
          readOnly: true
          type: string
        name:
          description: The current build stage.
          example: deploy
          pattern: queued|initialize|clone_repo|build|deploy
          type: string
        started_on:
          description: When the stage started.
          example: "2021-03-09T00:55:03.923456Z"
          format: date-time
          nullable: true
          readOnly: true
          type: string
        status:
          description: State of the current stage.
          example: success
          pattern: success|idle|active|failure|canceled
          readOnly: true
          type: string
      readOnly: true
      type: object
    r2_account_identifier:
      description: Account ID
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    r2_add_custom_domain_request:
      example:
        domain: prefix.example-domain.com
        zoneId: 36ca64a6d92827b8a6b90be344bb1bfd
      properties:
        domain:
          description: Name of the custom domain to be added
          type: string
        enabled:
          description: Whether to enable public bucket access at the custom domain. If undefined, the domain will be enabled.
          type: boolean
        minTLS:
          description: Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0.
          enum:
            - "1.0"
            - "1.1"
            - "1.2"
            - "1.3"
          type: string
        zoneId:
          description: Zone ID of the custom domain
          type: string
      required:
        - domain
        - zoneId
      type: object
    r2_add_custom_domain_response:
      example:
        domain: example-domain.com
        enabled: true
      properties:
        domain:
          description: Domain name of the affected custom domain
          type: string
        enabled:
          description: Whether this bucket is publicly accessible at the specified custom domain
          type: boolean
        minTLS:
          description: Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0.
          enum:
            - "1.0"
            - "1.1"
            - "1.2"
            - "1.3"
          type: string
      required:
        - domain
        - enabled
      type: object
    r2_bucket:
      description: A single R2 bucket
      properties:
        creation_date:
          description: Creation timestamp
          type: string
        location:
          $ref: '#/components/schemas/r2_bucket_location'
        name:
          $ref: '#/components/schemas/r2_bucket_name'
        storage_class:
          $ref: '#/components/schemas/r2_storage_class'
      type: object
    r2_bucket_location:
      description: Location of the bucket
      enum:
        - apac
        - eeur
        - enam
        - weur
        - wnam
      type: string
    r2_bucket_name:
      description: Name of the bucket
      example: example-bucket
      maxLength: 64
      minLength: 3
      pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]
      type: string
    r2_domain_name:
      description: Name of the custom domain
      example: example-domain/custom-domain.com
      type: string
    r2_edit_custom_domain_request:
      example:
        enabled: true
        minTLS: "1.2"
      properties:
        enabled:
          description: Whether to enable public bucket access at the specified custom domain
          type: boolean
        minTLS:
          description: Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to previous value.
          enum:
            - "1.0"
            - "1.1"
            - "1.2"
            - "1.3"
          type: string
      type: object
    r2_edit_custom_domain_response:
      example:
        domain: example-domain.com
        enabled: true
      properties:
        domain:
          description: Domain name of the affected custom domain
          type: string
        enabled:
          description: Whether this bucket is publicly accessible at the specified custom domain
          type: boolean
        minTLS:
          description: Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0.
          enum:
            - "1.0"
            - "1.1"
            - "1.2"
            - "1.3"
          type: string
      required:
        - domain
      type: object
    r2_edit_managed_domain_request:
      example:
        enabled: true
      properties:
        enabled:
          description: Whether to enable public bucket access at the r2.dev domain
          type: boolean
      required:
        - enabled
      type: object
    r2_enable_sippy_aws:
      properties:
        destination:
          description: R2 bucket to copy objects to
          properties:
            accessKeyId:
              description: |
                ID of a Cloudflare API token.
                This is the value labelled "Access Key ID" when creating an API
                token from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).

                Sippy will use this token when writing objects to R2, so it is
                best to scope this token to the bucket you're enabling Sippy for.
              type: string
            provider:
              enum:
                - r2
              type: string
            secretAccessKey:
              description: |
                Value of a Cloudflare API token.
                This is the value labelled "Secret Access Key" when creating an API
                token from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).

                Sippy will use this token when writing objects to R2, so it is
                best to scope this token to the bucket you're enabling Sippy for.
              type: string
          type: object
        source:
          description: AWS S3 bucket to copy objects from
          properties:
            accessKeyId:
              description: Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
              type: string
            bucket:
              description: Name of the AWS S3 bucket
              type: string
            provider:
              enum:
                - aws
              type: string
            region:
              description: Name of the AWS availability zone
              type: string
            secretAccessKey:
              description: Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)
              type: string
          type: object
    r2_enable_sippy_gcs:
      properties:
        destination:
          description: R2 bucket to copy objects to
          properties:
            accessKeyId:
              description: |
                ID of a Cloudflare API token.
                This is the value labelled "Access Key ID" when creating an API
                token from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).

                Sippy will use this token when writing objects to R2, so it is
                best to scope this token to the bucket you're enabling Sippy for.
              type: string
            provider:
              enum:
                - r2
              type: string
            secretAccessKey:
              description: |
                Value of a Cloudflare API token.
                This is the value labelled "Secret Access Key" when creating an API
                token from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).

                Sippy will use this token when writing objects to R2, so it is
                best to scope this token to the bucket you're enabling Sippy for.
              type: string
          type: object
        source:
          description: GCS bucket to copy objects from
          properties:
            bucket:
              description: Name of the GCS bucket
              type: string
            clientEmail:
              description: Client email of an IAM credential (ideally scoped to a single GCS bucket)
              type: string
            privateKey:
              description: Private Key of an IAM credential (ideally scoped to a single GCS bucket)
              type: string
            provider:
              enum:
                - gcs
              type: string
          type: object
    r2_errors:
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    r2_list_custom_domains_response:
      example:
        domains:
          - domain: prefix.example-domain.one.com
            enabled: false
            status:
              ownership: deactivated
              ssl: pending
            zoneId: 36ca64a6d92827b8a6b90be344bb1bfd
            zoneName: example-domain.one.com
          - domain: prefix.example-domain.two.com
            enabled: true
            status:
              ownership: active
              ssl: active
            zoneId: d9d28585d5f8f5b0f857b055bf574f19
      properties:
        domains:
          items:
            properties:
              domain:
                description: Domain name of the custom domain to be added
                type: string
              enabled:
                description: Whether this bucket is publicly accessible at the specified custom domain
                type: boolean
              minTLS:
                description: Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0.
                enum:
                  - "1.0"
                  - "1.1"
                  - "1.2"
                  - "1.3"
                type: string
              status:
                properties:
                  ownership:
                    description: Ownership status of the domain
                    enum:
                      - pending
                      - active
                      - deactivated
                      - blocked
                      - error
                      - unknown
                    type: string
                  ssl:
                    description: SSL certificate status
                    enum:
                      - initializing
                      - pending
                      - active
                      - deactivated
                      - error
                      - unknown
                    type: string
                required:
                  - ssl
                  - ownership
                type: object
              zoneId:
                description: Zone ID of the custom domain resides in
                type: string
              zoneName:
                description: Zone that the custom domain resides in
                type: string
            required:
              - domain
              - status
              - enabled
            type: object
          type: array
      required:
        - domains
      type: object
    r2_managed_domain_response:
      example:
        bucketId: 0113a9e4549cf9b1ff1bf56e04da0cef
        domain: pub-0113a9e4549cf9b1ff1bf56e04da0cef.r2.dev
        enabled: true
      properties:
        bucketId:
          description: Bucket ID
          maxLength: 32
          type: string
        domain:
          description: Domain name of the bucket's r2.dev domain
          type: string
        enabled:
          description: Whether this bucket is publicly accessible at the r2.dev domain
          type: boolean
      required:
        - bucketId
        - domain
        - enabled
      type: object
    r2_messages:
      items:
        type: string
      type: array
    r2_remove_custom_domain_response:
      example:
        domain: example-domain/custom-domain.com
      properties:
        domain:
          description: Name of the removed custom domain
          type: string
      required:
        - domain
      type: object
    r2_result_info:
      properties:
        cursor:
          description: A continuation token that should be used to fetch the next page of results
          example: 1-JTdCJTIydiUyMiUzQTElMkMlMjJzdGFydEFmdGVyJTIyJTNBJTIyZGF2aWRwdWJsaWMlMjIlN0Q=
          type: string
        per_page:
          description: Maximum number of results on this page
          example: 20
          type: number
      type: object
    r2_sippy:
      properties:
        destination:
          description: Details about the configured destination bucket
          properties:
            accessKeyId:
              description: |
                ID of the Cloudflare API token used when writing objects to this
                bucket
              type: string
            account:
              type: string
            bucket:
              description: Name of the bucket on the provider
              type: string
            provider:
              enum:
                - r2
              type: string
          type: object
        enabled:
          description: State of Sippy for this bucket
          type: boolean
        source:
          description: Details about the configured source bucket
          properties:
            bucket:
              description: Name of the bucket on the provider
              type: string
            provider:
              enum:
                - aws
                - gcs
              type: string
            region:
              description: Region where the bucket resides (AWS only)
              nullable: true
              type: string
          type: object
      type: object
    r2_storage_class:
      default: Standard
      description: Storage class for newly uploaded objects, unless specified otherwise.
      enum:
        - Standard
        - InfrequentAccess
      type: string
    r2_temp_access_creds_request:
      example:
        bucket: example-bucket
        objects:
          - example-object
        parentAccessKeyId: example-access-key-id
        permission: object-read-write
        prefixes:
          - example-prefix/
        ttlSeconds: 3600
      properties:
        bucket:
          description: Name of the R2 bucket
          type: string
        objects:
          description: Optional object paths to scope the credentials to
          items:
            type: string
          type: array
        parentAccessKeyId:
          description: The parent access key id to use for signing
          type: string
        permission:
          description: Permissions allowed on the credentials
          enum:
            - admin-read-write
            - admin-read-only
            - object-read-write
            - object-read-only
          type: string
        prefixes:
          description: Optional prefix paths to scope the credentials to
          items:
            type: string
          type: array
        ttlSeconds:
          default: 900
          description: How long the credentials will live for in seconds
          maximum: 604800
          type: number
      required:
        - bucket
        - permission
        - ttlSeconds
        - parentAccessKeyId
      type: object
    r2_temp_access_creds_response:
      example:
        accessKeyId: example-access-key-id
        secretAccessKey: example-secret-key
        sessionToken: example-session-token
      properties:
        accessKeyId:
          description: ID for new access key
          type: string
        secretAccessKey:
          description: Secret access key
          type: string
        sessionToken:
          description: Security token
          type: string
      type: object
    r2_v4_response:
      properties:
        errors:
          $ref: '#/components/schemas/r2_errors'
        messages:
          $ref: '#/components/schemas/r2_messages'
        result:
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    r2_v4_response_failure:
      properties:
        errors:
          $ref: '#/components/schemas/r2_errors'
        messages:
          $ref: '#/components/schemas/r2_messages'
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    r2_v4_response_list:
      allOf:
        - $ref: '#/components/schemas/r2_v4_response'
        - properties:
            result_info:
              $ref: '#/components/schemas/r2_result_info'
          type: object
    registrar-api_address:
      description: Address.
      example: 123 Sesame St.
      type: string
    registrar-api_address2:
      description: Optional address line for unit, floor, suite, etc.
      example: Suite 430
      type: string
    registrar-api_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/registrar-api_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/registrar-api_result_info'
      type: object
    registrar-api_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/registrar-api_messages'
        messages:
          $ref: '#/components/schemas/registrar-api_messages'
        result:
          anyOf:
            - type: object
            - items:
                type: object
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    registrar-api_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/registrar-api_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/registrar-api_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    registrar-api_api-response-single:
      allOf:
        - $ref: '#/components/schemas/registrar-api_api-response-common'
        - properties:
            result:
              nullable: true
              type: object
      type: object
    registrar-api_auto_renew:
      description: Auto-renew controls whether subscription is automatically renewed upon domain expiration.
      example: true
      type: boolean
    registrar-api_available:
      description: Shows if a domain is available for transferring into Cloudflare Registrar.
      example: false
      type: boolean
    registrar-api_can_register:
      description: Indicates if the domain can be registered as a new domain.
      example: false
      type: boolean
    registrar-api_city:
      description: City.
      example: Austin
      type: string
    registrar-api_contact_identifier:
      description: Contact Identifier.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      readOnly: true
      type: string
    registrar-api_contact_properties:
      properties:
        address:
          $ref: '#/components/schemas/registrar-api_address'
        address2:
          $ref: '#/components/schemas/registrar-api_address2'
        city:
          $ref: '#/components/schemas/registrar-api_city'
        country:
          $ref: '#/components/schemas/registrar-api_country'
        email:
          $ref: '#/components/schemas/registrar-api_email'
        fax:
          $ref: '#/components/schemas/registrar-api_fax'
        first_name:
          $ref: '#/components/schemas/registrar-api_first_name'
        id:
          $ref: '#/components/schemas/registrar-api_contact_identifier'
        last_name:
          $ref: '#/components/schemas/registrar-api_last_name'
        organization:
          $ref: '#/components/schemas/registrar-api_organization'
        phone:
          $ref: '#/components/schemas/registrar-api_telephone'
        state:
          $ref: '#/components/schemas/registrar-api_state'
        zip:
          $ref: '#/components/schemas/registrar-api_zipcode'
      required:
        - first_name
        - last_name
        - address
        - city
        - state
        - zip
        - country
        - phone
        - organization
      type: object
    registrar-api_contacts:
      allOf:
        - $ref: '#/components/schemas/registrar-api_contact_properties'
      type: object
    registrar-api_country:
      description: The country in which the user lives.
      example: US
      maxLength: 30
      nullable: true
      type: string
    registrar-api_created_at:
      description: Shows time of creation.
      example: "2018-08-28T17:26:26Z"
      format: date-time
      type: string
    registrar-api_current_registrar:
      description: Shows name of current registrar.
      example: Cloudflare
      type: string
    registrar-api_domain_identifier:
      description: Domain identifier.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      readOnly: true
      type: string
    registrar-api_domain_name:
      description: Domain name.
      example: cloudflare.com
      type: string
    registrar-api_domain_properties:
      properties:
        available:
          $ref: '#/components/schemas/registrar-api_available'
        can_register:
          $ref: '#/components/schemas/registrar-api_can_register'
        created_at:
          $ref: '#/components/schemas/registrar-api_created_at'
        current_registrar:
          $ref: '#/components/schemas/registrar-api_current_registrar'
        expires_at:
          $ref: '#/components/schemas/registrar-api_expires_at'
        id:
          $ref: '#/components/schemas/registrar-api_domain_identifier'
        locked:
          $ref: '#/components/schemas/registrar-api_locked'
        registrant_contact:
          $ref: '#/components/schemas/registrar-api_registrant_contact'
        registry_statuses:
          $ref: '#/components/schemas/registrar-api_registry_statuses'
        supported_tld:
          $ref: '#/components/schemas/registrar-api_supported_tld'
        transfer_in:
          $ref: '#/components/schemas/registrar-api_transfer_in'
        updated_at:
          $ref: '#/components/schemas/registrar-api_updated_at'
      type: object
    registrar-api_domain_response_collection:
      allOf:
        - $ref: '#/components/schemas/registrar-api_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/registrar-api_domains'
              type: array
    registrar-api_domain_response_single:
      allOf:
        - $ref: '#/components/schemas/registrar-api_api-response-single'
        - properties:
            result:
              type: object
    registrar-api_domain_update_properties:
      properties:
        auto_renew:
          $ref: '#/components/schemas/registrar-api_auto_renew'
        locked:
          $ref: '#/components/schemas/registrar-api_locked'
        privacy:
          $ref: '#/components/schemas/registrar-api_privacy'
      type: object
    registrar-api_domains:
      allOf:
        - $ref: '#/components/schemas/registrar-api_domain_properties'
      type: object
    registrar-api_email:
      description: The contact email address of the user.
      example: user@example.com
      maxLength: 90
      type: string
    registrar-api_expires_at:
      description: Shows when domain name registration expires.
      example: "2019-08-28T23:59:59Z"
      format: date-time
      type: string
    registrar-api_fax:
      description: Contact fax number.
      example: 123-867-5309
      type: string
    registrar-api_first_name:
      description: User's first name
      example: John
      maxLength: 60
      nullable: true
      type: string
    registrar-api_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    registrar-api_last_name:
      description: User's last name
      example: Appleseed
      maxLength: 60
      nullable: true
      type: string
    registrar-api_locked:
      description: Shows whether a registrar lock is in place for a domain.
      example: false
      type: boolean
    registrar-api_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    registrar-api_organization:
      description: Name of organization.
      example: Cloudflare, Inc.
      type: string
    registrar-api_privacy:
      description: Privacy option controls redacting WHOIS information.
      example: true
      type: boolean
    registrar-api_registrant_contact:
      allOf:
        - $ref: '#/components/schemas/registrar-api_contacts'
      description: Shows contact information for domain registrant.
    registrar-api_registry_statuses:
      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
      type: string
    registrar-api_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    registrar-api_state:
      description: State.
      example: TX
      type: string
    registrar-api_supported_tld:
      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
      type: boolean
    registrar-api_telephone:
      description: User's telephone number
      example: +1 123-123-1234
      maxLength: 20
      nullable: true
      type: string
    registrar-api_transfer_in:
      description: Statuses for domain transfers into Cloudflare Registrar.
      properties:
        accept_foa:
          description: Form of authorization has been accepted by the registrant.
          enum:
            - needed
            - ok
          example: needed
          type: string
        approve_transfer:
          description: Shows transfer status with the registry.
          enum:
            - needed
            - ok
            - pending
            - trying
            - rejected
            - unknown
          example: unknown
          type: string
        can_cancel_transfer:
          description: Indicates if cancellation is still possible.
          example: true
          type: boolean
        disable_privacy:
          description: Privacy guards are disabled at the foreign registrar.
          enum:
            - needed
            - ok
            - unknown
          example: ok
          type: string
        enter_auth_code:
          description: Auth code has been entered and verified.
          enum:
            - needed
            - ok
            - pending
            - trying
            - rejected
          example: needed
          type: string
        unlock_domain:
          description: Domain is unlocked at the foreign registrar.
          enum:
            - needed
            - ok
            - pending
            - trying
            - unknown
          example: ok
          type: string
    registrar-api_updated_at:
      description: Last updated.
      example: "2018-08-28T17:26:26Z"
      format: date-time
      type: string
    registrar-api_zipcode:
      description: The zipcode or postal code where the user lives.
      example: "12345"
      maxLength: 20
      nullable: true
      type: string
    request-tracer_account_identifier:
      $ref: '#/components/schemas/request-tracer_identifier'
    request-tracer_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/request-tracer_messages'
        messages:
          $ref: '#/components/schemas/request-tracer_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    request-tracer_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/request-tracer_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/request-tracer_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    request-tracer_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    request-tracer_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    request-tracer_trace:
      items:
        description: List of steps acting on request/response
        properties:
          action:
            description: If step type is rule, then action performed by this rule
            example: execute
            pattern: ^[a-z_]+$
            type: string
          action_parameters:
            description: If step type is rule, then action parameters of this rule as JSON
            example:
              id: 4814384a9e5d4991b9815dcfc25d2f1f
            type: object
          description:
            description: If step type is rule or ruleset, the description of this entity
            example: some rule
            type: string
          expression:
            description: If step type is rule, then expression used to match for this rule
            example: ip.src ne 1.1.1.1
            type: string
          kind:
            description: If step type is ruleset, then kind of this ruleset
            example: zone
            type: string
          matched:
            description: Whether tracing step affected tracing request/response
            example: true
            type: boolean
          name:
            description: If step type is ruleset, then name of this ruleset
            example: some ruleset name
            type: string
          step_name:
            description: Tracing step identifying name
            example: rule_id01
            type: string
          trace:
            $ref: '#/components/schemas/request-tracer_trace'
          type:
            description: Tracing step type
            example: rule
            type: string
        type: object
      type: array
    rulesets_AccountId:
      description: The unique ID of the account.
      example: abf9b32d38c5f572afde3336ec0ce302
      pattern: ^[0-9a-f]{32}$
      title: ID
      type: string
    rulesets_BlockRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - block
            action_parameters:
              properties:
                response:
                  description: The response to show when the block is applied.
                  properties:
                    content:
                      description: The content to return.
                      example: |-
                        {
                          "success": false,
                          "error": "you have been blocked"
                        }
                      minLength: 1
                      title: Content
                      type: string
                    content_type:
                      description: The type of the content to return.
                      example: application/json
                      minLength: 1
                      title: Content type
                      type: string
                    status_code:
                      description: The status code to return.
                      maximum: 499
                      minimum: 400
                      title: Status code
                      type: integer
                  required:
                    - status_code
                    - content
                    - content_type
                  title: Response
                  type: object
            description:
              example: Block when the IP address is not 1.1.1.1
          title: Block rule
    rulesets_ChallengeRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - challenge
            description:
              example: Issue an Interactive Challenge if the visitor had not solved an Interactive Challenge prior to the request when the address is not 1.1.1.1
          title: Challenge rule
    rulesets_CompressResponseRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - compress_response
            action_parameters:
              properties:
                algorithms:
                  description: Custom order for compression algorithms.
                  example:
                    - name: none
                  items:
                    description: Compression algorithm to enable.
                    properties:
                      name:
                        description: Name of compression algorithm to enable.
                        enum:
                          - none
                          - auto
                          - default
                          - gzip
                          - brotli
                        title: Name
                        type: string
                    title: Compression Algorithm
                    type: object
                  title: Algorithm
                  type: array
            description:
              example: Disable compression when address is not 1.1.1.1
          title: Compression rule
    rulesets_DDoSDynamicRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - ddos_dynamic
            description:
              example: Performs a specific action according to a set of internal guidelines defined by Cloudflare.
          title: DDoS Dynamic rule
    rulesets_Errors:
      description: A list of error messages.
      items:
        $ref: '#/components/schemas/rulesets_Message'
      title: Errors
      type: array
    rulesets_ExecuteRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - execute
            action_parameters:
              properties:
                id:
                  allOf:
                    - $ref: '#/components/schemas/rulesets_RulesetId'
                    - description: The ID of the ruleset to execute.
                      example: 4814384a9e5d4991b9815dcfc25d2f1f
                matched_data:
                  description: The configuration to use for matched data logging.
                  properties:
                    public_key:
                      description: The public key to encrypt matched data logs with.
                      example: iGqBmyIUxuWt1rvxoAharN9FUXneUBxA/Y19PyyrEG0=
                      minLength: 1
                      title: Public key
                      type: string
                  required:
                    - public_key
                  title: Matched data
                  type: object
                overrides:
                  description: A set of overrides to apply to the target ruleset.
                  minProperties: 1
                  properties:
                    action:
                      allOf:
                        - $ref: '#/components/schemas/rulesets_RuleAction'
                        - description: An action to override all rules with. This option has lower precedence than rule and category overrides.
                          example: log
                    categories:
                      description: A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
                      items:
                        description: A category-level override
                        minProperties: 2
                        properties:
                          action:
                            allOf:
                              - $ref: '#/components/schemas/rulesets_RuleAction'
                              - description: The action to override rules in the category with.
                                example: log
                          category:
                            allOf:
                              - $ref: '#/components/schemas/rulesets_RuleCategory'
                              - description: The name of the category to override.
                          enabled:
                            allOf:
                              - $ref: '#/components/schemas/rulesets_RuleEnabled'
                              - description: Whether to enable execution of rules in the category.
                          sensitivity_level:
                            allOf:
                              - $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel'
                              - description: The sensitivity level to use for rules in the category.
                        required:
                          - category
                        title: Category override
                        type: object
                      minItems: 1
                      title: Category overrides
                      type: array
                      uniqueItems: true
                    enabled:
                      allOf:
                        - $ref: '#/components/schemas/rulesets_RuleEnabled'
                        - description: Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
                    rules:
                      description: A list of rule-level overrides. This option has the highest precedence.
                      items:
                        description: A rule-level override
                        minProperties: 2
                        properties:
                          action:
                            allOf:
                              - $ref: '#/components/schemas/rulesets_RuleAction'
                              - description: The action to override the rule with.
                                example: log
                          enabled:
                            allOf:
                              - $ref: '#/components/schemas/rulesets_RuleEnabled'
                              - description: Whether to enable execution of the rule.
                          id:
                            allOf:
                              - $ref: '#/components/schemas/rulesets_RuleId'
                              - description: The ID of the rule to override.
                                example: 8ac8bc2a661e475d940980f9317f28e1
                          score_threshold:
                            description: The score threshold to use for the rule.
                            title: Score threshold
                            type: integer
                          sensitivity_level:
                            allOf:
                              - $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel'
                              - description: The sensitivity level to use for the rule.
                        required:
                          - id
                        title: Rule override
                        type: object
                      minItems: 1
                      title: Rule overrides
                      type: array
                      uniqueItems: true
                    sensitivity_level:
                      allOf:
                        - $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel'
                        - description: A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases.
                  title: Overrides
                  type: object
              required:
                - id
            description:
              example: Execute the OWASP ruleset when the IP address is not 1.1.1.1
          title: Execute rule
    rulesets_ExecuteSensitivityLevel:
      enum:
        - default
        - medium
        - low
        - eoff
      title: Sensitivity level
      type: string
    rulesets_ForceConnectionCloseRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - force_connection_close
            description:
              example: Closes ongoing HTTP connections. This action does not block a request, but it forces the client to reconnect. For HTTP/2 and HTTP/3 connections, the connection will be closed even if it breaks other requests running on the same connection.
          title: Force Connection Close rule
    rulesets_JsChallengeRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - js_challenge
            description:
              example: Issue a non-interactive Javascript Challenge if the visitor had not solved a Interactive Challenge, Managed Challenge, or Javascript Challenge prior to the request when the address is not 1.1.1.1
          title: Javascript Challenge rule
    rulesets_LogCustomFieldRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - log_custom_field
            action_parameters:
              minProperties: 1
              properties:
                cookie_fields:
                  description: The cookie fields to log.
                  example:
                    - name: cookie_name_1
                  items:
                    description: The cookie field to log.
                    properties:
                      name:
                        description: The name of the field.
                        example: cookie_name_1
                        minLength: 1
                        title: Name
                        type: string
                    required:
                      - name
                    title: Cookie field
                    type: object
                  minItems: 1
                  title: Cookie fields
                  type: array
                request_fields:
                  description: The request fields to log.
                  example:
                    - name: http_request_header_name_1_in_lower_case
                  items:
                    description: The request field to log.
                    properties:
                      name:
                        description: The name of the field.
                        example: http_request_header_name_1_in_lower_case
                        minLength: 1
                        title: Name
                        type: string
                    required:
                      - name
                    title: Request field
                    type: object
                  minItems: 1
                  title: Request fields
                  type: array
                response_fields:
                  description: The response fields to log.
                  example:
                    - name: http_response_header_name_1_in_lower_case
                  items:
                    description: The response field to log.
                    properties:
                      name:
                        description: The name of the field.
                        example: http_response_header_name_1_in_lower_case
                        minLength: 1
                        title: Name
                        type: string
                    required:
                      - name
                    title: Response field
                    type: object
                  minItems: 1
                  title: Response fields
                  type: array
            description:
              example: Log custom field when the IP address is not 1.1.1.1
          title: Log Custom Field rule
    rulesets_LogRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - log
            description:
              example: Log when the IP address is not 1.1.1.1
          title: Log rule
    rulesets_ManagedChallengeRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - managed_challenge
            description:
              example: Issue a Managed Challenge if the visitor had not solved a Managed Challenge or Interactive Challenge prior to the request when the address is not 1.1.1.1
          title: Managed Challenge rule
    rulesets_Message:
      description: A message.
      properties:
        code:
          description: A unique code for this message.
          example: 10000
          title: Code
          type: integer
        message:
          description: A text description of this message.
          example: something bad happened
          minLength: 1
          title: Description
          type: string
        source:
          description: The source of this message.
          properties:
            pointer:
              description: A JSON pointer to the field that is the source of the message.
              example: /rules/0/action
              minLength: 1
              title: Pointer
              type: string
          required:
            - pointer
          title: Source
          type: object
      required:
        - message
      title: Message
      type: object
    rulesets_Messages:
      description: A list of warning messages.
      items:
        $ref: '#/components/schemas/rulesets_Message'
      title: Messages
      type: array
    rulesets_RedirectRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - redirect
            action_parameters:
              properties:
                from_list:
                  description: Serve a redirect based on a bulk list lookup.
                  properties:
                    key:
                      description: Expression that evaluates to the list lookup key.
                      example: http.request.full_uri
                      minLength: 1
                      title: Key
                      type: string
                    name:
                      description: The name of the list to match against.
                      example: list1
                      maxLength: 50
                      pattern: ^[a-zA-Z0-9_]+$
                      title: Name
                      type: string
                  title: Bulk Redirect
                  type: object
                from_value:
                  description: Serve a redirect based on the request properties.
                  properties:
                    preserve_query_string:
                      description: Keep the query string of the original request.
                      title: Preserve query string
                      type: boolean
                    status_code:
                      description: The status code to be used for the redirect.
                      enum:
                        - 301
                        - 302
                        - 303
                        - 307
                        - 308
                      title: Status Code
                      type: number
                    target_url:
                      description: The URL to redirect the request to.
                      example:
                        expression: concat("https://m.example.com", http.request.uri.path)
                      oneOf:
                        - properties:
                            value:
                              description: The URL to redirect the request to.
                              minLength: 1
                              type: string
                          title: Static URL redirect
                          type: object
                        - properties:
                            expression:
                              description: An expression to evaluate to get the URL to redirect the request to.
                              minLength: 1
                              type: string
                          title: Dynamic URL redirect
                          type: object
                  title: Single redirect
                  type: object
            description:
              example: Redirect when IP address is not 1.1.1.1
          title: Redirect rule
    rulesets_RequestRule:
      discriminator:
        mapping:
          block: '#/components/schemas/rulesets_BlockRule'
          challenge: '#/components/schemas/rulesets_ChallengeRule'
          compress_response: '#/components/schemas/rulesets_CompressResponseRule'
          ddos_dynamic: '#/components/schemas/rulesets_DDoSDynamicRule'
          execute: '#/components/schemas/rulesets_ExecuteRule'
          force_connection_close: '#/components/schemas/rulesets_ForceConnectionCloseRule'
          js_challenge: '#/components/schemas/rulesets_JsChallengeRule'
          log: '#/components/schemas/rulesets_LogRule'
          log_custom_field: '#/components/schemas/rulesets_LogCustomFieldRule'
          managed_challenge: '#/components/schemas/rulesets_ManagedChallengeRule'
          redirect: '#/components/schemas/rulesets_RedirectRule'
          rewrite: '#/components/schemas/rulesets_RewriteRule'
          route: '#/components/schemas/rulesets_RouteRule'
          score: '#/components/schemas/rulesets_ScoreRule'
          serve_error: '#/components/schemas/rulesets_ServeErrorRule'
          set_cache_settings: '#/components/schemas/rulesets_SetCacheSettingsRule'
          set_config: '#/components/schemas/rulesets_SetConfigRule'
          skip: '#/components/schemas/rulesets_SkipRule'
        propertyName: action
      oneOf:
        - $ref: '#/components/schemas/rulesets_BlockRule'
        - $ref: '#/components/schemas/rulesets_ChallengeRule'
        - $ref: '#/components/schemas/rulesets_CompressResponseRule'
        - $ref: '#/components/schemas/rulesets_ExecuteRule'
        - $ref: '#/components/schemas/rulesets_JsChallengeRule'
        - $ref: '#/components/schemas/rulesets_LogRule'
        - $ref: '#/components/schemas/rulesets_ManagedChallengeRule'
        - $ref: '#/components/schemas/rulesets_RedirectRule'
        - $ref: '#/components/schemas/rulesets_RewriteRule'
        - $ref: '#/components/schemas/rulesets_RouteRule'
        - $ref: '#/components/schemas/rulesets_ScoreRule'
        - $ref: '#/components/schemas/rulesets_ServeErrorRule'
        - $ref: '#/components/schemas/rulesets_SetConfigRule'
        - $ref: '#/components/schemas/rulesets_SkipRule'
        - $ref: '#/components/schemas/rulesets_SetCacheSettingsRule'
        - $ref: '#/components/schemas/rulesets_LogCustomFieldRule'
        - $ref: '#/components/schemas/rulesets_DDoSDynamicRule'
        - $ref: '#/components/schemas/rulesets_ForceConnectionCloseRule'
    rulesets_RequestRules:
      description: The list of rules in the ruleset.
      items:
        $ref: '#/components/schemas/rulesets_RequestRule'
      title: Rules
      type: array
    rulesets_Response:
      description: A response object.
      properties:
        errors:
          $ref: '#/components/schemas/rulesets_Errors'
        messages:
          $ref: '#/components/schemas/rulesets_Messages'
        result:
          description: A result.
          title: Result
        success:
          description: Whether the API call was successful.
          title: Success
          type: boolean
      required:
        - result
        - success
        - errors
        - messages
      title: Response
      type: object
    rulesets_ResponseRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_RequestRule'
        - required:
            - id
            - expression
            - action
            - ref
            - enabled
    rulesets_ResponseRules:
      description: The list of rules in the ruleset.
      items:
        $ref: '#/components/schemas/rulesets_ResponseRule'
      title: Rules
      type: array
    rulesets_RewriteRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - rewrite
            action_parameters:
              properties:
                headers:
                  additionalProperties:
                    oneOf:
                      - description: Remove the header from the request.
                        properties:
                          operation:
                            enum:
                              - remove
                            title: Operation
                            type: string
                        required:
                          - operation
                        title: Remove header
                        type: object
                      - description: Set a request header with a static value.
                        properties:
                          operation:
                            enum:
                              - set
                            title: Operation
                            type: string
                          value:
                            description: Static value for the header.
                            example: static-header-value
                            minLength: 1
                            title: Value
                            type: string
                        required:
                          - operation
                          - value
                        title: Static header
                        type: object
                      - description: Set a request header with a dynamic value.
                        properties:
                          expression:
                            description: Expression for the header value.
                            example: ip.src
                            minLength: 1
                            title: Expression
                            type: string
                          operation:
                            enum:
                              - set
                            title: Operation
                            type: string
                        required:
                          - operation
                          - expression
                        title: Dynamic header
                        type: object
                  description: Map of request headers to modify.
                  example:
                    client-http-version:
                      expression: http.request.version
                      operation: set
                  title: Headers
                  type: object
                uri:
                  description: URI to rewrite the request to.
                  properties:
                    path:
                      allOf:
                        - description: Path portion rewrite.
                          example:
                            expression: regex_replace(http.request.uri.path, "/bar$", "/baz")
                          title: Path
                        - $ref: '#/components/schemas/rulesets_RewriteUriPart'
                    query:
                      allOf:
                        - description: Query portion rewrite.
                          example:
                            expression: regex_replace(http.request.uri.query, "foo=bar", "")
                          title: Query
                        - $ref: '#/components/schemas/rulesets_RewriteUriPart'
                  title: URI
                  type: object
            description:
              example: Add a header when the IP address is not 1.1.1.1
          title: Rewrite rule
    rulesets_RewriteUriPart:
      oneOf:
        - properties:
            value:
              description: Predefined replacement value.
              example: /images
              minLength: 1
              type: string
          required:
            - value
          title: Static value
          type: object
        - properties:
            expression:
              description: Expression to evaluate for the replacement value.
              example: regex_replace(http.request.uri.path, "/bar$", "/baz")
              minLength: 1
              type: string
          required:
            - expression
          title: Dynamic value
          type: object
    rulesets_RouteRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - route
            action_parameters:
              properties:
                host_header:
                  description: Rewrite the HTTP Host header.
                  example: static.example.com
                  minLength: 1
                  title: Host Header
                  type: string
                origin:
                  description: Override the IP/TCP destination.
                  properties:
                    host:
                      description: Override the resolved hostname.
                      example: static.example.com
                      minLength: 1
                      title: DNS Record
                      type: string
                    port:
                      description: Override the destination port.
                      maximum: 65535
                      minimum: 1
                      title: Port
                      type: number
                  title: Origin
                  type: object
                sni:
                  description: Override the Server Name Indication (SNI).
                  properties:
                    value:
                      description: The SNI override.
                      example: static.example.com
                      minLength: 1
                      title: Value
                      type: string
                  required:
                    - value
                  title: SNI
                  type: object
            description:
              example: Select origin server when IP address is not 1.1.1.1
          title: Origin rule
    rulesets_Rule:
      properties:
        action:
          $ref: '#/components/schemas/rulesets_RuleAction'
        action_parameters:
          description: The parameters configuring the rule's action.
          title: Action parameters
          type: object
        categories:
          description: The categories of the rule.
          example:
            - directory-traversal
            - header
          items:
            $ref: '#/components/schemas/rulesets_RuleCategory'
          minItems: 1
          readOnly: true
          title: Categories
          type: array
          uniqueItems: true
        description:
          default: ""
          description: An informative description of the rule.
          title: Description
          type: string
        enabled:
          allOf:
            - $ref: '#/components/schemas/rulesets_RuleEnabled'
            - default: true
        expression:
          description: The expression defining which traffic will match the rule.
          example: ip.src ne 1.1.1.1
          minLength: 1
          title: Expression
          type: string
        id:
          $ref: '#/components/schemas/rulesets_RuleId'
        last_updated:
          description: The timestamp of when the rule was last modified.
          example: "2000-01-01T00:00:00.000000Z"
          format: date-time
          readOnly: true
          title: Last updated
          type: string
        logging:
          description: An object configuring the rule's logging behavior.
          properties:
            enabled:
              description: Whether to generate a log when the rule matches.
              example: true
              title: Enabled
              type: boolean
          required:
            - enabled
          title: Logging
          type: object
        ref:
          description: The reference of the rule (the rule ID by default).
          example: my_ref
          minLength: 1
          title: Ref
          type: string
        version:
          description: The version of the rule.
          example: "1"
          pattern: ^[0-9]+$
          readOnly: true
          title: Version
          type: string
      required:
        - version
        - last_updated
      title: Rule
      type: object
    rulesets_RuleAction:
      description: The action to perform when the rule matches.
      pattern: ^[a-z]+$
      title: Action
      type: string
    rulesets_RuleCategory:
      description: A category of the rule.
      example: directory-traversal
      minLength: 1
      title: Category
      type: string
    rulesets_RuleEnabled:
      description: Whether the rule should be executed.
      example: true
      title: Enabled
      type: boolean
    rulesets_RuleId:
      description: The unique ID of the rule.
      example: 3a03d665bac047339bb530ecb439a90d
      pattern: ^[0-9a-f]{32}$
      title: ID
      type: string
    rulesets_RulePosition:
      description: An object configuring where the rule will be placed.
      title: Position
      type: object
    rulesets_Ruleset:
      description: A ruleset object.
      properties:
        description:
          default: ""
          description: An informative description of the ruleset.
          example: My ruleset to execute managed rulesets
          title: Description
          type: string
        id:
          allOf:
            - $ref: '#/components/schemas/rulesets_RulesetId'
            - readOnly: true
        last_updated:
          description: The timestamp of when the ruleset was last modified.
          example: "2000-01-01T00:00:00.000000Z"
          format: date-time
          readOnly: true
          title: Last updated
          type: string
        name:
          description: The human-readable name of the ruleset.
          example: My ruleset
          minLength: 1
          title: Name
          type: string
        version:
          $ref: '#/components/schemas/rulesets_RulesetVersion'
      required:
        - id
        - version
        - last_updated
      title: Ruleset
      type: object
    rulesets_RulesetId:
      description: The unique ID of the ruleset.
      example: 2f2feab2026849078ba485f918791bdc
      pattern: ^[0-9a-f]{32}$
      title: ID
      type: string
    rulesets_RulesetKind:
      description: The kind of the ruleset.
      enum:
        - managed
        - custom
        - root
        - zone
      example: root
      title: Kind
      type: string
    rulesets_RulesetPhase:
      description: The phase of the ruleset.
      enum:
        - ddos_l4
        - ddos_l7
        - http_config_settings
        - http_custom_errors
        - http_log_custom_fields
        - http_ratelimit
        - http_request_cache_settings
        - http_request_dynamic_redirect
        - http_request_firewall_custom
        - http_request_firewall_managed
        - http_request_late_transform
        - http_request_origin
        - http_request_redirect
        - http_request_sanitize
        - http_request_sbfm
        - http_request_select_configuration
        - http_request_transform
        - http_response_compression
        - http_response_firewall_managed
        - http_response_headers_transform
        - magic_transit
        - magic_transit_ids_managed
        - magic_transit_managed
        - magic_transit_ratelimit
      example: http_request_firewall_custom
      title: Phase
      type: string
    rulesets_RulesetVersion:
      description: The version of the ruleset.
      example: "1"
      pattern: ^[0-9]+$
      readOnly: true
      title: Version
      type: string
    rulesets_ScoreRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - score
            action_parameters:
              example:
                increment: 3
              minProperties: 1
              properties:
                increment:
                  description: Increment contains the delta to change the score and can be either positive or negative.
                  example: 3
                  title: Increment
                  type: integer
            description:
              example: Increment score when the IP address is not 1.1.1.1
          title: Score rule
    rulesets_ServeErrorRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - serve_error
            action_parameters:
              properties:
                content:
                  description: Error response content.
                  example: |
                    {"error": "1xxx error occurred"}
                  maxLength: 10240
                  minLength: 1
                  title: Content
                  type: string
                content_type:
                  description: Content-type header to set with the response.
                  enum:
                    - application/json
                    - text/xml
                    - text/plain
                    - text/html
                  example: application/json
                  title: Content Type
                  type: string
                status_code:
                  description: The status code to use for the error.
                  example: 500
                  maximum: 999
                  minimum: 400
                  title: Status Code
                  type: number
            description:
              example: Serve a JSON response to api users on error
          title: Serve Error rule
    rulesets_SetCacheSettingsRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - set_cache_settings
            action_parameters:
              properties:
                additional_cacheable_ports:
                  description: List of additional ports that caching can be enabled on.
                  items:
                    description: A port to enable caching on
                    title: Additional Cacheable Port
                    type: integer
                  title: Additional Cacheable Ports (Enterprise-only)
                  type: array
                browser_ttl:
                  description: Specify how long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.
                  example: |-
                    {
                        "mode": "override_origin",
                        "default": 1000
                    }
                  properties:
                    default:
                      description: The TTL (in seconds) if you choose override_origin mode.
                      title: Default TTL
                      type: integer
                    mode:
                      description: Determines which browser ttl mode to use.
                      enum:
                        - respect_origin
                        - bypass_by_default
                        - override_origin
                      title: Mode
                      type: string
                  required:
                    - mode
                  title: Browser TTL
                  type: object
                cache:
                  description: Mark whether the request’s response from origin is eligible for caching. Caching itself will still depend on the cache-control header and your other caching configurations.
                  title: Cache
                  type: boolean
                cache_key:
                  description: Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
                  properties:
                    cache_by_device_type:
                      description: Separate cached content based on the visitor’s device type
                      title: Cache by Device Type
                      type: boolean
                    cache_deception_armor:
                      description: Protect from web cache deception attacks while allowing static assets to be cached
                      title: Cache Deception Armor
                      type: boolean
                    custom_key:
                      description: Customize which components of the request are included or excluded from the cache key.
                      properties:
                        cookie:
                          description: The cookies to include in building the cache key.
                          properties:
                            check_presence:
                              description: Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
                              items:
                                description: A cookie name to check presence of.
                                title: Cookie name
                                type: string
                              title: Check presence of cookies
                              type: array
                            include:
                              description: Include these cookies' names and their values.
                              items:
                                description: Cookie name and corresponding value to include.
                                title: Cookie name
                                type: string
                              title: Include cookies
                              type: array
                          title: Cookie
                          type: object
                        header:
                          description: The header names and values to include in building the cache key.
                          properties:
                            check_presence:
                              description: Checks for the presence of these header names. The presence of these headers is used in building the cache key.
                              items:
                                description: A header name to check presence of.
                                title: Header name
                                type: string
                              title: Check presence of headers
                              type: array
                            contains:
                              additionalProperties:
                                description: Check if the corresponding header contains any of the values in the list.
                                items:
                                  type: string
                                title: Header values
                                type: array
                              description: For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
                              title: Header contains
                              type: object
                            exclude_origin:
                              description: Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
                              title: Exclude origin header
                              type: boolean
                            include:
                              description: Include these headers' names and their values.
                              items:
                                description: Header name and corresponding value to include.
                                title: Header name
                                type: string
                              title: Include headers
                              type: array
                          title: Headers
                          type: object
                        host:
                          description: Whether to use the original host or the resolved host in the cache key.
                          properties:
                            resolved:
                              description: Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.
                              example: true
                              title: Use Resolved host
                              type: boolean
                          title: Host
                          type: object
                        query_string:
                          description: Use the presence or absence of parameters in the query string to build the cache key.
                          properties:
                            exclude:
                              description: build the cache key using all query string parameters EXCECPT these excluded parameters
                              properties:
                                all:
                                  description: Exclude all query string parameters from use in building the cache key.
                                  title: All
                                  type: boolean
                                list:
                                  description: A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
                                  items:
                                    description: A parameter in the list of query string parameters excluded from use in building a cache key.
                                    title: parameter
                                    type: string
                                  title: List
                                  type: array
                              title: Excluded query string parameters
                              type: object
                            include:
                              description: build the cache key using a list of query string parameters that ARE in the request.
                              properties:
                                all:
                                  description: Use all query string parameters in the cache key.
                                  title: All
                                  type: boolean
                                list:
                                  description: A list of query string parameters used to build the cache key.
                                  items:
                                    description: parameter to include in the list of query string parameters used to build a cache key.
                                    title: parameter
                                    type: string
                                  title: List
                                  type: array
                              title: Included query string parameters
                              type: object
                          title: Query String
                          type: object
                        user:
                          description: Characteristics of the request user agent used in building the cache key.
                          properties:
                            device_type:
                              description: Use the user agent's device type in the cache key.
                              title: Device Type
                              type: boolean
                            geo:
                              description: Use the user agents's country in the cache key.
                              title: Country
                              type: boolean
                            lang:
                              description: Use the user agent's language in the cache key.
                              title: Language
                              type: boolean
                          title: User
                          type: object
                      title: Custom Key
                      type: object
                    ignore_query_strings_order:
                      description: Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.
                      title: Ignore Query Strings Order
                      type: boolean
                  title: Cache Key
                  type: object
                cache_reserve:
                  description: Mark whether the request's response from origin is eligible for  Cache Reserve (requires a Cache Reserve add-on plan).
                  properties:
                    eligible:
                      description: Determines whether cache reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to cache reserve.
                      example: |-
                        {
                            "eligible": true,
                            "minimum_file_size": 100000
                        }
                      title: Eligible
                      type: boolean
                    minimum_file_size:
                      description: The minimum file size eligible for store in cache reserve.
                      title: Minimum File Size
                      type: integer
                  required:
                    - eligible
                    - minimum_file_size
                  title: CacheReserve
                  type: object
                edge_ttl:
                  description: TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
                  example: |-
                    {
                        "status_code_ttl": [
                            {
                                "status_code_range": {
                                    "to": 299
                                },
                                "value": 86400
                            },
                            {
                                "status_code_range": {
                                    "from": 300,
                                    "to": 499
                                },
                                "value": 0
                            },
                            {
                                "status_code_range": {
                                    "from": 500
                                },
                                "value": -1
                            }
                        ],
                        "mode": "respect_origin"
                    }
                  properties:
                    default:
                      description: The TTL (in seconds) if you choose override_origin mode.
                      maximum: 9.223372036854774e+18
                      minimum: 0
                      title: Default
                      type: integer
                    mode:
                      description: edge ttl options
                      enum:
                        - respect_origin
                        - bypass_by_default
                        - override_origin
                      title: Mode
                      type: string
                    status_code_ttl:
                      description: List of single status codes, or status code ranges to apply the selected mode
                      items:
                        description: Specify how long Cloudflare should cache the response based on the status code from the origin. Can be a single status code or a range or status codes
                        properties:
                          status_code_range:
                            description: The range of status codes used to apply the selected mode.
                            properties:
                              from:
                                description: response status code lower bound
                                title: Status Code lower bound
                                type: integer
                              to:
                                description: response status code upper bound
                                title: Status Code upper bound
                                type: integer
                            required:
                              - from
                              - to
                            title: Status Code Range
                            type: object
                          status_code_value:
                            description: Set the ttl for responses with this specific status code
                            title: Status Code Value
                            type: integer
                          value:
                            description: Time to cache a response (in seconds). A value of 0 is equivalent to setting the Cache-Control header with the value "no-cache". A value of -1 is equivalent to setting Cache-Control header with the value of "no-store".
                            title: TTL value
                            type: integer
                        required:
                          - value
                        title: Status Code TTL
                        type: object
                      title: Status Code TTLs
                      type: array
                  required:
                    - mode
                    - default
                    - status_code_ttl
                  title: Edge TTL
                  type: object
                origin_cache_control:
                  description: When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
                  title: Origin Cache Control (Enterprise-only)
                  type: boolean
                origin_error_page_passthru:
                  description: Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
                  title: Origin Error Page Passthru
                  type: boolean
                read_timeout:
                  description: Define a timeout value between two successive read operations to your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value.
                  example: 900
                  title: Read Timeout (Enterprise-only)
                  type: integer
                respect_strong_etags:
                  description: Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, Cloudflare converts strong ETag headers to weak ETag headers.
                  title: Respect Strong Etags
                  type: boolean
                serve_stale:
                  description: Define if Cloudflare should serve stale content while getting the latest content from the origin. If on, Cloudflare will not serve stale content while getting the latest content from the origin.
                  properties:
                    disable_stale_while_updating:
                      description: Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.
                      title: Disable Stale While Updating
                      type: boolean
                  required:
                    - disable_stale_while_updating
                  title: Serve Stale
                  type: object
            description:
              example: Set cache settings when the hostname  address is not example.com
          title: Set Cache Settings rule
    rulesets_SetConfigRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - set_config
            action_parameters:
              properties:
                automatic_https_rewrites:
                  description: Turn on or off Automatic HTTPS Rewrites.
                  title: Automatic HTTPS rewrites
                  type: boolean
                autominify:
                  description: Select which file extensions to minify automatically.
                  properties:
                    css:
                      description: Minify CSS files.
                      title: CSS
                      type: boolean
                    html:
                      description: Minify HTML files.
                      title: HTML
                      type: boolean
                    js:
                      description: Minify JS files.
                      title: JS
                      type: boolean
                  title: Auto Minify
                  type: object
                bic:
                  description: Turn on or off Browser Integrity Check.
                  title: Browser Integrity Check
                  type: boolean
                disable_apps:
                  description: Turn off all active Cloudflare Apps.
                  enum:
                    - true
                  title: Disable Apps
                  type: boolean
                disable_rum:
                  description: Turn off Real User Monitoring (RUM).
                  enum:
                    - true
                  title: Disable RUM
                  type: boolean
                disable_zaraz:
                  description: Turn off Zaraz.
                  enum:
                    - true
                  title: Disable Zaraz
                  type: boolean
                email_obfuscation:
                  description: Turn on or off Email Obfuscation.
                  title: Email Obfuscation
                  type: boolean
                fonts:
                  description: Turn on or off Cloudflare Fonts.
                  title: Cloudflare Fonts
                  type: boolean
                hotlink_protection:
                  description: Turn on or off the Hotlink Protection.
                  title: Hotlink Protection
                  type: boolean
                mirage:
                  description: Turn on or off Mirage.
                  title: Mirage
                  type: boolean
                opportunistic_encryption:
                  description: Turn on or off Opportunistic Encryption.
                  title: Opportunistic Encryption
                  type: boolean
                polish:
                  description: Configure the Polish level.
                  enum:
                    - "off"
                    - lossless
                    - lossy
                  title: Polish
                  type: string
                rocket_loader:
                  description: Turn on or off Rocket Loader
                  title: Rocket Loader
                  type: boolean
                security_level:
                  description: Configure the Security Level.
                  enum:
                    - "off"
                    - essentially_off
                    - low
                    - medium
                    - high
                    - under_attack
                  title: Security Level
                  type: string
                server_side_excludes:
                  description: Turn on or off Server Side Excludes.
                  title: Server Side Excludes
                  type: boolean
                ssl:
                  description: Configure the SSL level.
                  enum:
                    - "off"
                    - flexible
                    - full
                    - strict
                    - origin_pull
                  title: SSL
                  type: string
                sxg:
                  description: Turn on or off Signed Exchanges (SXG).
                  title: Signed Exchanges (SXG)
                  type: boolean
            description:
              example: Disable Zaraz when IP address is not 1.1.1.1
          title: Set Config Rule
    rulesets_SkipRule:
      allOf:
        - $ref: '#/components/schemas/rulesets_Rule'
        - properties:
            action:
              enum:
                - skip
            action_parameters:
              example:
                ruleset: current
              minProperties: 1
              properties:
                phases:
                  description: A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options.
                  items:
                    allOf:
                      - $ref: '#/components/schemas/rulesets_RulesetPhase'
                      - description: A phase to skip the execution of.
                  minItems: 1
                  title: Phases
                  type: array
                  uniqueItems: true
                products:
                  description: A list of legacy security products to skip the execution of.
                  items:
                    description: The name of a legacy security product to skip the execution of.
                    enum:
                      - bic
                      - hot
                      - rateLimit
                      - securityLevel
                      - uaBlock
                      - waf
                      - zoneLockdown
                    title: Product
                    type: string
                  minItems: 1
                  title: Products
                  type: array
                  uniqueItems: true
                rules:
                  additionalProperties:
                    description: A list of rule IDs in the ruleset to skip the execution of.
                    items:
                      allOf:
                        - $ref: '#/components/schemas/rulesets_RuleId'
                        - description: The ID of a rule in the ruleset to skip the execution of.
                          example: 8ac8bc2a661e475d940980f9317f28e1
                          title: Rule
                    minItems: 1
                    title: Rules
                    type: array
                    uniqueItems: true
                  description: A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option.
                  example:
                    4814384a9e5d4991b9815dcfc25d2f1f:
                      - 8ac8bc2a661e475d940980f9317f28e1
                  minProperties: 1
                  title: Rules
                  type: object
                ruleset:
                  description: A ruleset to skip the execution of. This option is incompatible with the rulesets, rules and phases options.
                  enum:
                    - current
                  title: Ruleset
                  type: string
                rulesets:
                  description: A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
                  items:
                    allOf:
                      - $ref: '#/components/schemas/rulesets_RulesetId'
                      - description: The ID of a ruleset to skip the execution of.
                        example: 4814384a9e5d4991b9815dcfc25d2f1f
                        title: Ruleset
                  minItems: 1
                  title: Rulesets
                  type: array
                  uniqueItems: true
            description:
              example: Skip the current ruleset when the IP address is not 1.1.1.1
          title: Skip rule
    rulesets_ZoneId:
      description: The unique ID of the zone.
      example: 9f1839b6152d298aca64c4e906b6d074
      pattern: ^[0-9a-f]{32}$
      title: ID
      type: string
    rulesets_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/rulesets_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/rulesets_result_info'
      type: object
    rulesets_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/rulesets_messages'
        messages:
          $ref: '#/components/schemas/rulesets_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    rulesets_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/rulesets_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/rulesets_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    rulesets_api-response-single:
      allOf:
        - $ref: '#/components/schemas/rulesets_api-response-common'
        - properties:
            result:
              anyOf:
                - type: object
                - type: string
      type: object
    rulesets_available:
      description: When true, the Managed Transform is available in the current Cloudflare plan.
      example: true
      type: boolean
    rulesets_custom_pages_response_collection:
      allOf:
        - $ref: '#/components/schemas/rulesets_api-response-collection'
        - properties:
            result:
              items:
                type: object
              type: array
    rulesets_custom_pages_response_single:
      allOf:
        - $ref: '#/components/schemas/rulesets_api-response-single'
        - properties:
            result:
              type: object
    rulesets_enabled:
      description: When true, the Managed Transform is enabled.
      example: true
      type: boolean
    rulesets_id:
      description: Human-readable identifier of the Managed Transform.
      example: add_cf-bot-score_header
      type: string
    rulesets_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    rulesets_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    rulesets_request_list:
      items:
        $ref: '#/components/schemas/rulesets_request_model'
      type: array
    rulesets_request_model:
      properties:
        enabled:
          $ref: '#/components/schemas/rulesets_enabled'
        id:
          $ref: '#/components/schemas/rulesets_id'
      type: object
    rulesets_response_list:
      items:
        $ref: '#/components/schemas/rulesets_response_model'
      type: array
    rulesets_response_model:
      properties:
        available:
          $ref: '#/components/schemas/rulesets_available'
        enabled:
          $ref: '#/components/schemas/rulesets_enabled'
        id:
          $ref: '#/components/schemas/rulesets_id'
      type: object
    rulesets_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    rulesets_schemas-request_model:
      properties:
        scope:
          $ref: '#/components/schemas/rulesets_scope'
        type:
          $ref: '#/components/schemas/rulesets_type'
      type: object
    rulesets_schemas-response_model:
      properties:
        scope:
          $ref: '#/components/schemas/rulesets_scope'
        type:
          $ref: '#/components/schemas/rulesets_type'
      type: object
    rulesets_scope:
      description: The scope of the URL normalization.
      example: incoming
      type: string
    rulesets_type:
      description: The type of URL normalization performed by Cloudflare.
      example: cloudflare
      type: string
    rum_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/rum_messages'
        messages:
          $ref: '#/components/schemas/rum_messages'
        success:
          description: Whether the API call was successful.
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    rum_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/rum_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/rum_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    rum_auto_install:
      description: If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
      example: true
      type: boolean
    rum_create-rule-request:
      properties:
        host:
          example: example.com
          type: string
        inclusive:
          description: Whether the rule includes or excludes traffic from being measured.
          example: true
          type: boolean
        is_paused:
          description: Whether the rule is paused or not.
          example: false
          type: boolean
        paths:
          example:
            - '*'
          items:
            type: string
          type: array
      type: object
    rum_create-site-request:
      properties:
        auto_install:
          $ref: '#/components/schemas/rum_auto_install'
        host:
          description: The hostname to use for gray-clouded sites.
          example: example.com
          type: string
        zone_tag:
          $ref: '#/components/schemas/rum_zone_tag'
      type: object
    rum_created:
      $ref: '#/components/schemas/rum_timestamp'
    rum_editable:
      example: true
      type: boolean
    rum_id:
      example: rum
      type: string
    rum_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    rum_is_host_regex:
      description: Whether to match the hostname using a regular expression.
      example: false
      type: boolean
    rum_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    rum_modify-rules-request:
      properties:
        delete_rules:
          description: A list of rule identifiers to delete.
          items:
            $ref: '#/components/schemas/rum_rule_identifier'
          type: array
        rules:
          description: A list of rules to create or update.
          items:
            properties:
              host:
                example: example.com
                type: string
              id:
                $ref: '#/components/schemas/rum_rule_identifier'
              inclusive:
                example: true
                type: boolean
              is_paused:
                example: false
                type: boolean
              paths:
                example:
                  - '*'
                items:
                  type: string
                type: array
            type: object
          type: array
      type: object
    rum_order_by:
      description: The property used to sort the list of results.
      enum:
        - host
        - created
      example: host
      type: string
    rum_page:
      description: Current page within the paginated list of results.
      example: 1
      type: number
    rum_per_page:
      description: Number of items to return per page of results.
      example: 10
      type: number
    rum_result_info:
      properties:
        count:
          description: The total number of items on the current page.
          example: 10
          type: integer
        page:
          description: Current page within the paginated list of results.
          example: 1
          type: integer
        per_page:
          description: The maximum number of items to return per page of results.
          example: 10
          type: integer
        total_count:
          description: The total number of items.
          example: 25
          type: integer
        total_pages:
          description: The total number of pages.
          example: 3
          nullable: true
          type: integer
      type: object
    rum_rule:
      properties:
        created:
          $ref: '#/components/schemas/rum_timestamp'
        host:
          description: The hostname the rule will be applied to.
          example: example.com
          type: string
        id:
          $ref: '#/components/schemas/rum_rule_identifier'
        inclusive:
          description: Whether the rule includes or excludes traffic from being measured.
          example: true
          type: boolean
        is_paused:
          description: Whether the rule is paused or not.
          example: false
          type: boolean
        paths:
          description: The paths the rule will be applied to.
          example:
            - '*'
          items:
            type: string
          type: array
        priority:
          example: 1000
          type: number
      type: object
    rum_rule-id-response-single:
      allOf:
        - $ref: '#/components/schemas/rum_api-response-common'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/rum_rule_identifier'
              type: object
    rum_rule-response-single:
      allOf:
        - $ref: '#/components/schemas/rum_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/rum_rule'
    rum_rule_identifier:
      description: The Web Analytics rule identifier.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      type: string
    rum_rules:
      description: A list of rules.
      items:
        $ref: '#/components/schemas/rum_rule'
      type: array
    rum_rules-response-collection:
      allOf:
        - $ref: '#/components/schemas/rum_api-response-common'
        - properties:
            result:
              properties:
                rules:
                  $ref: '#/components/schemas/rum_rules'
                ruleset:
                  $ref: '#/components/schemas/rum_ruleset'
              type: object
    rum_ruleset:
      properties:
        enabled:
          description: Whether the ruleset is enabled.
          example: true
          type: boolean
        id:
          $ref: '#/components/schemas/rum_ruleset_identifier'
        zone_name:
          example: example.com
          type: string
        zone_tag:
          $ref: '#/components/schemas/rum_zone_tag'
      type: object
    rum_ruleset_identifier:
      description: The Web Analytics ruleset identifier.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      type: string
    rum_rum-site-response-single:
      allOf:
        - $ref: '#/components/schemas/rum_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/rum_rum_site'
    rum_rum_site:
      properties:
        editable:
          $ref: '#/components/schemas/rum_editable'
        id:
          $ref: '#/components/schemas/rum_id'
        value:
          $ref: '#/components/schemas/rum_value'
      type: object
    rum_site:
      properties:
        auto_install:
          $ref: '#/components/schemas/rum_auto_install'
        created:
          $ref: '#/components/schemas/rum_timestamp'
        rules:
          $ref: '#/components/schemas/rum_rules'
        ruleset:
          $ref: '#/components/schemas/rum_ruleset'
        site_tag:
          $ref: '#/components/schemas/rum_site_tag'
        site_token:
          $ref: '#/components/schemas/rum_site_token'
        snippet:
          $ref: '#/components/schemas/rum_snippet'
      type: object
    rum_site-response-single:
      allOf:
        - $ref: '#/components/schemas/rum_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/rum_site'
    rum_site-tag-response-single:
      allOf:
        - $ref: '#/components/schemas/rum_api-response-common'
        - properties:
            result:
              properties:
                site_tag:
                  $ref: '#/components/schemas/rum_site_tag'
              type: object
    rum_site_tag:
      description: The Web Analytics site identifier.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      type: string
    rum_site_token:
      description: The Web Analytics site token.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      type: string
    rum_sites-response-collection:
      allOf:
        - $ref: '#/components/schemas/rum_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/rum_site'
              type: array
            result_info:
              $ref: '#/components/schemas/rum_result_info'
    rum_snippet:
      description: Encoded JavaScript snippet.
      example: '<!-- Cloudflare Web Analytics --><script defer src=''https://static.cloudflareinsights.com/beacon.min.js'' data-cf-beacon=''{"token": "bc40a2d1b5834453aba85c1b9a3054da"}''></script><!-- End Cloudflare Web Analytics -->'
      type: string
    rum_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      readOnly: true
      type: string
    rum_toggle-rum-request:
      properties:
        value:
          description: Value can either be On or Off
          example: "on"
          type: string
      type: object
    rum_value:
      description: Current state of RUM. Returns On, Off, or Manual
      example: "on"
      type: string
    rum_zone_tag:
      description: The zone identifier.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      type: string
    secondary-dns_account_identifier:
      example: 01a7362d577a6c3019a474fd6f485823
      readOnly: true
      type: string
    secondary-dns_acl:
      properties:
        id:
          $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
        ip_range:
          $ref: '#/components/schemas/secondary-dns_ip_range'
        name:
          $ref: '#/components/schemas/secondary-dns_acl_components-schemas-name'
      required:
        - id
        - name
        - ip_range
      type: object
    secondary-dns_acl_components-schemas-name:
      description: The name of the acl.
      example: my-acl-1
      type: string
    secondary-dns_algo:
      description: TSIG algorithm.
      example: hmac-sha512.
      type: string
    secondary-dns_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/secondary-dns_result_info'
      type: object
    secondary-dns_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/secondary-dns_messages'
        messages:
          $ref: '#/components/schemas/secondary-dns_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    secondary-dns_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/secondary-dns_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/secondary-dns_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    secondary-dns_api-response-single:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-common'
      type: object
    secondary-dns_auto_refresh_seconds:
      description: |-
        How often should a secondary zone auto refresh regardless of DNS NOTIFY.
        Not applicable for primary zones.
      example: 86400
      type: number
    secondary-dns_components-schemas-id_response:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
              type: object
    secondary-dns_components-schemas-identifier:
      example: 23ff594956f20c2a721606e94745a8aa
      readOnly: true
      type: string
    secondary-dns_components-schemas-name:
      description: The name of the peer.
      example: my-peer-1
      type: string
    secondary-dns_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/secondary-dns_acl'
              type: array
    secondary-dns_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/secondary-dns_acl'
    secondary-dns_disable_transfer_response:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/secondary-dns_disable_transfer_result'
    secondary-dns_disable_transfer_result:
      description: The zone transfer status of a primary zone
      example: Disabled
      type: string
    secondary-dns_dns-secondary-secondary-zone:
      properties:
        auto_refresh_seconds:
          $ref: '#/components/schemas/secondary-dns_auto_refresh_seconds'
        id:
          $ref: '#/components/schemas/secondary-dns_identifier'
        name:
          $ref: '#/components/schemas/secondary-dns_name'
        peers:
          $ref: '#/components/schemas/secondary-dns_peers'
      required:
        - id
        - name
        - peers
        - auto_refresh_seconds
      type: object
    secondary-dns_enable_transfer_response:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/secondary-dns_enable_transfer_result'
    secondary-dns_enable_transfer_result:
      description: The zone transfer status of a primary zone
      example: Enabled
      type: string
    secondary-dns_force_response:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/secondary-dns_force_result'
    secondary-dns_force_result:
      description: When force_axfr query parameter is set to true, the response is a simple string
      example: OK
      type: string
    secondary-dns_id_response:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/secondary-dns_identifier'
              type: object
    secondary-dns_identifier:
      example: 269d8f4853475ca241c4e730be286b20
      readOnly: true
      type: string
    secondary-dns_ip:
      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
      type: string
    secondary-dns_ip_range:
      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
      type: string
    secondary-dns_ixfr_enable:
      description: Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.
      example: false
      type: boolean
    secondary-dns_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    secondary-dns_name:
      description: Zone name.
      example: www.example.com.
      type: string
    secondary-dns_peer:
      properties:
        id:
          $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
        ip:
          $ref: '#/components/schemas/secondary-dns_ip'
        ixfr_enable:
          $ref: '#/components/schemas/secondary-dns_ixfr_enable'
        name:
          $ref: '#/components/schemas/secondary-dns_components-schemas-name'
        port:
          $ref: '#/components/schemas/secondary-dns_port'
        tsig_id:
          $ref: '#/components/schemas/secondary-dns_tsig_id'
      required:
        - id
        - name
      type: object
    secondary-dns_peers:
      description: A list of peer tags.
      example:
        - 23ff594956f20c2a721606e94745a8aa
        - 00920f38ce07c2e2f4df50b1f61d4194
      items:
        $ref: '#/components/schemas/secondary-dns_identifier'
      type: array
    secondary-dns_port:
      description: DNS port of primary or secondary nameserver, depending on what zone this peer is linked to.
      example: 53
      type: number
    secondary-dns_response_collection:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/secondary-dns_tsig'
              type: array
    secondary-dns_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    secondary-dns_schemas-force_response:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/secondary-dns_schemas-force_result'
    secondary-dns_schemas-force_result:
      description: When force_notify query parameter is set to true, the response is a simple string
      example: OK
      type: string
    secondary-dns_schemas-id_response:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/secondary-dns_schemas-identifier'
              type: object
    secondary-dns_schemas-identifier:
      example: 69cd1e104af3e6ed3cb344f263fd0d5a
      readOnly: true
      type: string
    secondary-dns_schemas-name:
      description: TSIG key name.
      example: tsig.customer.cf.
      type: string
    secondary-dns_schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/secondary-dns_peer'
              type: array
    secondary-dns_schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/secondary-dns_peer'
    secondary-dns_secret:
      description: TSIG secret.
      example: caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c
      type: string
    secondary-dns_single_request_outgoing:
      properties:
        id:
          $ref: '#/components/schemas/secondary-dns_identifier'
        name:
          $ref: '#/components/schemas/secondary-dns_name'
        peers:
          $ref: '#/components/schemas/secondary-dns_peers'
      required:
        - id
        - name
        - peers
    secondary-dns_single_response:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/secondary-dns_tsig'
    secondary-dns_single_response_incoming:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-single'
        - properties:
            result:
              properties:
                auto_refresh_seconds:
                  $ref: '#/components/schemas/secondary-dns_auto_refresh_seconds'
                checked_time:
                  $ref: '#/components/schemas/secondary-dns_time'
                created_time:
                  $ref: '#/components/schemas/secondary-dns_time'
                id:
                  $ref: '#/components/schemas/secondary-dns_identifier'
                modified_time:
                  $ref: '#/components/schemas/secondary-dns_time'
                name:
                  $ref: '#/components/schemas/secondary-dns_name'
                peers:
                  $ref: '#/components/schemas/secondary-dns_peers'
                soa_serial:
                  $ref: '#/components/schemas/secondary-dns_soa_serial'
              type: object
    secondary-dns_single_response_outgoing:
      allOf:
        - $ref: '#/components/schemas/secondary-dns_api-response-single'
        - properties:
            result:
              properties:
                checked_time:
                  $ref: '#/components/schemas/secondary-dns_time'
                created_time:
                  $ref: '#/components/schemas/secondary-dns_time'
                id:
                  $ref: '#/components/schemas/secondary-dns_identifier'
                last_transferred_time:
                  $ref: '#/components/schemas/secondary-dns_time'
                name:
                  $ref: '#/components/schemas/secondary-dns_name'
                peers:
                  $ref: '#/components/schemas/secondary-dns_peers'
                soa_serial:
                  $ref: '#/components/schemas/secondary-dns_soa_serial'
              type: object
    secondary-dns_soa_serial:
      description: The serial number of the SOA for the given zone.
      example: 2.0191024e+09
      type: number
    secondary-dns_time:
      description: The time for a specific event.
      example: "2019-10-24T17:09:42.883908+01:00"
      type: string
    secondary-dns_tsig:
      properties:
        algo:
          $ref: '#/components/schemas/secondary-dns_algo'
        id:
          $ref: '#/components/schemas/secondary-dns_schemas-identifier'
        name:
          $ref: '#/components/schemas/secondary-dns_schemas-name'
        secret:
          $ref: '#/components/schemas/secondary-dns_secret'
      required:
        - id
        - name
        - secret
        - algo
      type: object
    secondary-dns_tsig_id:
      description: TSIG authentication will be used for zone transfer if configured.
      example: 69cd1e104af3e6ed3cb344f263fd0d5a
      type: string
    security-center_accountId:
      $ref: '#/components/schemas/security-center_identifier'
    security-center_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/security-center_messages'
        messages:
          $ref: '#/components/schemas/security-center_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    security-center_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/security-center_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/security-center_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    security-center_api-response-single:
      allOf:
        - $ref: '#/components/schemas/security-center_api-response-common'
      type: object
    security-center_count:
      description: Total number of results
      example: 1
      type: integer
    security-center_dismissed:
      example: false
      type: boolean
    security-center_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    security-center_issue:
      properties:
        dismissed:
          example: false
          type: boolean
        id:
          type: string
        issue_class:
          $ref: '#/components/schemas/security-center_issueClass'
        issue_type:
          $ref: '#/components/schemas/security-center_issueType'
        payload:
          type: object
        resolve_link:
          type: string
        resolve_text:
          type: string
        severity:
          enum:
            - Low
            - Moderate
            - Critical
          type: string
        since:
          format: date-time
          type: string
        subject:
          $ref: '#/components/schemas/security-center_subject'
        timestamp:
          format: date-time
          type: string
      type: object
    security-center_issueClass:
      example: always_use_https_not_enabled
      type: string
    security-center_issueClasses:
      example:
        - a_record_dangling
        - always_use_https_not_enabled
      items:
        $ref: '#/components/schemas/security-center_issueClass'
      type: array
    security-center_issueType:
      enum:
        - compliance_violation
        - email_security
        - exposed_infrastructure
        - insecure_configuration
        - weak_authentication
      type: string
    security-center_issueTypes:
      example:
        - compliance_violation
        - email_security
      items:
        $ref: '#/components/schemas/security-center_issueType'
      type: array
    security-center_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    security-center_page:
      description: Current page within paginated list of results
      example: 1
      type: integer
    security-center_perPage:
      description: Number of results per page of results
      example: 25
      maximum: 1000
      minimum: 1
      type: integer
    security-center_products:
      example:
        - access
        - dns
      items:
        type: string
      type: array
    security-center_securityTxt:
      properties:
        acknowledgments:
          example:
            - https://example.com/hall-of-fame.html
          items:
            format: uri
            type: string
          type: array
        canonical:
          example:
            - https://www.example.com/.well-known/security.txt
          items:
            format: uri
            type: string
          type: array
        contact:
          example:
            - mailto:security@example.com
            - tel:+1-201-555-0123
            - https://example.com/security-contact.html
          items:
            format: uri
            type: string
          type: array
        enabled:
          example: true
          type: boolean
        encryption:
          example:
            - https://example.com/pgp-key.txt
            - dns:5d2d37ab76d47d36._openpgpkey.example.com?type=OPENPGPKEY
            - openpgp4fpr:5f2de5521c63a801ab59ccb603d49de44b29100f
          items:
            format: uri
            type: string
          type: array
        expires:
          format: date-time
          type: string
        hiring:
          example:
            - https://example.com/jobs.html
          items:
            format: uri
            type: string
          type: array
        policy:
          example:
            - https://example.com/disclosure-policy.html
          items:
            format: uri
            type: string
          type: array
        preferredLanguages:
          example: en, es, fr
          type: string
      type: object
    security-center_severityQueryParam:
      example:
        - low
        - moderate
      items:
        enum:
          - low
          - moderate
          - critical
        type: string
      type: array
    security-center_subject:
      example: example.com
      type: string
    security-center_subjects:
      items:
        $ref: '#/components/schemas/security-center_subject'
      type: array
    security-center_valueCountsResponse:
      allOf:
        - $ref: '#/components/schemas/security-center_api-response-common'
        - properties:
            result:
              anyOf:
                - items:
                    properties:
                      count:
                        example: 1
                        type: integer
                      value:
                        type: string
                    type: object
                  type: array
    security-center_zoneId:
      $ref: '#/components/schemas/security-center_identifier'
    snippets_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/snippets_messages'
        messages:
          $ref: '#/components/schemas/snippets_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    snippets_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/snippets_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/snippets_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    snippets_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    snippets_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    snippets_rules:
      description: List of snippet rules
      items:
        properties:
          description:
            example: Rule description
            type: string
          enabled:
            example: true
            type: boolean
          expression:
            example: http.cookie eq "a=b"
            type: string
          snippet_name:
            $ref: '#/components/schemas/snippets_snippet_name'
        type: object
      type: array
    snippets_snippet:
      description: Snippet Information
      properties:
        created_on:
          description: Creation time of the snippet
          example: 2023-07-24-00:00:00
          type: string
        modified_on:
          description: Modification time of the snippet
          example: 2023-07-24-00:00:00
          type: string
        snippet_name:
          $ref: '#/components/schemas/snippets_snippet_name'
      type: object
    snippets_snippet_name:
      description: Snippet identifying name
      example: snippet_name_01
      pattern: ^[A-Za-z0-9_]+$
      type: string
    snippets_zone_identifier:
      $ref: '#/components/schemas/snippets_identifier'
    spectrum-analytics_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/spectrum-analytics_messages'
        messages:
          $ref: '#/components/schemas/spectrum-analytics_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    spectrum-analytics_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/spectrum-analytics_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/spectrum-analytics_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    spectrum-analytics_api-response-single:
      allOf:
        - $ref: '#/components/schemas/spectrum-analytics_api-response-common'
      type: object
    spectrum-analytics_app_id_param:
      description: Comma-delimited list of Spectrum Application Id(s). If provided, the response will be limited to Spectrum Application Id(s) that match.
      example: ea95132c15732412d22c1476fa83f27a,d122c5f4bb71e25cc9e86ab43b142e2f
      type: string
    spectrum-analytics_column:
      properties:
        dimensions:
          items:
            type: string
          type: array
        metrics:
          oneOf:
            - items:
                type: number
              type: array
            - items:
                items:
                  type: number
                type: array
              type: array
      type: object
    spectrum-analytics_dimensions:
      description: "Can be used to break down the data by given attributes. Options are: \n\nDimension                 | Name                            | Example\n--------------------------|---------------------------------|--------------------------\nevent                     | Connection Event                | connect, progress, disconnect, originError, clientFiltered\nappID                     | Application ID                  | 40d67c87c6cd4b889a4fd57805225e85\ncoloName                  | Colo Name                       | SFO\nipVersion                 | IP version used by the client   | 4, 6."
      example:
        - event
        - appID
      items:
        enum:
          - event
          - appID
          - coloName
          - ipVersion
        type: string
      type: array
    spectrum-analytics_filters:
      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:

        Operator                  | Name                            | URL Encoded
        --------------------------|---------------------------------|--------------------------
        ==                        | Equals                          | %3D%3D
        !=                        | Does not equals                 | !%3D
        \>                        | Greater Than                    | %3E
        \<                        | Less Than                       | %3C
        \>=                       | Greater than or equal to        | %3E%3D
        \<=                       | Less than or equal to           | %3C%3D
      example: event==disconnect%20AND%20coloName!=SFO
      type: string
    spectrum-analytics_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    spectrum-analytics_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    spectrum-analytics_metrics:
      description: "One or more metrics to compute. Options are: \n\nMetric                    | Name                                | Example                  | Unit\n--------------------------|-------------------------------------|--------------------------|--------------------------\ncount                     | Count of total events               | 1000                     | Count\nbytesIngress              | Sum of ingress bytes                | 1000                     | Sum\nbytesEgress               | Sum of egress bytes                 | 1000                     | Sum\ndurationAvg               | Average connection duration         | 1.0                      | Time in milliseconds\ndurationMedian            | Median connection duration          | 1.0                      | Time in milliseconds\nduration90th              | 90th percentile connection duration | 1.0                      | Time in milliseconds\nduration99th              | 99th percentile connection duration | 1.0                      | Time in milliseconds."
      example:
        - count
        - bytesIngress
      items:
        enum:
          - count
          - bytesIngress
          - bytesEgress
          - durationAvg
          - durationMedian
          - duration90th
          - duration99th
        type: string
      type: array
    spectrum-analytics_query:
      properties:
        dimensions:
          $ref: '#/components/schemas/spectrum-analytics_dimensions'
        filters:
          $ref: '#/components/schemas/spectrum-analytics_filters'
        limit:
          description: Limit number of returned metrics.
          type: number
        metrics:
          $ref: '#/components/schemas/spectrum-analytics_metrics'
        since:
          $ref: '#/components/schemas/spectrum-analytics_since'
        sort:
          $ref: '#/components/schemas/spectrum-analytics_sort'
        until:
          $ref: '#/components/schemas/spectrum-analytics_until'
      type: object
    spectrum-analytics_query-response-aggregate:
      allOf:
        - $ref: '#/components/schemas/spectrum-analytics_api-response-single'
        - properties:
            result:
              items:
                properties:
                  appID:
                    allOf:
                      - description: Application identifier.
                      - $ref: '#/components/schemas/spectrum-analytics_identifier'
                  bytesEgress:
                    description: Number of bytes sent
                    type: number
                  bytesIngress:
                    description: Number of bytes received
                    type: number
                  connections:
                    description: Number of connections
                    type: number
                  durationAvg:
                    description: Average duration of connections
                    type: number
                required:
                  - appID
                  - bytesIngress
                  - bytesEgress
                  - connections
                  - durationAvg
                type: object
              type: array
    spectrum-analytics_query-response-single:
      allOf:
        - $ref: '#/components/schemas/spectrum-analytics_api-response-single'
        - properties:
            result:
              properties:
                data:
                  description: List of columns returned by the analytics query.
                  items:
                    $ref: '#/components/schemas/spectrum-analytics_column'
                  type: array
                data_lag:
                  description: Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.
                  example: 3
                  minimum: 0
                  type: number
                max:
                  allOf:
                    - description: Maximum result for each selected metrics across all data.
                    - $ref: '#/components/schemas/spectrum-analytics_stat'
                min:
                  allOf:
                    - description: Minimum result for each selected metrics across all data.
                    - $ref: '#/components/schemas/spectrum-analytics_stat'
                query:
                  $ref: '#/components/schemas/spectrum-analytics_query'
                rows:
                  description: Total number of rows in the result.
                  example: 5
                  minimum: 0
                  type: number
                time_intervals:
                  description: 'List of time interval buckets: [start, end]'
                  items:
                    items:
                      $ref: '#/components/schemas/spectrum-analytics_timestamp'
                    type: array
                  type: array
                totals:
                  allOf:
                    - description: Total result for each selected metrics across all data.
                    - $ref: '#/components/schemas/spectrum-analytics_stat'
              required:
                - rows
                - data
                - data_lag
                - min
                - max
                - totals
                - query
              type: object
    spectrum-analytics_since:
      allOf:
        - description: Start of time interval to query, defaults to `until` - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
        - $ref: '#/components/schemas/spectrum-analytics_timestamp'
    spectrum-analytics_sort:
      description: The sort order for the result set; sort fields must be included in `metrics` or `dimensions`.
      example:
        - +count
        - -bytesIngress
      items:
        type: string
      type: array
    spectrum-analytics_stat:
      additionalProperties:
        type: number
      example:
        bytesEgress: 100
        bytesIngress: 50
      type: object
    spectrum-analytics_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      type: string
    spectrum-analytics_until:
      allOf:
        - description: End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
        - $ref: '#/components/schemas/spectrum-analytics_timestamp'
    spectrum-config_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/spectrum-config_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/spectrum-config_result_info'
      type: object
    spectrum-config_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/spectrum-config_messages'
        messages:
          $ref: '#/components/schemas/spectrum-config_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    spectrum-config_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/spectrum-config_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/spectrum-config_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    spectrum-config_api-response-single:
      allOf:
        - $ref: '#/components/schemas/spectrum-config_api-response-common'
      type: object
    spectrum-config_api-response-single-id:
      allOf:
        - $ref: '#/components/schemas/spectrum-config_api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                id:
                  $ref: '#/components/schemas/spectrum-config_identifier'
              required:
                - id
              type: object
      type: object
    spectrum-config_app_config:
      allOf:
        - $ref: '#/components/schemas/spectrum-config_base_app_config'
        - properties:
            argo_smart_routing:
              $ref: '#/components/schemas/spectrum-config_argo_smart_routing'
            dns:
              $ref: '#/components/schemas/spectrum-config_dns'
            edge_ips:
              $ref: '#/components/schemas/spectrum-config_edge_ips'
            ip_firewall:
              $ref: '#/components/schemas/spectrum-config_ip_firewall'
            origin_direct:
              $ref: '#/components/schemas/spectrum-config_origin_direct'
            origin_dns:
              $ref: '#/components/schemas/spectrum-config_origin_dns'
            origin_port:
              $ref: '#/components/schemas/spectrum-config_origin_port'
            protocol:
              $ref: '#/components/schemas/spectrum-config_protocol'
            proxy_protocol:
              $ref: '#/components/schemas/spectrum-config_proxy_protocol'
            tls:
              $ref: '#/components/schemas/spectrum-config_tls'
            traffic_type:
              $ref: '#/components/schemas/spectrum-config_traffic_type'
          required:
            - protocol
            - dns
            - ip_firewall
            - proxy_protocol
            - tls
            - traffic_type
          type: object
    spectrum-config_app_config_collection:
      allOf:
        - $ref: '#/components/schemas/spectrum-config_api-response-collection'
        - properties:
            result:
              oneOf:
                - items:
                    $ref: '#/components/schemas/spectrum-config_app_config'
                  type: array
                - items:
                    $ref: '#/components/schemas/spectrum-config_paygo_app_config'
                  type: array
    spectrum-config_app_config_single:
      allOf:
        - $ref: '#/components/schemas/spectrum-config_api-response-single'
        - properties:
            result:
              oneOf:
                - $ref: '#/components/schemas/spectrum-config_app_config'
                - $ref: '#/components/schemas/spectrum-config_paygo_app_config'
    spectrum-config_app_identifier:
      allOf:
        - description: App identifier.
        - readOnly: true
        - $ref: '#/components/schemas/spectrum-config_identifier'
    spectrum-config_argo_smart_routing:
      default: false
      description: |-
        Enables Argo Smart Routing for this application.
        Notes: Only available for TCP applications with traffic_type set to "direct".
      example: true
      type: boolean
    spectrum-config_base_app_config:
      properties:
        created_on:
          $ref: '#/components/schemas/spectrum-config_created'
        id:
          $ref: '#/components/schemas/spectrum-config_app_identifier'
        modified_on:
          $ref: '#/components/schemas/spectrum-config_modified'
      required:
        - id
        - created_on
        - modified_on
      type: object
    spectrum-config_created:
      allOf:
        - description: When the Application was created.
        - readOnly: true
        - $ref: '#/components/schemas/spectrum-config_timestamp'
    spectrum-config_dns:
      description: The name and type of DNS record for the Spectrum application.
      properties:
        name:
          $ref: '#/components/schemas/spectrum-config_dns_name'
        type:
          $ref: '#/components/schemas/spectrum-config_dns_type'
      type: object
    spectrum-config_dns_name:
      description: The name of the DNS record associated with the application.
      example: ssh.example.com
      format: hostname
      type: string
    spectrum-config_dns_ttl:
      description: The TTL of our resolution of your DNS record in seconds.
      minimum: 600
      type: integer
    spectrum-config_dns_type:
      description: The type of DNS record associated with the application.
      enum:
        - CNAME
        - ADDRESS
      example: CNAME
      type: string
    spectrum-config_edge_ips:
      default:
        connectivity: all
        type: dynamic
      description: The anycast edge IP configuration for the hostname of this application.
      oneOf:
        - properties:
            connectivity:
              description: The IP versions supported for inbound connections on Spectrum anycast IPs.
              enum:
                - all
                - ipv4
                - ipv6
              example: all
              type: string
            type:
              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: string
          type: object
        - properties:
            ips:
              description: The array of customer owned IPs we broadcast via anycast for this hostname and application.
              example:
                - 192.0.2.1
              items:
                description: Edge anycast IPs.
                example: 192.0.2.1
                type: string
              type: array
            type:
              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
              type: string
          type: object
    spectrum-config_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    spectrum-config_ip_firewall:
      description: |-
        Enables IP Access Rules for this application.
        Notes: Only available for TCP applications.
      example: true
      type: boolean
    spectrum-config_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    spectrum-config_modified:
      allOf:
        - description: When the Application was last modified.
        - readOnly: true
        - $ref: '#/components/schemas/spectrum-config_timestamp'
    spectrum-config_origin_direct:
      description: List of origin IP addresses. Array may contain multiple IP addresses for load balancing.
      items:
        example: tcp://127.0.0.1:8080
        format: URI
        type: string
      type: array
    spectrum-config_origin_dns:
      description: The name and type of DNS record for the Spectrum application.
      properties:
        name:
          $ref: '#/components/schemas/spectrum-config_origin_dns_name'
        ttl:
          $ref: '#/components/schemas/spectrum-config_dns_ttl'
        type:
          $ref: '#/components/schemas/spectrum-config_origin_dns_type'
      type: object
    spectrum-config_origin_dns_name:
      description: The name of the DNS record associated with the origin.
      example: origin.example.com
      format: hostname
      type: string
    spectrum-config_origin_dns_type:
      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: ""
      type: string
    spectrum-config_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
      maximum: 65535
      minimum: 1
    spectrum-config_paygo_app_config:
      allOf:
        - $ref: '#/components/schemas/spectrum-config_base_app_config'
        - properties:
            dns:
              $ref: '#/components/schemas/spectrum-config_dns'
            origin_direct:
              $ref: '#/components/schemas/spectrum-config_origin_direct'
            protocol:
              $ref: '#/components/schemas/spectrum-config_protocol'
          required:
            - protocol
            - dns
          type: object
    spectrum-config_protocol:
      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
      type: string
    spectrum-config_proxy_protocol:
      default: "off"
      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
      example: "off"
      type: string
    spectrum-config_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    spectrum-config_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      type: string
    spectrum-config_tls:
      description: The type of TLS termination associated with the application.
      enum:
        - "off"
        - flexible
        - full
        - strict
      example: full
      type: string
    spectrum-config_traffic_type:
      default: direct
      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
      example: direct
      type: string
    spectrum-config_update_app_config:
      oneOf:
        - $ref: '#/components/schemas/spectrum-config_app_config'
        - $ref: '#/components/schemas/spectrum-config_paygo_app_config'
    spectrum-config_zone_identifier:
      allOf:
        - description: Zone identifier.
        - readOnly: true
        - $ref: '#/components/schemas/spectrum-config_identifier'
    speed_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/speed_messages'
        messages:
          $ref: '#/components/schemas/speed_messages'
        success:
          description: Whether the API call was successful
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    speed_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/speed_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/speed_messages'
          example: []
        result:
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    speed_api-response-single-id:
      allOf:
        - $ref: '#/components/schemas/speed_api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                id:
                  $ref: '#/components/schemas/speed_identifier'
              required:
                - id
              type: object
      type: object
    speed_base:
      properties:
        editable:
          default: true
          description: Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).
          enum:
            - true
            - false
          readOnly: true
          type: boolean
        id:
          description: Identifier of the zone setting.
          example: development_mode
          type: string
        modified_on:
          description: last time this setting was modified.
          example: "2014-01-01T05:20:00.12345Z"
          format: date-time
          nullable: true
          readOnly: true
          type: string
        value:
          description: Current value of the zone setting.
          enum:
            - "on"
            - "off"
          example: "on"
          type: string
    speed_cloudflare_fonts:
      allOf:
        - $ref: '#/components/schemas/speed_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - fonts
              example: fonts
            value:
              $ref: '#/components/schemas/speed_cloudflare_fonts_value'
      description: |
        Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain,
        boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.
      title: Cloudflare Fonts
    speed_cloudflare_fonts_value:
      default: "off"
      description: Whether the feature is enabled or disabled.
      enum:
        - "on"
        - "off"
      type: string
    speed_cloudflare_speed_brain_response:
      allOf:
        - $ref: '#/components/schemas/speed_base'
      properties:
        value:
          description: |
            Whether the feature is enabled or disabled.
            Defaults to "on" for Free plans, otherwise defaults to "off".
      title: Cloudflare Speed Brain response
    speed_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    speed_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    stream_accessRules:
      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.
      properties:
        action:
          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
          type: string
        country:
          description: An array of 2-letter country codes in ISO 3166-1 Alpha-2 format used to match requests.
          items:
            type: string
          type: array
        ip:
          description: An array of IPv4 or IPV6 addresses or CIDRs used to match requests.
          items:
            type: string
          type: array
        type:
          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
          type: string
      type: object
    stream_account_identifier:
      description: The account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    stream_addAudioTrackResponse:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/stream_additionalAudio'
    stream_additionalAudio:
      properties:
        default:
          $ref: '#/components/schemas/stream_audio_default'
        label:
          $ref: '#/components/schemas/stream_audio_label'
        status:
          $ref: '#/components/schemas/stream_audio_state'
        uid:
          $ref: '#/components/schemas/stream_identifier'
    stream_allowedOrigins:
      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
      type: array
    stream_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/stream_messages'
        messages:
          $ref: '#/components/schemas/stream_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    stream_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/stream_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/stream_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    stream_api-response-single:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-common'
      type: object
    stream_asc:
      default: false
      description: Lists videos in ascending order of creation.
      example: true
      type: boolean
    stream_audio_default:
      default: false
      description: Denotes whether the audio track will be played by default in a player.
      type: boolean
    stream_audio_identifier:
      description: The unique identifier for an additional audio track.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      type: string
    stream_audio_label:
      description: A string to uniquely identify the track amongst other audio track labels for the specified video.
      example: director commentary
      type: string
    stream_audio_state:
      description: Specifies the processing status of the video.
      enum:
        - queued
        - ready
        - error
      type: string
    stream_caption_basic_upload:
      properties:
        file:
          description: The WebVTT file containing the caption or subtitle content.
          example: '@/Users/kyle/Desktop/tr.vtt'
          type: string
      required:
        - file
      type: object
    stream_caption_status:
      description: The status of a generated caption.
      enum:
        - ready
        - inprogress
        - error
      type: string
    stream_captions:
      properties:
        generated:
          $ref: '#/components/schemas/stream_generated_caption'
        label:
          $ref: '#/components/schemas/stream_label'
        language:
          $ref: '#/components/schemas/stream_language'
        status:
          $ref: '#/components/schemas/stream_caption_status'
      type: object
    stream_clipResponseSingle:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/stream_clipping'
    stream_clipped_from_video_uid:
      description: The unique video identifier (UID).
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    stream_clipping:
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/stream_allowedOrigins'
        clippedFromVideoUID:
          $ref: '#/components/schemas/stream_clipped_from_video_uid'
        created:
          $ref: '#/components/schemas/stream_clipping_created'
        creator:
          $ref: '#/components/schemas/stream_creator'
        endTimeSeconds:
          $ref: '#/components/schemas/stream_end_time_seconds'
        maxDurationSeconds:
          $ref: '#/components/schemas/stream_maxDurationSeconds'
        meta:
          $ref: '#/components/schemas/stream_media_metadata'
        modified:
          $ref: '#/components/schemas/stream_live_input_modified'
        playback:
          $ref: '#/components/schemas/stream_playback'
        preview:
          $ref: '#/components/schemas/stream_preview'
        requireSignedURLs:
          $ref: '#/components/schemas/stream_requireSignedURLs'
        startTimeSeconds:
          $ref: '#/components/schemas/stream_start_time_seconds'
        status:
          $ref: '#/components/schemas/stream_media_state'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/stream_thumbnailTimestampPct'
        watermark:
          $ref: '#/components/schemas/stream_watermarkAtUpload'
    stream_clipping_created:
      description: The date and time the clip was created.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_copyAudioTrack:
      properties:
        label:
          $ref: '#/components/schemas/stream_audio_label'
        url:
          description: An audio track 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://www.examplestorage.com/audio_file.mp3
          format: uri
          type: string
      required:
        - label
      type: object
    stream_create_input_request:
      properties:
        defaultCreator:
          $ref: '#/components/schemas/stream_live_input_default_creator'
        deleteRecordingAfterDays:
          $ref: '#/components/schemas/stream_live_input_recording_deletion'
        meta:
          $ref: '#/components/schemas/stream_live_input_metadata'
        recording:
          $ref: '#/components/schemas/stream_live_input_recording_settings'
    stream_create_output_request:
      properties:
        enabled:
          $ref: '#/components/schemas/stream_output_enabled'
        streamKey:
          $ref: '#/components/schemas/stream_output_streamKey'
        url:
          $ref: '#/components/schemas/stream_output_url'
      required:
        - url
        - streamKey
    stream_created:
      description: The date and time the media item was created.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_creator:
      description: A user-defined identifier for the media creator.
      example: creator-id_abcde12345
      maxLength: 64
      type: string
    stream_deleted_response:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-single'
        - properties:
            result:
              example: ok
              type: string
    stream_direct_upload_request:
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/stream_allowedOrigins'
        creator:
          $ref: '#/components/schemas/stream_creator'
        expiry:
          default: Now + 30 minutes
          description: The date and time after upload when videos will not be accepted.
          example: "2021-01-02T02:20:00Z"
          format: date-time
          type: string
        maxDurationSeconds:
          $ref: '#/components/schemas/stream_maxDurationSeconds'
        meta:
          $ref: '#/components/schemas/stream_media_metadata'
        requireSignedURLs:
          $ref: '#/components/schemas/stream_requireSignedURLs'
        scheduledDeletion:
          $ref: '#/components/schemas/stream_scheduledDeletion'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/stream_thumbnailTimestampPct'
        watermark:
          $ref: '#/components/schemas/stream_watermark_at_upload'
      required:
        - maxDurationSeconds
      type: object
    stream_direct_upload_response:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-single'
        - properties:
            result:
              properties:
                scheduledDeletion:
                  $ref: '#/components/schemas/stream_scheduledDeletion'
                uid:
                  $ref: '#/components/schemas/stream_identifier'
                uploadURL:
                  description: The URL an unauthenticated upload can use for a single `HTTP POST multipart/form-data` request.
                  example: www.example.com/samplepath
                  type: string
                watermark:
                  $ref: '#/components/schemas/stream_watermarks'
    stream_downloadedFrom:
      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
      type: string
    stream_downloads_response:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-single'
        - properties:
            result:
              type: object
    stream_duration:
      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.
      type: number
    stream_editAudioTrack:
      properties:
        default:
          $ref: '#/components/schemas/stream_audio_default'
        label:
          $ref: '#/components/schemas/stream_audio_label'
      type: object
    stream_end:
      description: Lists videos created before the specified date.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_end_time_seconds:
      description: Specifies the end time for the video clip in seconds.
      type: integer
    stream_errorReasonCode:
      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
      type: string
    stream_errorReasonText:
      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.
      type: string
    stream_generated_caption:
      description: Whether the caption was generated via AI.
      example: true
      type: boolean
    stream_height:
      description: The height of the image in pixels.
      type: integer
    stream_identifier:
      description: A Cloudflare-generated unique identifier for a media item.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      type: string
    stream_include_counts:
      default: false
      description: Includes the total number of videos associated with the submitted query parameters.
      example: true
      type: boolean
    stream_input:
      properties:
        height:
          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.
          type: integer
        width:
          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.
          type: integer
      type: object
    stream_input_rtmps:
      description: Details for streaming to an live input using RTMPS.
      properties:
        streamKey:
          $ref: '#/components/schemas/stream_input_rtmps_stream_key'
        url:
          $ref: '#/components/schemas/stream_input_rtmps_url'
      type: object
    stream_input_rtmps_stream_key:
      description: The secret key to use when streaming via RTMPS to a live input.
      example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada
      type: string
    stream_input_rtmps_url:
      description: The RTMPS URL you provide to the broadcaster, which they stream live video to.
      example: rtmps://live.cloudflare.com:443/live/
      type: string
    stream_input_srt:
      description: Details for streaming to a live input using SRT.
      properties:
        passphrase:
          $ref: '#/components/schemas/stream_input_srt_stream_passphrase'
        streamId:
          $ref: '#/components/schemas/stream_input_srt_stream_id'
        url:
          $ref: '#/components/schemas/stream_input_srt_url'
      type: object
    stream_input_srt_stream_id:
      description: The identifier of the live input to use when streaming via SRT.
      example: f256e6ea9341d51eea64c9454659e576
      type: string
    stream_input_srt_stream_passphrase:
      description: The secret key to use when streaming via SRT to a live input.
      example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada
      type: string
    stream_input_srt_url:
      description: The SRT URL you provide to the broadcaster, which they stream live video to.
      example: srt://live.cloudflare.com:778
      type: string
    stream_input_webrtc:
      description: Details for streaming to a live input using WebRTC.
      properties:
        url:
          $ref: '#/components/schemas/stream_input_webrtc_url'
      type: object
    stream_input_webrtc_url:
      description: The WebRTC URL you provide to the broadcaster, which they stream live video to.
      example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/publish
      type: string
    stream_jwk:
      description: The signing key in JWK format.
      example: eyJ1c2UiOiJzaWciLCJrdHkiOiJSU0EiLCJraWQiOiI1MjEzY2ZhMTIxZjcwYjhjMTM4MDY4NmZmYzM3MWJhMyIsImFsZyI6IlJTMjU2IiwibiI6IjBUandqT2laV21KNDN2ZjNUbzREb1htWFd0SkdOR3lYZmh5dHRMYUJnRjEtRVFXUURLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMtbFlSWW95ckFHRjRBWGh5MzI5YkhDUDFJbHJCQl9Ba0dnbmRMQWd1bnhZMHJSZ2N2T3ppYXc2S0p4Rm5jMlVLMFdVOGIwcDRLS0hHcDFLTDlkazBXVDhkVllxYmVSaUpqQ2xVRW1oOHl2OUNsT1ZhUzRLeGlYNnhUUTREWnc2RGFKZklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWi1peFdmY1RETUg5MnNHdm93MURPanhMaUNOMXpISy1oN2JMb1hUaUxnYzRrdyIsImUiOiJBUUFCIiwiZCI6IndpQWEwaU5mWnNYSGNOcVMxSWhnUmdzVHJHay1TcFlYV2lReDZHTU9kWlJKekhGazN0bkRERFJvNHNKZTBxX0dEOWkzNlEyZkVadS15elpEcEJkc3U5OHNtaHhNU19Ta0s5X3VFYUo1Zm96V2IyN3JRRnFoLVliUU9MUThkUnNPRHZmQl9Hb2txWWJzblJDR3kzWkFaOGZJZ25ocXBUNEpiOHdsaWxpMUgxeFpzM3RnTWtkTEluTm1yMFAtcTYxZEtNd3JYZVRoSWNEc0kyb2Z1LTFtRm1MWndQb2ZGbmxaTW9QN1pfRU5pUGNfWGtWNzFhaHBOZE9pcW5ablZtMHBCNE5QS1UweDRWTjQyYlAzWEhMUmpkV2hJOGt3SC1BdXhqb3BLaHJ0R2tvcG1jZFRkM1ZRdElaOGRpZHByMXpBaEpvQi16ZVlIaTFUel9ZSFFld0FRUSIsInAiOiIyVTZFVUJka3U3TndDYXoyNzZuWGMxRXgwVHpNZjU4U0UtU2M2eUNaYWk2TkwzVURpWi1mNHlIdkRLYnFGUXdLWDNwZ0l2aVE3Y05QYUpkbE9NeS1mU21GTXU3V3hlbVZYamFlTjJCMkRDazhQY0NEOVgxU2hhR3E1ZUdSSHNObVUtSDNxTG1FRGpjLWliazRHZ0RNb2lVYjQ2OGxFZHAwU2pIOXdsOUdsYTgiLCJxIjoiOW5ucXg5ZnNNY2dIZ29DemhfVjJmaDhoRUxUSUM5aFlIOVBCTG9aQjZIaE1TWG1ja1BSazVnUlpPWlFEN002TzlMaWZjNmFDVXdEbjBlQzU2YkFDNUNrcWxjODJsVDhzTWlMeWJyTjh3bWotcjNjSTBGQTlfSGQySEY1ZkgycnJmenVqd0NWM3czb09Ud3p4d1g3c2xKbklRanphel91SzEyWEtucVZZcUYwIiwiZHAiOiJxQklTUTlfVUNWaV9Ucng0UU9VYnZoVU9jc2FUWkNHajJiNzNudU9YeElnOHFuZldSSnN4RG5zd2FKaXdjNWJjYnZ3M1h0VGhRd1BNWnhpeE1UMHFGNlFGWVY5WXZibnJ6UEp4YkdNdTZqajZYc2lIUjFlbWU3U09lVDM4Xzg0aFZyOXV6UkN2RWstb0R0MHlodW9YVzFGWVFNRTE2cGtMV0ZkUjdRUERsQUUiLCJkcSI6Im5zQUp3eXZFbW8tdW5wU01qYjVBMHB6MExCRjBZNFMxeGRJYXNfLVBSYzd0dThsVFdWMl8teExEOFR6dmhqX0lmY0RJR3JJZGNKNjlzVVZnR1M3ZnZkcng3Y21uNjFyai1XcmU0UVJFRC1lV1dxZDlpc2FVRmg5UGVKZ2tCbFZVVnYtdnladVlWdFF2a1NUU05ZR3RtVXl2V2xKZDBPWEFHRm9jdGlfak9aVSIsInFpIjoib0dYaWxLQ2NKRXNFdEE1eG54WUdGQW5UUjNwdkZLUXR5S0F0UGhHaHkybm5ya2VzN1RRaEFxMGhLRWZtU1RzaE1hNFhfd05aMEstX1F0dkdoNDhpeHdTTDVLTEwxZnFsY0k2TF9XUnF0cFQxS21LRERlUHR2bDVCUzFGbjgwSGFwR215cmZRWUU4S09QR2UwUl82S1BOZE1vc3dYQ3Nfd0RYMF92ZzNoNUxRIn0=
      type: string
    stream_key_generation_response:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/stream_keys'
    stream_key_response_collection:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-common'
        - properties:
            result:
              items:
                properties:
                  created:
                    $ref: '#/components/schemas/stream_signing_key_created'
                  id:
                    $ref: '#/components/schemas/stream_schemas-identifier'
                type: object
              type: array
    stream_keys:
      properties:
        created:
          $ref: '#/components/schemas/stream_signing_key_created'
        id:
          $ref: '#/components/schemas/stream_schemas-identifier'
        jwk:
          $ref: '#/components/schemas/stream_jwk'
        pem:
          $ref: '#/components/schemas/stream_pem'
      type: object
    stream_label:
      description: The language label displayed in the native language to users.
      example: Türkçe
      type: string
    stream_language:
      description: The language tag in BCP 47 format.
      example: tr
      type: string
    stream_language_response_collection:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/stream_captions'
              type: array
    stream_language_response_single:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/stream_captions'
    stream_listAudioTrackResponse:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/stream_additionalAudio'
              type: array
    stream_live_input:
      description: Details about a live input.
      properties:
        created:
          $ref: '#/components/schemas/stream_live_input_created'
        deleteRecordingAfterDays:
          $ref: '#/components/schemas/stream_live_input_recording_deletion'
        meta:
          $ref: '#/components/schemas/stream_live_input_metadata'
        modified:
          $ref: '#/components/schemas/stream_live_input_modified'
        recording:
          $ref: '#/components/schemas/stream_live_input_recording_settings'
        rtmps:
          $ref: '#/components/schemas/stream_input_rtmps'
        rtmpsPlayback:
          $ref: '#/components/schemas/stream_playback_rtmps'
        srt:
          $ref: '#/components/schemas/stream_input_srt'
        srtPlayback:
          $ref: '#/components/schemas/stream_playback_srt'
        status:
          $ref: '#/components/schemas/stream_live_input_status'
        uid:
          $ref: '#/components/schemas/stream_live_input_identifier'
        webRTC:
          $ref: '#/components/schemas/stream_input_webrtc'
        webRTCPlayback:
          $ref: '#/components/schemas/stream_playback_webrtc'
      type: object
    stream_live_input_created:
      description: The date and time the live input was created.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_live_input_default_creator:
      description: Sets the creator ID asssociated with this live input.
      type: string
    stream_live_input_identifier:
      description: A unique identifier for a live input.
      example: 66be4bf738797e01e1fca35a7bdecdcd
      maxLength: 32
      type: string
    stream_live_input_metadata:
      description: A user modifiable key-value store used to reference other systems of record for managing live inputs.
      example:
        name: test stream 1
      type: object
    stream_live_input_modified:
      description: The date and time the live input was last modified.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_live_input_object_without_url:
      properties:
        created:
          $ref: '#/components/schemas/stream_live_input_created'
        deleteRecordingAfterDays:
          $ref: '#/components/schemas/stream_live_input_recording_deletion'
        meta:
          $ref: '#/components/schemas/stream_live_input_metadata'
        modified:
          $ref: '#/components/schemas/stream_live_input_modified'
        uid:
          $ref: '#/components/schemas/stream_live_input_identifier'
    stream_live_input_recording_allowedOrigins:
      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
      type: array
    stream_live_input_recording_deletion:
      description: Indicates the number of days after which the live inputs recordings will be deleted. When a stream completes and the recording is ready, the value is used to calculate a scheduled deletion date for that recording. Omit the field to indicate no change, or include with a `null` value to remove an existing scheduled deletion.
      example: 45
      minimum: 30
      type: number
    stream_live_input_recording_hideLiveViewerCount:
      default: false
      description: Disables reporting the number of live viewers when this property is set to `true`.
      example: true
      type: boolean
    stream_live_input_recording_mode:
      default: "off"
      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
      example: automatic
      type: string
    stream_live_input_recording_requireSignedURLs:
      default: false
      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.
      example: true
      type: boolean
    stream_live_input_recording_settings:
      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:
        hideLiveViewerCount: false
        mode: "off"
        requireSignedURLs: false
        timeoutSeconds: 0
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/stream_live_input_recording_allowedOrigins'
        hideLiveViewerCount:
          $ref: '#/components/schemas/stream_live_input_recording_hideLiveViewerCount'
        mode:
          $ref: '#/components/schemas/stream_live_input_recording_mode'
        requireSignedURLs:
          $ref: '#/components/schemas/stream_live_input_recording_requireSignedURLs'
        timeoutSeconds:
          $ref: '#/components/schemas/stream_live_input_recording_timeoutSeconds'
      type: object
    stream_live_input_recording_timeoutSeconds:
      default: 0
      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.
      type: integer
    stream_live_input_response_collection:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-common'
        - properties:
            result:
              properties:
                liveInputs:
                  items:
                    $ref: '#/components/schemas/stream_live_input_object_without_url'
                  type: array
                range:
                  description: The total number of remaining live inputs based on cursor position.
                  example: 1000
                  type: integer
                total:
                  description: The total number of live inputs that match the provided filters.
                  example: 35586
                  type: integer
              type: object
    stream_live_input_response_single:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/stream_live_input'
    stream_live_input_status:
      description: The connection status of a live input.
      enum:
        - 
        - connected
        - reconnected
        - reconnecting
        - client_disconnect
        - ttl_exceeded
        - failed_to_connect
        - failed_to_reconnect
        - new_configuration_accepted
      nullable: true
      type: string
    stream_liveInput:
      description: The live input ID used to upload a video with Stream Live.
      example: fc0a8dc887b16759bfd9ad922230a014
      maxLength: 32
      type: string
    stream_maxDurationSeconds:
      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: 21600
      minimum: 1
      type: integer
    stream_media_metadata:
      description: A user modifiable key-value store used to reference other systems of record for managing videos.
      example:
        name: video12345.mp4
      type: object
    stream_media_state:
      description: Specifies the processing status for all quality levels for a video.
      enum:
        - pendingupload
        - downloading
        - queued
        - inprogress
        - ready
        - error
      example: inprogress
      type: string
    stream_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.
      properties:
        errorReasonCode:
          $ref: '#/components/schemas/stream_errorReasonCode'
        errorReasonText:
          $ref: '#/components/schemas/stream_errorReasonText'
        pctComplete:
          $ref: '#/components/schemas/stream_pctComplete'
        state:
          $ref: '#/components/schemas/stream_media_state'
    stream_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    stream_modified:
      description: The date and time the media item was last modified.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_name:
      default: ""
      description: A short description of the watermark profile.
      example: Marketing Videos
      type: string
    stream_notificationUrl:
      description: The URL where webhooks will be sent.
      example: https://example.com
      format: uri
      type: string
    stream_oneTimeUploadExpiry:
      description: The date and time when the video upload URL is no longer valid for direct user uploads.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_opacity:
      default: 1
      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.
      example: 0.75
      maximum: 1
      minimum: 0
      type: number
    stream_output:
      properties:
        enabled:
          $ref: '#/components/schemas/stream_output_enabled'
        streamKey:
          $ref: '#/components/schemas/stream_output_streamKey'
        uid:
          $ref: '#/components/schemas/stream_output_identifier'
        url:
          $ref: '#/components/schemas/stream_output_url'
    stream_output_enabled:
      default: true
      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.
      example: true
      type: boolean
    stream_output_identifier:
      description: A unique identifier for the output.
      example: baea4d9c515887b80289d5c33cf01145
      maxLength: 32
      type: string
    stream_output_response_collection:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/stream_output'
              type: array
    stream_output_response_single:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/stream_output'
    stream_output_streamKey:
      description: The streamKey used to authenticate against an output's target.
      example: uzya-f19y-g2g9-a2ee-51j2
      type: string
    stream_output_url:
      description: The URL an output uses to restream.
      example: rtmp://a.rtmp.youtube.com/live2
      type: string
    stream_padding:
      default: 0.05
      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.
      example: 0.1
      maximum: 1
      minimum: 0
      type: number
    stream_pctComplete:
      description: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
      maximum: 100
      minimum: 0
      type: string
    stream_pem:
      description: The signing key in PEM format.
      example: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcGdJQkFBS0NBUUVBMFRqd2pPaVpXbUo0M3ZmM1RvNERvWG1YV3RKR05HeVhmaHl0dExhQmdGMStFUVdRCkRLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMrbFkKUllveXJBR0Y0QVhoeTMyOWJIQ1AxSWxyQkIvQWtHZ25kTEFndW54WTByUmdjdk96aWF3NktKeEZuYzJVSzBXVQo4YjBwNEtLSEdwMUtMOWRrMFdUOGRWWXFiZVJpSmpDbFVFbWg4eXY5Q2xPVmFTNEt4aVg2eFRRNERadzZEYUpmCklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWitpeFdmY1QKRE1IOTJzR3ZvdzFET2p4TGlDTjF6SEsraDdiTG9YVGlMZ2M0a3dJREFRQUJBb0lCQVFEQ0lCclNJMTlteGNkdwoycExVaUdCR0N4T3NhVDVLbGhkYUpESG9ZdzUxbEVuTWNXVGUyY01NTkdqaXdsN1NyOFlQMkxmcERaOFJtNzdMCk5rT2tGMnk3M3l5YUhFeEw5S1FyMys0Um9ubCtqTlp2YnV0QVdxSDVodEE0dER4MUd3NE85OEg4YWlTcGh1eWQKRUliTGRrQm54OGlDZUdxbFBnbHZ6Q1dLV0xVZlhGbXplMkF5UjBzaWMyYXZRLzZyclYwb3pDdGQ1T0Vod093agphaCs3N1dZV1l0bkEraDhXZVZreWcvdG44UTJJOXo5ZVJYdlZxR2sxMDZLcWRtZFdiU2tIZzA4cFRUSGhVM2paCnMvZGNjdEdOMWFFanlUQWY0QzdHT2lrcUd1MGFTaW1aeDFOM2RWQzBobngySjJtdlhNQ0VtZ0g3TjVnZUxWUFAKOWdkQjdBQkJBb0dCQU5sT2hGQVhaTHV6Y0Ftczl1K3AxM05STWRFOHpIK2ZFaFBrbk9zZ21Xb3VqUzkxQTRtZgpuK01oN3d5bTZoVU1DbDk2WUNMNGtPM0RUMmlYWlRqTXZuMHBoVEx1MXNYcGxWNDJuamRnZGd3cFBEM0FnL1Y5ClVvV2hxdVhoa1I3RFpsUGg5Nmk1aEE0M1BvbTVPQm9BektJbEcrT3ZKUkhhZEVveC9jSmZScFd2QW9HQkFQWjUKNnNmWDdESElCNEtBczRmMWRuNGZJUkMweUF2WVdCL1R3UzZHUWVoNFRFbDVuSkQwWk9ZRVdUbVVBK3pPanZTNApuM09tZ2xNQTU5SGd1ZW13QXVRcEtwWFBOcFUvTERJaThtNnpmTUpvL3E5M0NOQlFQZngzZGh4ZVh4OXE2Mzg3Cm84QWxkOE42RGs4TThjRis3SlNaeUVJODJzLzdpdGRseXA2bFdLaGRBb0dCQUtnU0VrUGYxQWxZdjA2OGVFRGwKRzc0VkRuTEdrMlFobzltKzk1N2psOFNJUEtwMzFrU2JNUTU3TUdpWXNIT1czRzc4TjE3VTRVTUR6R2NZc1RFOQpLaGVrQldGZldMMjU2OHp5Y1d4akx1bzQrbDdJaDBkWHBudTBqbms5L1AvT0lWYS9iczBRcnhKUHFBN2RNb2JxCkYxdFJXRURCTmVxWkMxaFhVZTBEdzVRQkFvR0JBSjdBQ2NNcnhKcVBycDZVakkyK1FOS2M5Q3dSZEdPRXRjWFMKR3JQL2owWE83YnZKVTFsZHYvc1N3L0U4NzRZL3lIM0F5QnF5SFhDZXZiRkZZQmt1MzczYThlM0pwK3RhNC9scQozdUVFUkEvbmxscW5mWXJHbEJZZlQzaVlKQVpWVkZiL3I4bWJtRmJVTDVFazBqV0JyWmxNcjFwU1hkRGx3QmhhCkhMWXY0em1WQW9HQkFLQmw0cFNnbkNSTEJMUU9jWjhXQmhRSjAwZDZieFNrTGNpZ0xUNFJvY3RwNTY1SHJPMDAKSVFLdElTaEg1a2s3SVRHdUYvOERXZEN2djBMYnhvZVBJc2NFaStTaXk5WDZwWENPaS8xa2FyYVU5U3BpZ3czago3YjVlUVV0UlovTkIycVJwc3EzMEdCUENqanhudEVmK2lqelhUS0xNRndyUDhBMTlQNzRONGVTMAotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=
      type: string
    stream_playback:
      properties:
        dash:
          description: DASH Media Presentation Description for the video.
          example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd
          type: string
        hls:
          description: The HLS manifest for the video.
          example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8
          type: string
      type: object
    stream_playback_rtmps:
      description: Details for playback from an live input using RTMPS.
      properties:
        streamKey:
          $ref: '#/components/schemas/stream_playback_rtmps_stream_key'
        url:
          $ref: '#/components/schemas/stream_playback_rtmps_url'
      type: object
    stream_playback_rtmps_stream_key:
      description: The secret key to use for playback via RTMPS.
      example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada
      type: string
    stream_playback_rtmps_url:
      description: The URL used to play live video over RTMPS.
      example: rtmps://live.cloudflare.com:443/live/
      type: string
    stream_playback_srt:
      description: Details for playback from an live input using SRT.
      properties:
        passphrase:
          $ref: '#/components/schemas/stream_playback_srt_stream_passphrase'
        streamId:
          $ref: '#/components/schemas/stream_playback_srt_stream_id'
        url:
          $ref: '#/components/schemas/stream_playback_srt_url'
      type: object
    stream_playback_srt_stream_id:
      description: The identifier of the live input to use for playback via SRT.
      example: f256e6ea9341d51eea64c9454659e576
      type: string
    stream_playback_srt_stream_passphrase:
      description: The secret key to use for playback via SRT.
      example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada
      type: string
    stream_playback_srt_url:
      description: The URL used to play live video over SRT.
      example: rtmps://live.cloudflare.com:443/live/
      type: string
    stream_playback_webrtc:
      description: Details for playback from a live input using WebRTC.
      properties:
        url:
          $ref: '#/components/schemas/stream_playback_webrtc_url'
      type: object
    stream_playback_webrtc_url:
      description: The URL used to play live video over WebRTC.
      example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/play
      type: string
    stream_position:
      default: upperRight
      description: 'The location of the image. Valid positions are: `upperRight`, `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the `padding` parameter.'
      example: center
      type: string
    stream_preview:
      description: The video's preview page URI. This field is omitted until encoding is complete.
      example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch
      format: uri
      type: string
    stream_readyToStream:
      description: Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
      example: true
      type: boolean
    stream_readyToStreamAt:
      description: Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_requireSignedURLs:
      default: false
      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.
      example: true
      type: boolean
    stream_scale:
      default: 0.15
      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.
      example: 0.1
      maximum: 1
      minimum: 0
      type: number
    stream_scheduledDeletion:
      description: Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a `null` value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    stream_search:
      description: Searches over the `name` key in the `meta` field. This field can be set with or after the upload request.
      example: puppy.mp4
      type: string
    stream_signed_token_request:
      properties:
        accessRules:
          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
          items:
            $ref: '#/components/schemas/stream_accessRules'
          type: array
        downloadable:
          default: false
          description: The optional boolean value that enables using signed tokens to access MP4 download links for a video.
          type: boolean
        exp:
          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.
          type: integer
        id:
          description: The optional ID of a Stream signing key. If present, the `pem` field is also required.
          example: ab0d4ef71g4425f8dcba9041231813000
          type: string
        nbf:
          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.
          type: integer
        pem:
          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=
          type: string
      type: object
    stream_signed_token_response:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-single'
        - properties:
            result:
              properties:
                token:
                  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
                  type: string
    stream_signing_key_created:
      description: The date and time a signing key was created.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_size:
      description: The size of the media item in bytes.
      example: 4.190963e+06
      type: number
    stream_start:
      description: Lists videos created after the specified date.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_start_time_seconds:
      description: Specifies the start time for the video clip in seconds.
      type: integer
    stream_storage_use_response:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-single'
        - properties:
            result:
              properties:
                creator:
                  $ref: '#/components/schemas/stream_creator'
                totalStorageMinutes:
                  description: The total minutes of video content stored in the account.
                  type: integer
                totalStorageMinutesLimit:
                  description: The storage capacity alloted for the account.
                  type: integer
                videoCount:
                  description: The total count of videos associated with the account.
                  type: integer
    stream_thumbnail_url:
      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
      format: uri
      type: string
    stream_thumbnailTimestampPct:
      default: 0
      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.
      example: 0.529241
      maximum: 1
      minimum: 0
      type: number
    stream_tus_resumable:
      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
      type: string
    stream_type:
      description: Specifies whether the video is `vod` or `live`.
      example: live
      type: string
    stream_update_input_request:
      properties:
        defaultCreator:
          $ref: '#/components/schemas/stream_live_input_default_creator'
        deleteRecordingAfterDays:
          $ref: '#/components/schemas/stream_live_input_recording_deletion'
        meta:
          $ref: '#/components/schemas/stream_live_input_metadata'
        recording:
          $ref: '#/components/schemas/stream_live_input_recording_settings'
    stream_update_output_request:
      properties:
        enabled:
          $ref: '#/components/schemas/stream_output_enabled'
      required:
        - enabled
    stream_upload_length:
      description: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
      minimum: 0
      type: integer
    stream_upload_metadata:
      description: |-
        Comma-separated key-value pairs following the TUS protocol specification. Values are Base-64 encoded.
        Supported keys: `name`, `requiresignedurls`, `allowedorigins`, `thumbnailtimestamppct`, `watermark`, `scheduleddeletion`.
      example: name aGVsbG8gd29ybGQ=, requiresignedurls, allowedorigins ZXhhbXBsZS5jb20sdGVzdC5jb20=
      type: string
    stream_uploaded:
      description: The date and time the media item was uploaded.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_video_copy_request:
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/stream_allowedOrigins'
        creator:
          $ref: '#/components/schemas/stream_creator'
        meta:
          $ref: '#/components/schemas/stream_media_metadata'
        requireSignedURLs:
          $ref: '#/components/schemas/stream_requireSignedURLs'
        scheduledDeletion:
          $ref: '#/components/schemas/stream_scheduledDeletion'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/stream_thumbnailTimestampPct'
        url:
          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
          format: uri
          type: string
        watermark:
          $ref: '#/components/schemas/stream_watermark_at_upload'
      required:
        - url
    stream_video_response_collection:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/stream_videos'
              type: array
        - properties:
            range:
              description: The total number of remaining videos based on cursor position.
              example: 1000
              type: integer
            total:
              description: The total number of videos that match the provided filters.
              example: 35586
              type: integer
    stream_video_response_single:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/stream_videos'
    stream_video_update:
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/stream_allowedOrigins'
        creator:
          $ref: '#/components/schemas/stream_creator'
        maxDurationSeconds:
          $ref: '#/components/schemas/stream_maxDurationSeconds'
        meta:
          $ref: '#/components/schemas/stream_media_metadata'
        requireSignedURLs:
          $ref: '#/components/schemas/stream_requireSignedURLs'
        scheduledDeletion:
          $ref: '#/components/schemas/stream_scheduledDeletion'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/stream_thumbnailTimestampPct'
        uploadExpiry:
          $ref: '#/components/schemas/stream_oneTimeUploadExpiry'
      type: object
    stream_videoClipStandard:
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/stream_allowedOrigins'
        clippedFromVideoUID:
          $ref: '#/components/schemas/stream_clipped_from_video_uid'
        creator:
          $ref: '#/components/schemas/stream_creator'
        endTimeSeconds:
          $ref: '#/components/schemas/stream_end_time_seconds'
        maxDurationSeconds:
          $ref: '#/components/schemas/stream_maxDurationSeconds'
        requireSignedURLs:
          $ref: '#/components/schemas/stream_requireSignedURLs'
        startTimeSeconds:
          $ref: '#/components/schemas/stream_start_time_seconds'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/stream_thumbnailTimestampPct'
        watermark:
          $ref: '#/components/schemas/stream_watermarkAtUpload'
      required:
        - clippedFromVideoUID
        - startTimeSeconds
        - endTimeSeconds
      type: object
    stream_videos:
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/stream_allowedOrigins'
        created:
          $ref: '#/components/schemas/stream_created'
        creator:
          $ref: '#/components/schemas/stream_creator'
        duration:
          $ref: '#/components/schemas/stream_duration'
        input:
          $ref: '#/components/schemas/stream_input'
        liveInput:
          $ref: '#/components/schemas/stream_liveInput'
        maxDurationSeconds:
          $ref: '#/components/schemas/stream_maxDurationSeconds'
        meta:
          $ref: '#/components/schemas/stream_media_metadata'
        modified:
          $ref: '#/components/schemas/stream_modified'
        playback:
          $ref: '#/components/schemas/stream_playback'
        preview:
          $ref: '#/components/schemas/stream_preview'
        readyToStream:
          $ref: '#/components/schemas/stream_readyToStream'
        readyToStreamAt:
          $ref: '#/components/schemas/stream_readyToStreamAt'
        requireSignedURLs:
          $ref: '#/components/schemas/stream_requireSignedURLs'
        scheduledDeletion:
          $ref: '#/components/schemas/stream_scheduledDeletion'
        size:
          $ref: '#/components/schemas/stream_size'
        status:
          $ref: '#/components/schemas/stream_media_status'
        thumbnail:
          $ref: '#/components/schemas/stream_thumbnail_url'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/stream_thumbnailTimestampPct'
        uid:
          $ref: '#/components/schemas/stream_identifier'
        uploadExpiry:
          $ref: '#/components/schemas/stream_oneTimeUploadExpiry'
        uploaded:
          $ref: '#/components/schemas/stream_uploaded'
        watermark:
          $ref: '#/components/schemas/stream_watermarks'
      type: object
    stream_watermark_at_upload:
      properties:
        uid:
          description: The unique identifier for the watermark profile.
          example: ea95132c15732412d22c1476fa83f27a
          maxLength: 32
          type: string
      type: object
    stream_watermark_basic_upload:
      properties:
        file:
          description: The image file to upload.
          example: '@/Users/rchen/Downloads/watermark.png'
          type: string
        name:
          $ref: '#/components/schemas/stream_name'
        opacity:
          $ref: '#/components/schemas/stream_opacity'
        padding:
          $ref: '#/components/schemas/stream_padding'
        position:
          $ref: '#/components/schemas/stream_position'
        scale:
          $ref: '#/components/schemas/stream_scale'
      required:
        - file
      type: object
    stream_watermark_created:
      description: The date and a time a watermark profile was created.
      example: "2014-01-02T02:20:00Z"
      format: date-time
      type: string
    stream_watermark_identifier:
      description: The unique identifier for a watermark profile.
      example: ea95132c15732412d22c1476fa83f27a
      maxLength: 32
      type: string
    stream_watermark_response_collection:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/stream_watermarks'
              type: array
    stream_watermark_response_single:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/stream_watermarks'
    stream_watermark_size:
      description: The size of the image in bytes.
      example: 29472
      type: number
    stream_watermarkAtUpload:
      properties:
        uid:
          description: The unique identifier for the watermark profile.
          example: ea95132c15732412d22c1476fa83f27a
          maxLength: 32
          type: string
      type: object
    stream_watermarks:
      properties:
        created:
          $ref: '#/components/schemas/stream_watermark_created'
        downloadedFrom:
          $ref: '#/components/schemas/stream_downloadedFrom'
        height:
          $ref: '#/components/schemas/stream_height'
        name:
          $ref: '#/components/schemas/stream_name'
        opacity:
          $ref: '#/components/schemas/stream_opacity'
        padding:
          $ref: '#/components/schemas/stream_padding'
        position:
          $ref: '#/components/schemas/stream_position'
        scale:
          $ref: '#/components/schemas/stream_scale'
        size:
          $ref: '#/components/schemas/stream_watermark_size'
        uid:
          $ref: '#/components/schemas/stream_watermark_identifier'
        width:
          $ref: '#/components/schemas/stream_width'
      type: object
    stream_webhook_request:
      properties:
        notificationUrl:
          $ref: '#/components/schemas/stream_notificationUrl'
      required:
        - notificationUrl
    stream_webhook_response_single:
      allOf:
        - $ref: '#/components/schemas/stream_api-response-single'
        - properties:
            result:
              type: object
    stream_width:
      description: The width of the image in pixels.
      type: integer
    teams-devices_allow_mode_switch:
      description: Whether to allow the user to switch WARP between modes.
      example: true
      type: boolean
    teams-devices_allow_updates:
      description: Whether to receive update notifications when a new version of the client is available.
      example: true
      type: boolean
    teams-devices_allowed_to_leave:
      description: Whether to allow devices to leave the organization.
      example: true
      type: boolean
    teams-devices_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/teams-devices_result_info'
      type: object
    teams-devices_api-response-collection-common:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
      type: object
    teams-devices_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/teams-devices_messages'
        messages:
          $ref: '#/components/schemas/teams-devices_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful.
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    teams-devices_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/teams-devices_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/teams-devices_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    teams-devices_api-response-single:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-common'
        - properties:
            result:
              anyOf:
                - type: object
                - type: string
              nullable: true
              type: object
      type: object
    teams-devices_application_input_request:
      properties:
        operating_system:
          description: Operating system
          enum:
            - windows
            - linux
            - mac
          example: mac
          type: string
        path:
          description: Path for the application.
          example: /bin/cat
          type: string
        sha256:
          description: SHA-256.
          example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
          type: string
        thumbprint:
          description: Signing certificate thumbprint.
          example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e
          type: string
      required:
        - path
        - operating_system
      title: Application
      type: object
    teams-devices_auto_connect:
      description: The amount of time in minutes to reconnect after having been disabled.
      example: 0
      type: number
    teams-devices_captive_portal:
      description: Turn on the captive portal after the specified amount of time.
      example: 180
      type: number
    teams-devices_carbonblack_input_request:
      properties:
        operating_system:
          description: Operating system
          enum:
            - windows
            - linux
            - mac
          example: mac
          type: string
        path:
          description: File path.
          example: /bin/cat
          type: string
        sha256:
          description: SHA-256.
          example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
          type: string
        thumbprint:
          description: Signing certificate thumbprint.
          example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e
          type: string
      required:
        - path
        - operating_system
      title: Carbonblack
      type: object
    teams-devices_checkDisks:
      description: List of volume names to be checked for encryption.
      example:
        - C
        - D
        - G
      items:
        type: string
      type: array
    teams-devices_client_certificate_input_request:
      properties:
        certificate_id:
          description: UUID of Cloudflare managed certificate.
          example: b14ddcc4-bcd2-4df4-bd4f-eb27d5a50c30
          maxLength: 36
          type: string
        cn:
          description: Common Name that is protected by the certificate
          example: example.com
          type: string
      required:
        - certificate_id
        - cn
      title: Client Certificate
      type: object
    teams-devices_client_certificate_v2_input_request:
      properties:
        certificate_id:
          description: UUID of Cloudflare managed certificate.
          example: b14ddcc4-bcd2-4df4-bd4f-eb27d5a50c30
          maxLength: 36
          type: string
        check_private_key:
          description: Confirm the certificate was not imported from another device. We recommend keeping this enabled unless the certificate was deployed without a private key.
          example: true
          type: boolean
        cn:
          description: Common Name that is protected by the client certificate. This may include one or more variables in the ${ } notation. Only ${serial_number} and ${hostname} are valid variables.
          example: ${hostname}.com.${serial_number}
          type: string
        extended_key_usage:
          description: List of values indicating purposes for which the certificate public key can be used
          example:
            - clientAuth
            - emailProtection
          items:
            $ref: '#/components/schemas/teams-devices_extended_key_usage_enum'
          type: array
        locations:
          properties:
            paths:
              $ref: '#/components/schemas/teams-devices_paths'
            trust_stores:
              $ref: '#/components/schemas/teams-devices_trust_stores'
          type: object
        operating_system:
          description: Operating System
          enum:
            - windows
            - mac
            - linux
          example: windows
          type: string
      required:
        - certificate_id
        - check_private_key
        - operating_system
      title: Client Certificate V2
      type: object
    teams-devices_components-schemas-name:
      description: The name of the device posture integration.
      example: My Workspace One Integration
      type: string
    teams-devices_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/teams-devices_device-managed-networks'
              type: array
    teams-devices_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/teams-devices_device-managed-networks'
    teams-devices_components-schemas-type:
      description: The type of device managed network.
      enum:
        - tls
      example: tls
      type: string
    teams-devices_components-schemas-uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      readOnly: true
      type: string
    teams-devices_config_request:
      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
      oneOf:
        - $ref: '#/components/schemas/teams-devices_workspace_one_config_request'
        - $ref: '#/components/schemas/teams-devices_crowdstrike_config_request'
        - $ref: '#/components/schemas/teams-devices_uptycs_config_request'
        - $ref: '#/components/schemas/teams-devices_intune_config_request'
        - $ref: '#/components/schemas/teams-devices_kolide_config_request'
        - $ref: '#/components/schemas/teams-devices_tanium_config_request'
        - $ref: '#/components/schemas/teams-devices_sentinelone_s2s_config_request'
        - $ref: '#/components/schemas/teams-devices_custom_s2s_config_request'
      type: object
    teams-devices_config_response:
      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
      oneOf:
        - $ref: '#/components/schemas/teams-devices_workspace_one_config_response'
      type: object
    teams-devices_created:
      description: When the device was created.
      example: "2017-06-14T00:00:00Z"
      format: date-time
      type: string
    teams-devices_crowdstrike_config_request:
      properties:
        api_url:
          description: The Crowdstrike API URL.
          example: https://api.us-2.crowdstrike.com
          type: string
        client_id:
          description: The Crowdstrike client ID.
          example: example client id
          type: string
        client_secret:
          description: The Crowdstrike client secret.
          example: example client secret
          type: string
        customer_id:
          description: The Crowdstrike customer ID.
          example: example customer id
          type: string
      required:
        - api_url
        - customer_id
        - client_id
        - client_secret
      title: Crowdstrike Config
      type: object
    teams-devices_crowdstrike_input_request:
      properties:
        connection_id:
          description: Posture Integration ID.
          example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
          type: string
        last_seen:
          description: For more details on last seen, please refer to the Crowdstrike documentation.
          example: 15d3h20m4s
          type: string
        operator:
          description: Operator
          enum:
            - <
            - <=
            - '>'
            - '>='
            - ==
          example: '>'
          type: string
        os:
          description: Os Version
          example: 13.3.0
          type: string
        overall:
          description: overall
          example: 90
          type: string
        sensor_config:
          description: SensorConfig
          example: 90
          type: string
        state:
          description: For more details on state, please refer to the Crowdstrike documentation.
          enum:
            - online
            - offline
            - unknown
          example: online
          type: string
        version:
          description: Version
          example: 13.3.0
          type: string
        versionOperator:
          description: Version Operator
          enum:
            - <
            - <=
            - '>'
            - '>='
            - ==
          example: '>'
          type: string
      required:
        - connection_id
      title: Crowdstrike S2S Input
      type: object
    teams-devices_custom_s2s_config_request:
      properties:
        access_client_id:
          description: This id will be passed in the `CF-Access-Client-ID` header when hitting the `api_url`
          example: 88bf3b6d86161464f6509f7219099e57.access
          type: string
        access_client_secret:
          description: This secret will be passed in the `CF-Access-Client-Secret` header when hitting the `api_url`
          example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5
          type: string
        api_url:
          description: The Custom Device Posture Integration  API URL.
          example: https://example.custom-s2s.com
          type: string
      required:
        - api_url
        - access_client_id
        - access_client_secret
      title: Custom Device Posture Integration Config
      type: object
    teams-devices_custom_s2s_input_request:
      properties:
        connection_id:
          description: Posture Integration ID.
          example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
          type: string
        operator:
          description: operator
          enum:
            - <
            - <=
            - '>'
            - '>='
            - ==
          example: '>'
          type: string
        score:
          description: A value between 0-100 assigned to devices set by the 3rd party posture provider.
          example: 100
          type: number
      required:
        - connection_id
        - score
        - operator
      title: Custom Device Posture Integration Input
      type: object
    teams-devices_default:
      description: Whether the policy is the default policy for an account.
      example: false
      type: boolean
    teams-devices_default_device_settings_policy:
      properties:
        allow_mode_switch:
          $ref: '#/components/schemas/teams-devices_allow_mode_switch'
        allow_updates:
          $ref: '#/components/schemas/teams-devices_allow_updates'
        allowed_to_leave:
          $ref: '#/components/schemas/teams-devices_allowed_to_leave'
        auto_connect:
          $ref: '#/components/schemas/teams-devices_auto_connect'
        captive_portal:
          $ref: '#/components/schemas/teams-devices_captive_portal'
        default:
          description: Whether the policy will be applied to matching devices.
          example: true
          type: boolean
        disable_auto_fallback:
          $ref: '#/components/schemas/teams-devices_disable_auto_fallback'
        enabled:
          description: Whether the policy will be applied to matching devices.
          example: true
          type: boolean
        exclude:
          $ref: '#/components/schemas/teams-devices_exclude'
        exclude_office_ips:
          $ref: '#/components/schemas/teams-devices_exclude_office_ips'
        fallback_domains:
          $ref: '#/components/schemas/teams-devices_fallback_domains'
        gateway_unique_id:
          $ref: '#/components/schemas/teams-devices_gateway_unique_id'
        include:
          $ref: '#/components/schemas/teams-devices_include'
        service_mode_v2:
          $ref: '#/components/schemas/teams-devices_service_mode_v2'
        support_url:
          $ref: '#/components/schemas/teams-devices_support_url'
        switch_locked:
          $ref: '#/components/schemas/teams-devices_switch_locked'
        tunnel_protocol:
          $ref: '#/components/schemas/teams-devices_tunnel_protocol'
      type: object
    teams-devices_default_device_settings_response:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/teams-devices_default_device_settings_policy'
    teams-devices_deleted:
      description: True if the device was deleted.
      example: true
      type: boolean
    teams-devices_description:
      description: The description of the device posture rule.
      example: The rule for admin serial numbers
      type: string
    teams-devices_device-dex-test-schemas-data:
      description: The configuration object which contains the details for the WARP client to conduct the test.
      example:
        host: https://dash.cloudflare.com
        kind: http
        method: GET
      properties:
        host:
          description: The desired endpoint to test.
          example: https://dash.cloudflare.com
          type: string
        kind:
          description: The type of test.
          example: http
          type: string
        method:
          description: The HTTP request method type.
          example: GET
          type: string
      type: object
    teams-devices_device-dex-test-schemas-description:
      description: Additional details about the test.
      example: Checks the dash endpoint every 30 minutes
      type: string
    teams-devices_device-dex-test-schemas-enabled:
      description: Determines whether or not the test is active.
      example: true
      type: boolean
    teams-devices_device-dex-test-schemas-http:
      properties:
        data:
          $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-data'
        description:
          $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-description'
        enabled:
          $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-enabled'
        interval:
          $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-interval'
        name:
          $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-name'
        target_policies:
          $ref: '#/components/schemas/teams-devices_device-dex-test-target-policies'
        targeted:
          type: boolean
      required:
        - name
        - interval
        - enabled
        - data
      type: object
    teams-devices_device-dex-test-schemas-interval:
      description: How often the test will run.
      example: 30m
      type: string
    teams-devices_device-dex-test-schemas-name:
      description: The name of the DEX test. Must be unique.
      example: HTTP dash health check
      type: string
    teams-devices_device-dex-test-target-policies:
      description: Device settings profiles targeted by this test
      items:
        $ref: '#/components/schemas/teams-devices_dex_target_policy'
      type: array
    teams-devices_device-managed-networks:
      properties:
        config:
          $ref: '#/components/schemas/teams-devices_schemas-config_response'
        name:
          $ref: '#/components/schemas/teams-devices_device-managed-networks_components-schemas-name'
        network_id:
          $ref: '#/components/schemas/teams-devices_uuid'
        type:
          $ref: '#/components/schemas/teams-devices_components-schemas-type'
      type: object
    teams-devices_device-managed-networks_components-schemas-name:
      description: The name of the device managed network. This name must be unique.
      example: managed-network-1
      type: string
    teams-devices_device-posture-integrations:
      properties:
        config:
          $ref: '#/components/schemas/teams-devices_config_response'
        id:
          $ref: '#/components/schemas/teams-devices_uuid'
        interval:
          $ref: '#/components/schemas/teams-devices_interval'
        name:
          $ref: '#/components/schemas/teams-devices_components-schemas-name'
        type:
          $ref: '#/components/schemas/teams-devices_schemas-type'
      type: object
    teams-devices_device-posture-rules:
      properties:
        description:
          $ref: '#/components/schemas/teams-devices_description'
        expiration:
          $ref: '#/components/schemas/teams-devices_expiration'
        id:
          $ref: '#/components/schemas/teams-devices_uuid'
        input:
          $ref: '#/components/schemas/teams-devices_input'
        match:
          $ref: '#/components/schemas/teams-devices_match'
        name:
          $ref: '#/components/schemas/teams-devices_name'
        schedule:
          $ref: '#/components/schemas/teams-devices_schedule'
        type:
          $ref: '#/components/schemas/teams-devices_type'
      type: object
    teams-devices_device_response:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-single'
        - properties:
            result:
              type: object
    teams-devices_device_settings_policy:
      properties:
        allow_mode_switch:
          $ref: '#/components/schemas/teams-devices_allow_mode_switch'
        allow_updates:
          $ref: '#/components/schemas/teams-devices_allow_updates'
        allowed_to_leave:
          $ref: '#/components/schemas/teams-devices_allowed_to_leave'
        auto_connect:
          $ref: '#/components/schemas/teams-devices_auto_connect'
        captive_portal:
          $ref: '#/components/schemas/teams-devices_captive_portal'
        default:
          $ref: '#/components/schemas/teams-devices_default'
        description:
          $ref: '#/components/schemas/teams-devices_schemas-description'
        disable_auto_fallback:
          $ref: '#/components/schemas/teams-devices_disable_auto_fallback'
        enabled:
          description: Whether the policy will be applied to matching devices.
          example: true
          type: boolean
        exclude:
          $ref: '#/components/schemas/teams-devices_exclude'
        exclude_office_ips:
          $ref: '#/components/schemas/teams-devices_exclude_office_ips'
        fallback_domains:
          $ref: '#/components/schemas/teams-devices_fallback_domains'
        gateway_unique_id:
          $ref: '#/components/schemas/teams-devices_gateway_unique_id'
        include:
          $ref: '#/components/schemas/teams-devices_include'
        lan_allow_minutes:
          $ref: '#/components/schemas/teams-devices_lan_allow_minutes'
        lan_allow_subnet_size:
          $ref: '#/components/schemas/teams-devices_lan_allow_subnet_size'
        match:
          $ref: '#/components/schemas/teams-devices_schemas-match'
        name:
          description: The name of the device settings profile.
          example: Allow Developers
          maxLength: 100
          type: string
        policy_id:
          $ref: '#/components/schemas/teams-devices_schemas-uuid'
        precedence:
          $ref: '#/components/schemas/teams-devices_precedence'
        service_mode_v2:
          $ref: '#/components/schemas/teams-devices_service_mode_v2'
        support_url:
          $ref: '#/components/schemas/teams-devices_support_url'
        switch_locked:
          $ref: '#/components/schemas/teams-devices_switch_locked'
        target_tests:
          items:
            $ref: '#/components/schemas/teams-devices_target_dex_test'
          type: array
        tunnel_protocol:
          $ref: '#/components/schemas/teams-devices_tunnel_protocol'
      type: object
    teams-devices_device_settings_response:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/teams-devices_device_settings_policy'
    teams-devices_device_settings_response_collection:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/teams-devices_device_settings_policy'
              type: array
    teams-devices_devices:
      properties:
        created:
          $ref: '#/components/schemas/teams-devices_created'
        deleted:
          $ref: '#/components/schemas/teams-devices_deleted'
        device_type:
          $ref: '#/components/schemas/teams-devices_platform'
        id:
          $ref: '#/components/schemas/teams-devices_schemas-uuid'
        ip:
          $ref: '#/components/schemas/teams-devices_ip'
        key:
          $ref: '#/components/schemas/teams-devices_key'
        last_seen:
          $ref: '#/components/schemas/teams-devices_last_seen'
        mac_address:
          $ref: '#/components/schemas/teams-devices_mac_address'
        manufacturer:
          $ref: '#/components/schemas/teams-devices_manufacturer'
        model:
          $ref: '#/components/schemas/teams-devices_model'
        name:
          $ref: '#/components/schemas/teams-devices_schemas-name'
        os_distro_name:
          $ref: '#/components/schemas/teams-devices_os_distro_name'
        os_distro_revision:
          $ref: '#/components/schemas/teams-devices_os_distro_revision'
        os_version:
          $ref: '#/components/schemas/teams-devices_os_version'
        os_version_extra:
          $ref: '#/components/schemas/teams-devices_os_version_extra'
        revoked_at:
          $ref: '#/components/schemas/teams-devices_revoked_at'
        serial_number:
          $ref: '#/components/schemas/teams-devices_serial_number'
        updated:
          $ref: '#/components/schemas/teams-devices_updated'
        user:
          $ref: '#/components/schemas/teams-devices_user'
        version:
          $ref: '#/components/schemas/teams-devices_version'
      type: object
    teams-devices_devices_policy_certificates:
      properties:
        enabled:
          description: The current status of the device policy certificate provisioning feature for WARP clients.
          example: true
          type: boolean
      required:
        - enabled
      type: object
    teams-devices_devices_policy_certificates_single:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-single'
    teams-devices_devices_response:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/teams-devices_devices'
              type: array
    teams-devices_dex-response_collection:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-collection-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
              type: array
    teams-devices_dex-single_response:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
    teams-devices_dex_target_policy:
      properties:
        default:
          description: Whether the profile is the account default
          type: boolean
        id:
          description: The id of the device settings profile
          type: string
        name:
          description: The name of the device settings profile
          type: string
      type: object
    teams-devices_disable_auto_fallback:
      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 to `true`.
      example: true
      type: boolean
    teams-devices_disable_for_time:
      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"
      type: object
    teams-devices_disk_encryption_input_request:
      properties:
        checkDisks:
          $ref: '#/components/schemas/teams-devices_checkDisks'
        requireAll:
          $ref: '#/components/schemas/teams-devices_requireAll'
      title: Disk Encryption
      type: object
    teams-devices_domain_joined_input_request:
      properties:
        domain:
          description: Domain
          example: example.com
          type: string
        operating_system:
          description: Operating System
          enum:
            - windows
          example: windows
          type: string
      required:
        - operating_system
      title: Domain Joined
      type: object
    teams-devices_email:
      description: The contact email address of the user.
      example: user@example.com
      maxLength: 90
      type: string
    teams-devices_exclude:
      items:
        $ref: '#/components/schemas/teams-devices_split_tunnel'
      type: array
    teams-devices_exclude_office_ips:
      description: Whether to add Microsoft IPs to Split Tunnel exclusions.
      example: true
      type: boolean
    teams-devices_expiration:
      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
      type: string
    teams-devices_extended_key_usage_enum:
      enum:
        - clientAuth
        - emailProtection
      type: string
    teams-devices_fallback_domain:
      properties:
        description:
          description: A description of the fallback domain, displayed in the client UI.
          example: Domain bypass for local development
          maxLength: 100
          type: string
        dns_server:
          description: A list of IP addresses to handle domain resolution.
          items:
            $ref: '#/components/schemas/teams-devices_ip'
          type: array
        suffix:
          description: The domain suffix to match when resolving locally.
          example: example.com
          type: string
      required:
        - suffix
      type: object
    teams-devices_fallback_domain_response_collection:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/teams-devices_fallback_domain'
              type: array
    teams-devices_fallback_domains:
      items:
        $ref: '#/components/schemas/teams-devices_fallback_domain'
      type: array
    teams-devices_file_input_request:
      properties:
        exists:
          description: Whether or not file exists
          example: true
          type: boolean
        operating_system:
          description: Operating system
          enum:
            - windows
            - linux
            - mac
          example: mac
          type: string
        path:
          description: File path.
          example: /bin/cat
          type: string
        sha256:
          description: SHA-256.
          example: https://api.us-2.crowdstrike.com
          type: string
        thumbprint:
          description: Signing certificate thumbprint.
          example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e
          type: string
      required:
        - path
        - operating_system
      title: File Check
      type: object
    teams-devices_firewall_input_request:
      properties:
        enabled:
          description: Enabled
          example: true
          type: boolean
        operating_system:
          description: Operating System
          enum:
            - windows
            - mac
          example: windows
          type: string
      required:
        - operating_system
        - enabled
      title: Firewall
      type: object
    teams-devices_gateway_unique_id:
      example: 699d98642c564d2e855e9661899b7252
      type: string
    teams-devices_id_response:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/teams-devices_uuid'
              type: object
    teams-devices_identifier:
      example: 699d98642c564d2e855e9661899b7252
    teams-devices_include:
      items:
        $ref: '#/components/schemas/teams-devices_split_tunnel_include'
      type: array
    teams-devices_input:
      description: The value to be checked against.
      example:
        operating_system: linux
        path: /bin/cat
        thumbprint: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e
      oneOf:
        - $ref: '#/components/schemas/teams-devices_file_input_request'
        - $ref: '#/components/schemas/teams-devices_unique_client_id_input_request'
        - $ref: '#/components/schemas/teams-devices_domain_joined_input_request'
        - $ref: '#/components/schemas/teams-devices_os_version_input_request'
        - $ref: '#/components/schemas/teams-devices_firewall_input_request'
        - $ref: '#/components/schemas/teams-devices_sentinelone_input_request'
        - $ref: '#/components/schemas/teams-devices_carbonblack_input_request'
        - $ref: '#/components/schemas/teams-devices_disk_encryption_input_request'
        - $ref: '#/components/schemas/teams-devices_application_input_request'
        - $ref: '#/components/schemas/teams-devices_client_certificate_input_request'
        - $ref: '#/components/schemas/teams-devices_client_certificate_v2_input_request'
        - $ref: '#/components/schemas/teams-devices_workspace_one_input_request'
        - $ref: '#/components/schemas/teams-devices_crowdstrike_input_request'
        - $ref: '#/components/schemas/teams-devices_intune_input_request'
        - $ref: '#/components/schemas/teams-devices_kolide_input_request'
        - $ref: '#/components/schemas/teams-devices_tanium_input_request'
        - $ref: '#/components/schemas/teams-devices_sentinelone_s2s_input_request'
        - $ref: '#/components/schemas/teams-devices_custom_s2s_input_request'
      type: object
    teams-devices_interval:
      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
      type: string
    teams-devices_intune_config_request:
      properties:
        client_id:
          description: The Intune client ID.
          example: example client id
          type: string
        client_secret:
          description: The Intune client secret.
          example: example client secret
          type: string
        customer_id:
          description: The Intune customer ID.
          example: example customer id
          type: string
      required:
        - customer_id
        - client_id
        - client_secret
      title: Intune Config
      type: object
    teams-devices_intune_input_request:
      properties:
        compliance_status:
          description: Compliance Status
          enum:
            - compliant
            - noncompliant
            - unknown
            - notapplicable
            - ingraceperiod
            - error
          example: compliant
          type: string
        connection_id:
          description: Posture Integration ID.
          example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
          type: string
      required:
        - connection_id
        - compliance_status
      title: Intune S2S Input
      type: object
    teams-devices_ip:
      description: IPv4 or IPv6 address.
      example: 1.1.1.1
      type: string
    teams-devices_key:
      description: The device's public key.
      example: yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc=
      type: string
    teams-devices_kolide_config_request:
      properties:
        client_id:
          description: The Kolide client ID.
          example: example client id
          type: string
        client_secret:
          description: The Kolide client secret.
          example: example client secret
          type: string
      required:
        - client_id
        - client_secret
      title: Kolide Config
      type: object
    teams-devices_kolide_input_request:
      properties:
        connection_id:
          description: Posture Integration ID.
          example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
          type: string
        countOperator:
          description: Count Operator
          enum:
            - <
            - <=
            - '>'
            - '>='
            - ==
          example: '>'
          type: string
        issue_count:
          description: The Number of Issues.
          example: 1
          type: string
      required:
        - connection_id
        - countOperator
        - issue_count
      title: Kolide S2S Input
      type: object
    teams-devices_lan_allow_minutes:
      description: The amount of time in minutes a user is allowed access to their LAN. A value of 0 will allow LAN access until the next WARP reconnection, such as a reboot or a laptop waking from sleep. Note that this field is omitted from the response if null or unset.
      example: 30
      type: number
    teams-devices_lan_allow_subnet_size:
      description: The size of the subnet for the local access network. Note that this field is omitted from the response if null or unset.
      example: 24
      type: number
    teams-devices_last_seen:
      description: When the device last connected to Cloudflare services.
      example: "2017-06-14T00:00:00Z"
      format: date-time
      type: string
    teams-devices_mac_address:
      description: The device mac address.
      example: 00-00-5E-00-53-00
      type: string
    teams-devices_manufacturer:
      description: The device manufacturer name.
      example: My phone corp
      type: string
    teams-devices_match:
      description: The conditions that the client must match to run the rule.
      items:
        $ref: '#/components/schemas/teams-devices_match_item'
      type: array
    teams-devices_match_item:
      properties:
        platform:
          $ref: '#/components/schemas/teams-devices_platform'
      type: object
    teams-devices_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    teams-devices_model:
      description: The device model name.
      example: MyPhone(pro-X)
      type: string
    teams-devices_name:
      description: The name of the device posture rule.
      example: Admin Serial Numbers
      type: string
    teams-devices_os_distro_name:
      description: The Linux distro name.
      example: ubuntu
      type: string
    teams-devices_os_distro_revision:
      description: The Linux distro revision.
      example: 1.0.0
      type: string
    teams-devices_os_version:
      description: The operating system version.
      example: 10.0.0
      type: string
    teams-devices_os_version_extra:
      description: The operating system version extra parameter.
      example: (a)
      type: string
    teams-devices_os_version_input_request:
      properties:
        operating_system:
          description: Operating System
          enum:
            - windows
          example: windows
          type: string
        operator:
          description: Operator
          enum:
            - <
            - <=
            - '>'
            - '>='
            - ==
          example: 13.3.0
          type: string
        os_distro_name:
          description: Operating System Distribution Name (linux only)
          example: ubuntu
          type: string
        os_distro_revision:
          description: Version of OS Distribution (linux only)
          example: 11.3.1
          type: string
        os_version_extra:
          description: Additional version data. For Mac or iOS, the Product Verison Extra. For Linux, the kernel release version. (Mac, iOS, and Linux only)
          example: (a) or -1007
          type: string
        version:
          description: Version of OS
          example: 13.3.0
          type: string
      required:
        - operating_system
        - version
        - operator
      title: OS Version
      type: object
    teams-devices_override_codes_response:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-collection'
        - properties:
            result:
              properties:
                disable_for_time:
                  $ref: '#/components/schemas/teams-devices_disable_for_time'
              type: object
    teams-devices_paths:
      description: List of paths to check for client certificate on linux.
      example:
        - /path1
        - /path2
      items:
        type: string
      type: array
    teams-devices_platform:
      enum:
        - windows
        - mac
        - linux
        - android
        - ios
      example: windows
      type: string
    teams-devices_precedence:
      description: The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field.
      example: 100
      type: number
    teams-devices_requireAll:
      description: Whether to check all disks for encryption.
      example: true
      type: boolean
    teams-devices_response_collection:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/teams-devices_device-posture-rules'
              type: array
    teams-devices_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    teams-devices_revoke_devices_request:
      description: A list of device ids to revoke.
      items:
        $ref: '#/components/schemas/teams-devices_schemas-uuid'
      maxLength: 200
      type: array
    teams-devices_revoked_at:
      description: When the device was revoked.
      example: "2017-06-14T00:00:00Z"
      format: date-time
      type: string
    teams-devices_schedule:
      description: 'Polling frequency for the WARP client posture check. Default: `5m` (poll every five minutes). Minimum: `1m`.'
      example: 1h
      type: string
    teams-devices_schemas-config_request:
      description: The configuration object containing information for the WARP client to detect the managed network.
      example:
        sha256: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
        tls_sockaddr: foo.bar:1234
      oneOf:
        - $ref: '#/components/schemas/teams-devices_tls_config_request'
      type: object
    teams-devices_schemas-config_response:
      description: The configuration object containing information for the WARP client to detect the managed network.
      example:
        sha256: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
        tls_sockaddr: foo.bar:1234
      oneOf:
        - $ref: '#/components/schemas/teams-devices_tls_config_response'
      type: object
    teams-devices_schemas-description:
      description: A description of the policy.
      example: Policy for test teams.
      maxLength: 500
      type: string
    teams-devices_schemas-id_response:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-single'
        - properties:
            result:
              nullable: true
              type: object
    teams-devices_schemas-match:
      description: The wirefilter expression to match devices.
      example: user.identity == "test@cloudflare.com"
      maxLength: 500
      type: string
    teams-devices_schemas-name:
      description: The device name.
      example: My mobile device
      type: string
    teams-devices_schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/teams-devices_device-posture-integrations'
              type: array
    teams-devices_schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/teams-devices_device-posture-integrations'
    teams-devices_schemas-type:
      description: The type of device posture integration.
      enum:
        - workspace_one
        - crowdstrike_s2s
        - uptycs
        - intune
        - kolide
        - tanium
        - sentinelone_s2s
        - custom_s2s
      example: workspace_one
      type: string
    teams-devices_schemas-uuid:
      description: Device ID.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    teams-devices_sentinelone_input_request:
      properties:
        operating_system:
          description: Operating system
          enum:
            - windows
            - linux
            - mac
          example: mac
          type: string
        path:
          description: File path.
          example: /bin/cat
          type: string
        sha256:
          description: SHA-256.
          example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
          type: string
        thumbprint:
          description: Signing certificate thumbprint.
          example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e
          type: string
      required:
        - path
        - operating_system
      title: Sentinelone
      type: object
    teams-devices_sentinelone_s2s_config_request:
      properties:
        api_url:
          description: The SentinelOne S2S API URL.
          example: https://example.sentinelone.net
          type: string
        client_secret:
          description: The SentinelOne S2S client secret.
          example: example client secret
          type: string
      required:
        - api_url
        - client_secret
      title: SentinelOne S2S Config
      type: object
    teams-devices_sentinelone_s2s_input_request:
      properties:
        active_threats:
          description: The Number of active threats.
          example: 1
          type: number
        connection_id:
          description: Posture Integration ID.
          example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
          type: string
        infected:
          description: Whether device is infected.
          example: true
          type: boolean
        is_active:
          description: Whether device is active.
          example: true
          type: boolean
        network_status:
          description: Network status of device.
          enum:
            - connected
            - disconnected
            - disconnecting
            - connecting
          example: connected
          type: string
        operator:
          description: operator
          enum:
            - <
            - <=
            - '>'
            - '>='
            - ==
          example: '>'
          type: string
      required:
        - connection_id
      title: SentinelOne S2S Input
      type: object
    teams-devices_serial_number:
      description: The device serial number.
      example: EXAMPLEHMD6R
      type: string
    teams-devices_service_mode_v2:
      properties:
        mode:
          description: The mode to run the WARP client under.
          example: proxy
          type: string
        port:
          description: The port number when used with proxy mode.
          example: 3000
          type: number
      type: object
    teams-devices_single_response:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/teams-devices_device-posture-rules'
    teams-devices_split_tunnel:
      properties:
        address:
          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
          type: string
        description:
          description: A description of the Split Tunnel item, displayed in the client UI.
          example: Exclude testing domains from the tunnel
          maxLength: 100
          type: string
        host:
          description: The domain name to exclude from the tunnel. If `host` is present, `address` must not be present.
          example: '*.example.com'
          type: string
      required:
        - address
        - description
      type: object
    teams-devices_split_tunnel_include:
      properties:
        address:
          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
          type: string
        description:
          description: A description of the split tunnel item, displayed in the client UI.
          example: Include testing domains from the tunnel
          maxLength: 100
          type: string
        host:
          description: The domain name to include in the tunnel. If host is present, address must not be present.
          example: '*.example.com'
          type: string
      required:
        - address
        - description
      type: object
    teams-devices_split_tunnel_include_response_collection:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/teams-devices_split_tunnel_include'
              type: array
    teams-devices_split_tunnel_response_collection:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/teams-devices_split_tunnel'
              type: array
    teams-devices_support_url:
      description: The URL to launch when the Send Feedback button is clicked.
      example: https://1.1.1.1/help
      type: string
    teams-devices_switch_locked:
      description: Whether to allow the user to turn off the WARP switch and disconnect the client.
      example: true
      type: boolean
    teams-devices_tanium_config_request:
      properties:
        access_client_id:
          description: If present, this id will be passed in the `CF-Access-Client-ID` header when hitting the `api_url`
          example: 88bf3b6d86161464f6509f7219099e57.access
          type: string
        access_client_secret:
          description: If present, this secret will be passed in the `CF-Access-Client-Secret` header when hitting the `api_url`
          example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5
          type: string
        api_url:
          description: The Tanium API URL.
          example: https://dummy-tanium-api.cloudflare.com/plugin/products/gateway/graphql
          type: string
        client_secret:
          description: The Tanium client secret.
          example: example client secret
          type: string
      required:
        - api_url
        - client_secret
      title: Tanium Config
      type: object
    teams-devices_tanium_input_request:
      properties:
        connection_id:
          description: Posture Integration ID.
          example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
          type: string
        eid_last_seen:
          description: For more details on eid last seen, refer to the Tanium documentation.
          example: "2023-07-20T23:16:32Z"
          type: string
        operator:
          description: Operator to evaluate risk_level or eid_last_seen.
          enum:
            - <
            - <=
            - '>'
            - '>='
            - ==
          example: '>'
          type: string
        risk_level:
          description: For more details on risk level, refer to the Tanium documentation.
          enum:
            - low
            - medium
            - high
            - critical
          example: low
          type: string
        scoreOperator:
          description: Score Operator
          enum:
            - <
            - <=
            - '>'
            - '>='
            - ==
          example: '>'
          type: string
        total_score:
          description: For more details on total score, refer to the Tanium documentation.
          example: 1
          type: number
      required:
        - connection_id
      title: Tanium S2S Input
      type: object
    teams-devices_target_dex_test:
      properties:
        id:
          description: The id of the DEX test targeting this policy
          type: string
        name:
          description: The name of the DEX test targeting this policy
          type: string
      type: object
    teams-devices_tls_config_request:
      properties:
        sha256:
          description: The SHA-256 hash of the TLS certificate presented by the host found at tls_sockaddr. If absent, regular certificate verification (trusted roots, valid timestamp, etc) will be used to validate the certificate.
          example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
          type: string
        tls_sockaddr:
          description: A network address of the form "host:port" that the WARP client will use to detect the presence of a TLS host.
          example: foobar:1234
          type: string
      required:
        - tls_sockaddr
      type: object
    teams-devices_tls_config_response:
      description: The Managed Network TLS Config Response.
      properties:
        sha256:
          description: The SHA-256 hash of the TLS certificate presented by the host found at tls_sockaddr. If absent, regular certificate verification (trusted roots, valid timestamp, etc) will be used to validate the certificate.
          example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
          type: string
        tls_sockaddr:
          description: A network address of the form "host:port" that the WARP client will use to detect the presence of a TLS host.
          example: foobar:1234
          type: string
      required:
        - tls_sockaddr
      type: object
    teams-devices_trust_stores:
      description: List of trust stores to check for client certificate.
      example:
        - system
        - user
      items:
        $ref: '#/components/schemas/teams-devices_trust_stores_enum'
      type: array
    teams-devices_trust_stores_enum:
      enum:
        - system
        - user
      type: string
    teams-devices_tunnel_protocol:
      description: Determines which tunnel protocol to use.
      example: wireguard
      type: string
    teams-devices_type:
      description: The type of device posture rule.
      enum:
        - file
        - application
        - tanium
        - gateway
        - warp
        - disk_encryption
        - sentinelone
        - carbonblack
        - firewall
        - os_version
        - domain_joined
        - client_certificate
        - client_certificate_v2
        - unique_client_id
        - kolide
        - tanium_s2s
        - crowdstrike_s2s
        - intune
        - workspace_one
        - sentinelone_s2s
        - custom_s2s
      example: file
      type: string
    teams-devices_unique_client_id_input_request:
      properties:
        id:
          description: List ID.
          example: da3de859-8f6e-47ea-a2b5-b2433858471f
          type: string
        operating_system:
          description: Operating System
          enum:
            - android
            - ios
            - chromeos
          example: android
          type: string
      required:
        - operating_system
        - id
      title: Unique Client ID
      type: object
    teams-devices_unrevoke_devices_request:
      description: A list of device ids to unrevoke.
      items:
        $ref: '#/components/schemas/teams-devices_schemas-uuid'
      maxLength: 200
      type: array
    teams-devices_updated:
      description: When the device was updated.
      example: "2017-06-14T00:00:00Z"
      format: date-time
      type: string
    teams-devices_uptycs_config_request:
      properties:
        api_url:
          description: The Uptycs API URL.
          example: rnd.uptycs.io
          type: string
        client_key:
          description: The Uptycs client secret.
          example: example client key
          type: string
        client_secret:
          description: The Uptycs client secret.
          example: example client secret
          type: string
        customer_id:
          description: The Uptycs customer ID.
          example: example customer id
          type: string
      required:
        - api_url
        - client_key
        - customer_id
        - client_secret
      title: Uptycs Config
      type: object
    teams-devices_user:
      properties:
        email:
          $ref: '#/components/schemas/teams-devices_email'
        id:
          $ref: '#/components/schemas/teams-devices_components-schemas-uuid'
        name:
          description: The enrolled device user's name.
          example: John Appleseed
          type: string
      type: object
    teams-devices_uuid:
      description: API UUID.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    teams-devices_version:
      description: The WARP client version.
      example: 1.0.0
      type: string
    teams-devices_workspace_one_config_request:
      properties:
        api_url:
          description: The Workspace One API URL provided in the Workspace One Admin Dashboard.
          example: https://as123.awmdm.com/API
          type: string
        auth_url:
          description: The Workspace One Authorization URL depending on your region.
          example: https://na.uemauth.vmwservices.com/connect/token
          type: string
        client_id:
          description: The Workspace One client ID provided in the Workspace One Admin Dashboard.
          example: example client id
          type: string
        client_secret:
          description: The Workspace One client secret provided in the Workspace One Admin Dashboard.
          example: example client secret
          type: string
      required:
        - api_url
        - auth_url
        - client_id
        - client_secret
      title: Workspace One Config
      type: object
    teams-devices_workspace_one_config_response:
      description: The Workspace One Config Response.
      properties:
        api_url:
          description: The Workspace One API URL provided in the Workspace One Admin Dashboard.
          example: https://as123.awmdm.com/API
          type: string
        auth_url:
          description: The Workspace One Authorization URL depending on your region.
          example: https://na.uemauth.vmwservices.com/connect/token
          type: string
        client_id:
          description: The Workspace One client ID provided in the Workspace One Admin Dashboard.
          example: example client id
          type: string
      required:
        - api_url
        - auth_url
        - client_id
      type: object
    teams-devices_workspace_one_input_request:
      properties:
        compliance_status:
          description: Compliance Status
          enum:
            - compliant
            - noncompliant
            - unknown
          example: compliant
          type: string
        connection_id:
          description: Posture Integration ID.
          example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
          type: string
      required:
        - connection_id
        - compliance_status
      title: Workspace One S2S Input
      type: object
    teams-devices_zero-trust-account-device-settings:
      properties:
        disable_for_time:
          description: Sets the time limit, in seconds, that a user can use an override code to bypass WARP.
          type: number
        gateway_proxy_enabled:
          description: Enable gateway proxy filtering on TCP.
          example: true
          type: boolean
        gateway_udp_proxy_enabled:
          description: Enable gateway proxy filtering on UDP.
          example: true
          type: boolean
        root_certificate_installation_enabled:
          description: Enable installation of cloudflare managed root certificate.
          example: true
          type: boolean
        use_zt_virtual_ip:
          description: Enable using CGNAT virtual IPv4.
          example: true
          type: boolean
      type: object
    teams-devices_zero-trust-account-device-settings-response:
      allOf:
        - $ref: '#/components/schemas/teams-devices_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings'
      type: object
    tls-certificates-and-hostnames_advanced_certificate_pack_response_single:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              properties:
                certificate_authority:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_authority'
                cloudflare_branding:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_cloudflare_branding'
                hosts:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hosts'
                id:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
                status:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate-packs_components-schemas-status'
                type:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_type'
                validation_method:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_method'
                validity_days:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_validity_days'
              type: object
          type: object
    tls-certificates-and-hostnames_advanced_type:
      description: Type of certificate pack.
      enum:
        - advanced
      example: advanced
      type: string
    tls-certificates-and-hostnames_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_result_info'
      type: object
    tls-certificates-and-hostnames_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
        messages:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    tls-certificates-and-hostnames_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    tls-certificates-and-hostnames_api-response-single:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common'
      type: object
    tls-certificates-and-hostnames_association_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_associationObject'
              type: array
    tls-certificates-and-hostnames_associationObject:
      properties:
        service:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_service'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-status'
    tls-certificates-and-hostnames_base:
      properties:
        created_on:
          description: When the Keyless SSL was created.
          example: "2014-01-01T05:20:00Z"
          format: date-time
          readOnly: true
          type: string
        enabled:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled'
        host:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_host'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-identifier'
        modified_on:
          description: When the Keyless SSL was last modified.
          example: "2014-01-01T05:20:00Z"
          format: date-time
          readOnly: true
          type: string
        name:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_name'
        permissions:
          description: Available permissions for the Keyless SSL for the current user requesting the item.
          example:
            - '#ssl:read'
            - '#ssl:edit'
          items:
            type: string
          readOnly: true
          type: array
        port:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_port'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-status'
        tunnel:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_tunnel'
      required:
        - id
        - name
        - host
        - port
        - status
        - enabled
        - permissions
        - created_on
        - modified_on
      type: object
    tls-certificates-and-hostnames_brand_check:
      description: Certificate Authority is manually reviewing the order.
      example: false
      type: boolean
    tls-certificates-and-hostnames_bundle_method:
      default: ubiquitous
      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
      example: ubiquitous
      type: string
    tls-certificates-and-hostnames_ca:
      description: Indicates whether the certificate is a CA or leaf certificate.
      example: true
      type: boolean
    tls-certificates-and-hostnames_cert_id:
      description: Certificate identifier tag.
      example: 2458ce5a-0c35-4c7f-82c7-8e9487d3ff60
      maxLength: 36
      type: string
    tls-certificates-and-hostnames_cert_pack_uuid:
      description: Certificate Pack UUID.
      example: a77f8bd7-3b47-46b4-a6f1-75cf98109948
      type: string
    tls-certificates-and-hostnames_certificate:
      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-----
      type: string
    tls-certificates-and-hostnames_certificate-packs_components-schemas-status:
      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
      type: string
    tls-certificates-and-hostnames_certificate_analyze_response:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              type: object
    tls-certificates-and-hostnames_certificate_authority:
      description: The Certificate Authority that will issue the certificate
      enum:
        - digicert
        - google
        - lets_encrypt
        - ssl_com
      example: google
      type: string
    tls-certificates-and-hostnames_certificate_pack_quota_response:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              properties:
                advanced:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_quota'
              type: object
          type: object
    tls-certificates-and-hostnames_certificate_pack_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
        - properties:
            result:
              items:
                type: object
              type: array
    tls-certificates-and-hostnames_certificate_pack_response_single:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              type: object
          type: object
    tls-certificates-and-hostnames_certificate_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_custom-certificate'
              type: array
    tls-certificates-and-hostnames_certificate_response_id_only:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
              type: object
    tls-certificates-and-hostnames_certificate_response_single:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_custom-certificate'
    tls-certificates-and-hostnames_certificate_response_single_post:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificateObjectPost'
              type: object
    tls-certificates-and-hostnames_certificate_revoke_response:
      allOf:
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
                revoked_at:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_revoked_at'
          type: object
    tls-certificates-and-hostnames_certificate_status:
      description: Current status of certificate.
      enum:
        - initializing
        - authorizing
        - active
        - expired
        - issuing
        - timing_out
        - pending_deployment
      example: active
      type: string
    tls-certificates-and-hostnames_certificateObject:
      properties:
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-expires_on'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        issuer:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_issuer'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_signature'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-status'
        uploaded_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-uploaded_on'
    tls-certificates-and-hostnames_certificateObjectPost:
      properties:
        ca:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_ca'
        certificates:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificates'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-expires_on'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        issuer:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-issuer'
        name:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-name'
        serial_number:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-serial_number'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_signature'
        updated_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-updated_at'
        uploaded_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on'
    tls-certificates-and-hostnames_certificates:
      properties:
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate'
        csr:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_csr'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-expires_on'
        hostnames:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostnames'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        request_type:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_request_type'
        requested_validity:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_requested_validity'
      required:
        - hostnames
        - csr
        - requested_validity
        - request_type
      type: object
    tls-certificates-and-hostnames_client-certificates_components-schemas-certificate:
      description: The Client Certificate PEM
      example: '-----BEGIN CERTIFICATE-----\nMIIDmDCCAoC...dhDDE\n-----END CERTIFICATE-----'
      readOnly: true
      type: string
    tls-certificates-and-hostnames_client-certificates_components-schemas-certificate_authority:
      description: Certificate Authority used to issue the Client Certificate
      properties:
        id:
          example: 568b6b74-7b0c-4755-8840-4e3b8c24adeb
          type: string
        name:
          example: Cloudflare Managed CA for account
          type: string
      type: object
    tls-certificates-and-hostnames_client-certificates_components-schemas-status:
      description: Client Certificates may be active or revoked, and the pending_reactivation or pending_revocation represent in-progress asynchronous transitions
      enum:
        - active
        - pending_reactivation
        - pending_revocation
        - revoked
      example: active
    tls-certificates-and-hostnames_client_certificate:
      properties:
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_client-certificates_components-schemas-certificate'
        certificate_authority:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_client-certificates_components-schemas-certificate_authority'
        common_name:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_common_name'
        country:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_country'
        csr:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-csr'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_expired_on'
        fingerprint_sha256:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_fingerprint_sha256'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        issued_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_issued_on'
        location:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_location'
        organization:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_organization'
        organizational_unit:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_organizational_unit'
        serial_number:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-serial_number'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-signature'
        ski:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_ski'
        state:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_state'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_client-certificates_components-schemas-status'
        validity_days:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-validity_days'
    tls-certificates-and-hostnames_client_certificate_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate'
              type: array
    tls-certificates-and-hostnames_client_certificate_response_single:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate'
    tls-certificates-and-hostnames_cloudflare_branding:
      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
      type: boolean
    tls-certificates-and-hostnames_common_name:
      description: Common Name of the Client Certificate
      example: Cloudflare
      readOnly: true
      type: string
    tls-certificates-and-hostnames_components-schemas-certificate:
      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
      type: string
    tls-certificates-and-hostnames_components-schemas-certificate_authority:
      description: The Certificate Authority that Total TLS certificates will be issued through.
      enum:
        - google
        - lets_encrypt
        - ssl_com
      example: google
      type: string
    tls-certificates-and-hostnames_components-schemas-certificate_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull'
              type: array
    tls-certificates-and-hostnames_components-schemas-certificate_response_single:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull'
    tls-certificates-and-hostnames_components-schemas-certificateObject:
      properties:
        ca:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_ca'
        certificates:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificates'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-expires_on'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        issuer:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-issuer'
        name:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-name'
        serial_number:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-serial_number'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_signature'
        uploaded_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on'
    tls-certificates-and-hostnames_components-schemas-created_at:
      description: The time when the certificate was created.
      example: "2100-01-01T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    tls-certificates-and-hostnames_components-schemas-enabled:
      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
      type: boolean
    tls-certificates-and-hostnames_components-schemas-expires_on:
      description: When the certificate from the authority expires.
      example: "2100-01-01T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    tls-certificates-and-hostnames_components-schemas-hostname:
      description: The hostname for which the tls settings are set.
      example: app.example.com
      type: string
    tls-certificates-and-hostnames_components-schemas-private_key:
      description: The private key for the certificate
      example: |-
        -----BEGIN PRIVATE KEY-----
        MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDEXDkcICRU3XBv9hiiPnBWIjgTQyowmVFxDr11mONgZB/cMYjE/OvQjvnpwNcOaSK16MOpAjNbELKRx2lZiVJaLRDCccqCxXwP/CrdRChcqGzo7mbNksMlcidrErb0LlEBKLFC2QjRmRKqB+YOs4TD8WsZu2S667A2fZmjRlaqOxFi1h62ee0P+TLU628UC/nl41JifSt5Evt7hMDHakemdwZblNYr2p6T3NQjdhjYXTtP4UmOGJBhJ7i7Kicg3d3CIgdTMbggSeGWqjndr4ldVnD96FN3cVT5uDFsn2CJXTFgdeBWoUnMS4VnUZzPWGf4vSBXC8qV7Ls+w46yT7T1AgMBAAECggEAQZnp/oqCeNPOR6l5S2L+1tfx0gWjZ78hJVteUpZ0iHSK7F6kKeOxyOird7vUXV0kmo+cJq+0hp0Ke4eam640FCpwKfYoSQ4/R3vgujGWJnaihCN5tv5sMet0XeJPuz5qE7ALoKCvwI6aXLHs20aAeZIDTQJ9QbGSGnJVzOWn+JDTidIgZpN57RpXfSAwnJPTQK/PN8i5z108hsaDOdEgGmxYZ7kYqMqzX20KXmth58LDfPixs5JGtS60iiKC/wOcGzkB2/AdTSojR76oEU77cANP/3zO25NG//whUdYlW0t0d7PgXxIeJe+xgYnamDQJx3qonVyt4H77ha0ObRAj9QKBgQDicZr+VTwFMnELP3a+FXGnjehRiuS1i7MXGKxNweCD+dFlML0FplSQS8Ro2n+d8lu8BBXGx0qm6VXu8Rhn7TAUL6q+PCgfarzxfIhacb/TZCqfieIHsMlVBfhV5HCXnk+kis0tuC/PRArcWTwDHJUJXkBhvkUsNswvQzavDPI7KwKBgQDd/WgLkj7A3X5fgIHZH/GbDSBiXwzKb+rF4ZCT2XFgG/OAW7vapfcX/w+v+5lBLyrocmOAS3PGGAhM5T3HLnUCQfnK4qgps1Lqibkc9Tmnsn60LanUjuUMsYv/zSw70tozbzhJ0pioEpWfRxRZBztO2Rr8Ntm7h6Fk701EXGNAXwKBgQCD1xsjy2J3sCerIdcz0u5qXLAPkeuZW+34m4/ucdwTWwc0gEz9lhsULFj9p4G351zLuiEnq+7mAWLcDJlmIO3mQt6JhiLiL9Y0T4pgBmxmWqKKYtAsJB0EmMY+1BNN44mBRqMxZFTJu1cLdhT/xstrOeoIPqytknYNanfTMZlzIwKBgHrLXe5oq0XMP8dcMneEcAUwsaU4pr6kQd3L9EmUkl5zl7J9C+DaxWAEuwzBw/iGutlxzRB+rD/7szu14wJ29EqXbDGKRzMp+se5/yfBjm7xEZ1hVPw7PwBShfqt57X/4Ktq7lwHnmH6RcGhc+P7WBc5iO/S94YAdIp8xOT3pf9JAoGAE0QkqJUY+5Mgr+fBO0VNV72ZoPveGpW+De59uhKAOnu1zljQCUtk59m6+DXfm0tNYKtawa5n8iN71Zh+s62xXSt3pYi1Y5CCCmv8Y4BhwIcPwXKk3zEvLgSHVTpC0bayA9aSO4bbZgVXa5w+Z0w/vvfp9DWo1IS3EnQRrz6WMYA=
        -----END PRIVATE KEY-----
      type: string
    tls-certificates-and-hostnames_components-schemas-serial_number:
      description: The serial number on the created Client Certificate.
      example: 3bb94ff144ac567b9f75ad664b6c55f8d5e48182
      readOnly: true
      type: string
    tls-certificates-and-hostnames_components-schemas-signature:
      description: The type of hash used for the Client Certificate..
      example: SHA256WithRSA
      readOnly: true
      type: string
    tls-certificates-and-hostnames_components-schemas-status:
      description: Status of the hostname's activation.
      enum:
        - active
        - pending
        - active_redeploying
        - moved
        - pending_deletion
        - deleted
        - pending_blocked
        - pending_migration
        - pending_provisioned
        - test_pending
        - test_active
        - test_active_apex
        - test_blocked
        - test_failed
        - provisioned
        - blocked
      example: pending
    tls-certificates-and-hostnames_components-schemas-updated_at:
      description: This is the time the certificate was updated.
      example: "2022-11-22T17:32:30.467938Z"
      format: date-time
      type: string
    tls-certificates-and-hostnames_components-schemas-uploaded_on:
      description: The time when the certificate was uploaded.
      example: "2019-10-28T18:11:23.37411Z"
      format: date-time
      type: string
    tls-certificates-and-hostnames_components-schemas-validation_method:
      properties:
        validation_method:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_method_definition'
      required:
        - validation_method
      type: object
    tls-certificates-and-hostnames_config:
      items:
        $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_certid_input'
      type: array
    tls-certificates-and-hostnames_country:
      description: Country, provided by the CSR
      example: US
      readOnly: true
      type: string
    tls-certificates-and-hostnames_created_at:
      description: This is the time the hostname was created.
      example: "2020-02-06T18:11:23.531995Z"
      format: date-time
      type: string
    tls-certificates-and-hostnames_csr:
      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-----
      type: string
    tls-certificates-and-hostnames_custom-certificate:
      properties:
        bundle_method:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_bundle_method'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_expires_on'
        geo_restrictions:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_geo_restrictions'
        hosts:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hosts'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        issuer:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_issuer'
        keyless_server:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless-certificate'
        modified_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_modified_on'
        policy:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_policy'
        priority:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_priority'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_signature'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_status'
        uploaded_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_uploaded_on'
        zone_id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      required:
        - id
        - hosts
        - issuer
        - signature
        - status
        - bundle_method
        - zone_id
        - uploaded_on
        - modified_on
        - expires_on
        - priority
      type: object
    tls-certificates-and-hostnames_custom-hostname:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_customhostname'
      properties:
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        ssl:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl'
      required:
        - id
        - hostname
        - ssl
      type: object
    tls-certificates-and-hostnames_custom-hostname-fallback-origin_components-schemas-status:
      description: Status of the fallback origin's activation.
      enum:
        - initializing
        - pending_deployment
        - pending_deletion
        - active
        - deployment_timed_out
        - deletion_timed_out
      example: pending_deployment
    tls-certificates-and-hostnames_custom_hostname_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_custom-hostname'
              type: array
    tls-certificates-and-hostnames_custom_hostname_response_single:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom-hostname'
              type: object
    tls-certificates-and-hostnames_custom_metadata:
      additionalProperties:
        type: string
      description: Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
      type: object
    tls-certificates-and-hostnames_custom_origin_server:
      description: a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
      example: origin2.example.com
      type: string
    tls-certificates-and-hostnames_custom_origin_sni:
      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
      type: string
    tls-certificates-and-hostnames_customhostname:
      properties:
        created_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_created_at'
        custom_metadata:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_metadata'
        custom_origin_server:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_server'
        custom_origin_sni:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_sni'
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        ownership_verification:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_ownership_verification'
        ownership_verification_http:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_ownership_verification_http'
        ssl:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-status'
        verification_errors:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_verification_errors'
    tls-certificates-and-hostnames_dcv_delegation_response:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_uuidObject'
              type: object
    tls-certificates-and-hostnames_delete_advanced_certificate_pack_response_single:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
              type: object
          type: object
    tls-certificates-and-hostnames_enabled:
      description: Whether or not the Keyless SSL is on or off.
      example: false
      readOnly: true
      type: boolean
    tls-certificates-and-hostnames_enabled_response:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              properties:
                enabled:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled'
    tls-certificates-and-hostnames_enabled_write:
      deprecated: true
      description: Whether or not the Keyless SSL is on or off.
      example: false
      type: boolean
    tls-certificates-and-hostnames_errors:
      description: These are errors that were encountered while trying to activate a fallback origin.
      example:
        - DNS records are not setup correctly. Origin should be a proxied A/AAAA/CNAME dns record
      items:
        type: string
      type: array
    tls-certificates-and-hostnames_expired_on:
      description: Date that the Client Certificate expires
      example: "2033-02-20T23:18:00Z"
      readOnly: true
      type: string
    tls-certificates-and-hostnames_expires_on:
      description: When the certificate from the authority expires.
      example: "2016-01-01T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    tls-certificates-and-hostnames_fallback_origin_response:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_fallbackorigin'
    tls-certificates-and-hostnames_fallbackorigin:
      properties:
        created_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-created_at'
        errors:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_errors'
        origin:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_origin'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_custom-hostname-fallback-origin_components-schemas-status'
        updated_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_updated_at'
    tls-certificates-and-hostnames_fingerprint_sha256:
      description: Unique identifier of the Client Certificate
      example: 256c24690243359fb8cf139a125bd05ebf1d968b71e4caf330718e9f5c8a89ea
      readOnly: true
      type: string
    tls-certificates-and-hostnames_geo_restrictions:
      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
      type: object
    tls-certificates-and-hostnames_host:
      description: The keyless SSL name.
      example: example.com
      format: hostname
      maxLength: 253
      type: string
    tls-certificates-and-hostnames_hostname:
      description: The custom hostname that will point to your hostname via CNAME.
      example: app.example.com
      maxLength: 255
      readOnly: true
      type: string
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_certid_object'
      properties:
        cert_id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate'
        enabled:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled'
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostname'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        private_key:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-private_key'
      type: object
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate:
      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-----
      type: string
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull'
              type: array
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_single:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificateObject'
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled:
      description: Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association.
      example: true
      nullable: true
      type: boolean
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-expires_on:
      description: The date when the certificate expires.
      example: "2100-01-01T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status:
      description: Status of the certificate or the association.
      enum:
        - initializing
        - pending_deployment
        - pending_deletion
        - active
        - deleted
        - deployment_timed_out
        - deletion_timed_out
      example: active
      readOnly: true
    tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-created_at:
      description: This is the time the tls setting was originally created for this hostname.
      example: "2023-07-10T20:01:50.219171Z"
      format: date-time
      type: string
    tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status:
      description: Deployment status for the given tls setting.
      example: pending_deployment
      type: string
    tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-updated_at:
      description: This is the time the tls setting was updated.
      example: "2023-07-10T20:01:50.219171Z"
      format: date-time
      type: string
    tls-certificates-and-hostnames_hostname_aop_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull'
              type: array
    tls-certificates-and-hostnames_hostname_aop_single_response:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_certid_object'
    tls-certificates-and-hostnames_hostname_association:
      properties:
        hostnames:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostnames'
        mtls_certificate_id:
          description: The UUID for a certificate that was uploaded to the mTLS Certificate Management endpoint. If no mtls_certificate_id is given, the hostnames will be associated to your active Cloudflare Managed CA.
          maxLength: 36
          minLength: 36
          type: string
      type: object
    tls-certificates-and-hostnames_hostname_associations_response:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              properties:
                hostnames:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostnames'
              type: object
    tls-certificates-and-hostnames_hostname_certid_input:
      properties:
        cert_id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_cert_id'
        enabled:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled'
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostname'
      type: object
    tls-certificates-and-hostnames_hostname_certid_object:
      properties:
        cert_id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        cert_status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status'
        cert_updated_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-updated_at'
        cert_uploaded_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-uploaded_on'
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate'
        created_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-created_at'
        enabled:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-expires_on'
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostname'
        issuer:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_issuer'
        serial_number:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_serial_number'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_signature'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status'
        updated_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-updated_at'
    tls-certificates-and-hostnames_hostname_post:
      description: The custom hostname that will point to your hostname via CNAME.
      example: app.example.com
      maxLength: 255
      type: string
    tls-certificates-and-hostnames_hostnames:
      description: Array of hostnames or wildcard names (e.g., *.example.com) bound to the certificate.
      example:
        - example.com
        - '*.example.com'
      items:
        type: string
      type: array
    tls-certificates-and-hostnames_hosts:
      items:
        description: The valid hosts for the certificates.
        example: example.com
        maxLength: 253
        readOnly: true
        type: string
      type: array
    tls-certificates-and-hostnames_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    tls-certificates-and-hostnames_issued_on:
      description: Date that the Client Certificate was issued by the Certificate Authority
      example: "2023-02-23T23:18:00Z"
      readOnly: true
      type: string
    tls-certificates-and-hostnames_issuer:
      description: The certificate authority that issued the certificate.
      example: GlobalSign
      readOnly: true
      type: string
    tls-certificates-and-hostnames_keyless-certificate:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_base'
      type: object
    tls-certificates-and-hostnames_keyless_private_ip:
      description: Private IP of the Key Server Host
      example: 10.0.0.1
      type: string
    tls-certificates-and-hostnames_keyless_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless-certificate'
              type: array
    tls-certificates-and-hostnames_keyless_response_single:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_base'
              type: object
    tls-certificates-and-hostnames_keyless_response_single_id:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
              type: object
    tls-certificates-and-hostnames_keyless_tunnel:
      description: Configuration for using Keyless SSL through a Cloudflare Tunnel
      properties:
        private_ip:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_private_ip'
        vnet_id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_vnet_id'
      required:
        - private_ip
        - vnet_id
      type: object
    tls-certificates-and-hostnames_keyless_vnet_id:
      description: Cloudflare Tunnel Virtual Network ID
      example: 7365377a-85a4-4390-9480-531ef7dc7a3c
      type: string
    tls-certificates-and-hostnames_location:
      description: Location, provided by the CSR
      example: Somewhere
      readOnly: true
      type: string
    tls-certificates-and-hostnames_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    tls-certificates-and-hostnames_modified_on:
      description: When the certificate was last modified.
      example: "2014-01-01T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificateObject'
              type: array
        - properties:
            result_info:
              properties:
                count:
                  example: 1
                page:
                  example: 1
                per_page:
                  example: 50
                total_count:
                  example: 1
                total_pages:
                  description: Total pages available of results
                  example: 1
                  type: number
              type: object
    tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificateObject'
              type: object
    tls-certificates-and-hostnames_mtls-management_components-schemas-expires_on:
      description: When the certificate expires.
      example: "2122-10-29T16:59:47Z"
      format: date-time
      readOnly: true
      type: string
    tls-certificates-and-hostnames_mtls-management_components-schemas-status:
      description: Certificate deployment status for the given service.
      example: pending_deployment
      type: string
    tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on:
      description: This is the time the certificate was uploaded.
      example: "2022-11-22T17:32:30.467938Z"
      format: date-time
      type: string
    tls-certificates-and-hostnames_name:
      description: The keyless SSL name.
      example: example.com Keyless SSL
      maxLength: 180
      readOnly: true
      type: string
    tls-certificates-and-hostnames_name_write:
      description: The keyless SSL name.
      example: example.com Keyless SSL
      maxLength: 180
      type: string
    tls-certificates-and-hostnames_organization:
      description: Organization, provided by the CSR
      example: Organization
      readOnly: true
      type: string
    tls-certificates-and-hostnames_organizational_unit:
      description: Organizational Unit, provided by the CSR
      example: Organizational Unit
      readOnly: true
      type: string
    tls-certificates-and-hostnames_origin:
      description: Your origin hostname that requests to your custom hostnames will be sent to.
      example: fallback.example.com
      maxLength: 255
      type: string
    tls-certificates-and-hostnames_ownership_verification:
      description: This is a record which can be placed to activate a hostname.
      oneOf:
        - properties:
            name:
              description: DNS Name for record.
              example: _cf-custom-hostname.app.example.com
              type: string
            type:
              description: DNS Record type.
              enum:
                - txt
              example: txt
            value:
              description: Content for the record.
              example: 5cc07c04-ea62-4a5a-95f0-419334a875a4
              type: string
          type: object
      type: object
    tls-certificates-and-hostnames_ownership_verification_http:
      description: This presents the token to be served by the given http url to activate a hostname.
      oneOf:
        - properties:
            http_body:
              description: Token to be served.
              example: 5cc07c04-ea62-4a5a-95f0-419334a875a4
              type: string
            http_url:
              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: string
          type: object
      type: object
    tls-certificates-and-hostnames_per_hostname_settings_response:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_settingObject'
              type: object
    tls-certificates-and-hostnames_per_hostname_settings_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
        - properties:
            result:
              items:
                properties:
                  created_at:
                    $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-created_at'
                  hostname:
                    $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname'
                  status:
                    $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status'
                  updated_at:
                    $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-updated_at'
                  value:
                    $ref: '#/components/schemas/tls-certificates-and-hostnames_value'
              type: array
        - properties:
            result_info:
              properties:
                count:
                  example: 1
                page:
                  example: 1
                per_page:
                  example: 50
                total_count:
                  example: 1
                total_pages:
                  description: Total pages available of results
                  example: 1
                  type: number
              type: object
    tls-certificates-and-hostnames_per_hostname_settings_response_delete:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_settingObjectDelete'
              type: object
    tls-certificates-and-hostnames_policy:
      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)'
      type: string
    tls-certificates-and-hostnames_port:
      default: 24008
      description: The keyless SSL port used to communicate between Cloudflare and the client's Keyless SSL server.
      example: 24008
      maxLength: 65535
      type: number
    tls-certificates-and-hostnames_priority:
      default: 0
      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.
      example: 1
      type: number
    tls-certificates-and-hostnames_private_key:
      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-----
      type: string
    tls-certificates-and-hostnames_quota:
      properties:
        allocated:
          description: Quantity Allocated.
          type: integer
        used:
          description: Quantity Used.
          type: integer
      type: object
    tls-certificates-and-hostnames_request_type:
      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
      type: string
    tls-certificates-and-hostnames_requested_validity:
      default: 5475
      description: The number of days for which the certificate should be valid.
      enum:
        - 7
        - 30
        - 90
        - 365
        - 730
        - 1095
        - 5475
      example: 5475
      type: number
    tls-certificates-and-hostnames_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    tls-certificates-and-hostnames_revoked_at:
      description: When the certificate was revoked.
      example: "2024-09-06T18:43:47.928893Z"
      format: date-time
      readOnly: true
      type: string
    tls-certificates-and-hostnames_schemas-certificate:
      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-----'
      type: string
    tls-certificates-and-hostnames_schemas-certificate_authority:
      description: Certificate Authority selected for the order.  For information on any certificate authority specific details or restrictions [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities)
      enum:
        - google
        - lets_encrypt
        - ssl_com
      example: lets_encrypt
      type: string
    tls-certificates-and-hostnames_schemas-certificate_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificates'
              type: array
          type: object
    tls-certificates-and-hostnames_schemas-certificate_response_single:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_certificates'
          type: object
    tls-certificates-and-hostnames_schemas-certificateObject:
      properties:
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-expires_on'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        issuer:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_issuer'
        serial_number:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_serial_number'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_signature'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status'
        uploaded_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-uploaded_on'
    tls-certificates-and-hostnames_schemas-certificates:
      description: The uploaded root CA certificate.
      example: |-
        -----BEGIN CERTIFICATE-----
        MIIDmDCCAoCgAwIBAgIUKTOAZNjcXVZRj4oQt0SHsl1c1vMwDQYJKoZIhvcNAQELBQAwUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjAgFw0yMjExMjIxNjU5NDdaGA8yMTIyMTAyOTE2NTk0N1owUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMRcORwgJFTdcG/2GKI+cFYiOBNDKjCZUXEOvXWY42BkH9wxiMT869CO+enA1w5pIrXow6kCM1sQspHHaVmJUlotEMJxyoLFfA/8Kt1EKFyobOjuZs2SwyVyJ2sStvQuUQEosULZCNGZEqoH5g6zhMPxaxm7ZLrrsDZ9maNGVqo7EWLWHrZ57Q/5MtTrbxQL+eXjUmJ9K3kS+3uEwMdqR6Z3BluU1ivanpPc1CN2GNhdO0/hSY4YkGEnuLsqJyDd3cIiB1MxuCBJ4ZaqOd2viV1WcP3oU3dxVPm4MWyfYIldMWB14FahScxLhWdRnM9YZ/i9IFcLypXsuz7DjrJPtPUCAwEAAaNmMGQwHQYDVR0OBBYEFP5JzLUawNF+c3AXsYTEWHh7z2czMB8GA1UdIwQYMBaAFP5JzLUawNF+c3AXsYTEWHh7z2czMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMA0GCSqGSIb3DQEBCwUAA4IBAQBc+Be7NDhpE09y7hLPZGRPl1cSKBw4RI0XIv6rlbSTFs5EebpTGjhx/whNxwEZhB9HZ7111Oa1YlT8xkI9DshB78mjAHCKBAJ76moK8tkG0aqdYpJ4ZcJTVBB7l98Rvgc7zfTii7WemTy72deBbSeiEtXavm4EF0mWjHhQ5Nxpnp00Bqn5g1x8CyTDypgmugnep+xG+iFzNmTdsz7WI9T/7kDMXqB7M/FPWBORyS98OJqNDswCLF8bIZYwUBEe+bRHFomoShMzaC3tvim7WCb16noDkSTMlfKO4pnvKhpcVdSgwcruATV7y+W+Lvmz2OT/Gui4JhqeoTewsxndhDDE
        -----END CERTIFICATE-----
      type: string
    tls-certificates-and-hostnames_schemas-created_at:
      description: This is the time the fallback origin was created.
      example: "2019-10-28T18:11:23.37411Z"
      format: date-time
      type: string
    tls-certificates-and-hostnames_schemas-csr:
      description: The Certificate Signing Request (CSR). Must be newline-encoded.
      example: '-----BEGIN CERTIFICATE REQUEST-----\nMIICY....\n-----END CERTIFICATE REQUEST-----\n'
      type: string
    tls-certificates-and-hostnames_schemas-enabled:
      description: |-
        Disabling Universal SSL removes any currently active Universal SSL certificates for your zone from the edge and prevents any future Universal SSL certificates from being ordered. If there are no advanced certificates or custom certificates uploaded for the domain, visitors will be unable to access the domain over HTTPS.

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

        * HSTS
        * Always Use HTTPS
        * Opportunistic Encryption
        * Onion Routing
        * Any Page Rules redirecting traffic to HTTPS

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

        If you do not have a valid custom or advanced certificate at Cloudflare's edge and are unsure if any of the above Cloudflare settings are enabled, or if any HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for your domain.
      example: true
      type: boolean
    tls-certificates-and-hostnames_schemas-expires_on:
      description: When the certificate will expire.
      example: 2014-01-01 05:20:00 +0000 UTC
      readOnly: true
      type: string
    tls-certificates-and-hostnames_schemas-hostname:
      description: The hostname on the origin for which the client certificate uploaded will be used.
      example: app.example.com
      maxLength: 255
      type: string
    tls-certificates-and-hostnames_schemas-hostnames:
      items:
        example: api.example.com
        type: string
      type: array
    tls-certificates-and-hostnames_schemas-hosts:
      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
      type: array
    tls-certificates-and-hostnames_schemas-identifier:
      description: Keyless certificate identifier tag.
      example: 4d2844d2ce78891c34d0b6c0535a291e
      maxLength: 32
      readOnly: true
      type: string
    tls-certificates-and-hostnames_schemas-issuer:
      description: The certificate authority that issued the certificate.
      example: O=Example Inc.,L=California,ST=San Francisco,C=US
      readOnly: true
      type: string
    tls-certificates-and-hostnames_schemas-name:
      description: Optional unique name for the certificate. Only used for human readability.
      example: example_ca_cert
      type: string
    tls-certificates-and-hostnames_schemas-private_key:
      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-----
      type: string
    tls-certificates-and-hostnames_schemas-serial_number:
      description: The certificate serial number.
      example: "235217144297995885180570755458463043449861756659"
      readOnly: true
      type: string
    tls-certificates-and-hostnames_schemas-signature:
      description: Certificate's signature algorithm.
      enum:
        - ECDSAWithSHA256
        - SHA1WithRSA
        - SHA256WithRSA
      type: string
    tls-certificates-and-hostnames_schemas-status:
      description: Status of the Keyless SSL.
      enum:
        - active
        - deleted
      example: active
      readOnly: true
      type: string
    tls-certificates-and-hostnames_schemas-updated_at:
      description: The time when the certificate was updated.
      example: "2100-01-01T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    tls-certificates-and-hostnames_schemas-uploaded_on:
      description: This is the time the certificate was uploaded.
      example: "2019-10-28T18:11:23.37411Z"
      format: date-time
      type: string
    tls-certificates-and-hostnames_schemas-validation_method:
      description: Validation method in use for a certificate pack order.
      enum:
        - http
        - cname
        - txt
      example: txt
      type: string
    tls-certificates-and-hostnames_schemas-validity_days:
      description: The number of days the Client Certificate will be valid after the issued_on date
      example: 3650
      type: integer
    tls-certificates-and-hostnames_serial_number:
      description: The serial number on the uploaded certificate.
      example: "6743787633689793699141714808227354901"
      type: string
    tls-certificates-and-hostnames_service:
      description: The service using the certificate.
      example: gateway
      type: string
    tls-certificates-and-hostnames_setting_id:
      description: The TLS Setting name.
      enum:
        - ciphers
        - min_tls_version
        - http2
      type: string
    tls-certificates-and-hostnames_settingObject:
      properties:
        created_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-created_at'
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status'
        updated_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-updated_at'
        value:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_value'
    tls-certificates-and-hostnames_settingObjectDelete:
      properties:
        created_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-created_at'
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status'
        updated_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-updated_at'
        value:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_value'
    tls-certificates-and-hostnames_signature:
      description: The type of hash used for the certificate.
      example: SHA256WithRSA
      readOnly: true
      type: string
    tls-certificates-and-hostnames_ski:
      description: Subject Key Identifier
      example: 8e375af1389a069a0f921f8cc8e1eb12d784b949
      readOnly: true
      type: string
    tls-certificates-and-hostnames_ssl:
      description: SSL properties for the custom hostname.
      oneOf:
        - properties:
            bundle_method:
              default: ubiquitous
              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
              example: ubiquitous
              type: string
            certificate_authority:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_authority'
            custom_certificate:
              description: If a custom uploaded certificate is used.
              example: '-----BEGIN CERTIFICATE-----\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\n-----END CERTIFICATE-----\n'
              type: string
            custom_csr_id:
              description: The identifier for the Custom CSR that was used.
              example: 7b163417-1d2b-4c84-a38a-2fb7a0cd7752
              type: string
            custom_key:
              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-----
              type: string
            expires_on:
              description: The time the custom certificate expires on.
              example: "2021-02-06T18:11:23.531995Z"
              format: date-time
              type: string
            hosts:
              description: A list of Hostnames on a custom uploaded certificate.
              example:
                - app.example.com
                - '*.app.example.com'
              items:
                type: string
              type: array
            id:
              description: Custom hostname SSL identifier tag.
              example: 0d89c70d-ad9f-4843-b99f-6cc0252067e9
              maxLength: 36
              minLength: 36
              type: string
            issuer:
              description: The issuer on a custom uploaded certificate.
              example: DigiCertInc
              type: string
            method:
              description: Domain control validation (DCV) method used for this hostname.
              enum:
                - http
                - txt
                - email
              example: txt
            serial_number:
              description: The serial number on a custom uploaded certificate.
              example: "6743787633689793699141714808227354901"
              type: string
            settings:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_sslsettings'
            signature:
              description: The signature on a custom uploaded certificate.
              example: SHA256WithRSA
              type: string
            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
            uploaded_on:
              description: The time the custom certificate was uploaded.
              example: "2020-02-06T18:11:23.531995Z"
              format: date-time
              type: string
            validation_errors:
              description: Domain validation errors that have been received by the certificate authority (CA).
              items:
                properties:
                  message:
                    description: A domain validation error.
                    example: SERVFAIL looking up CAA for app.example.com
                    type: string
                type: object
              type: array
            validation_records:
              items:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_record'
              type: array
            wildcard:
              description: Indicates whether the certificate covers a wildcard.
              example: false
              type: boolean
          type: object
      type: object
    tls-certificates-and-hostnames_ssl_universal_settings_response:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_universal'
    tls-certificates-and-hostnames_ssl_validation_method_response_collection:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              properties:
                status:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_method_components-schemas-status'
                validation_method:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_method_definition'
    tls-certificates-and-hostnames_ssl_verification_response_collection:
      allOf:
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_verification'
              type: array
    tls-certificates-and-hostnames_sslpost:
      description: SSL properties used when creating the custom hostname.
      oneOf:
        - properties:
            bundle_method:
              default: ubiquitous
              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
              example: ubiquitous
              type: string
            certificate_authority:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_authority'
            custom_certificate:
              description: If a custom uploaded certificate is used.
              example: '-----BEGIN CERTIFICATE-----\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\n-----END CERTIFICATE-----\n'
              type: string
            custom_key:
              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-----
              type: string
            method:
              description: Domain control validation (DCV) method used for this hostname.
              enum:
                - http
                - txt
                - email
              example: http
            settings:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_sslsettings'
            type:
              description: Level of validation to be used for this hostname. Domain validation (dv) must be used.
              enum:
                - dv
              example: dv
            wildcard:
              description: Indicates whether the certificate covers a wildcard.
              example: false
              type: boolean
          type: object
      type: object
    tls-certificates-and-hostnames_sslsettings:
      description: SSL specific settings.
      properties:
        ciphers:
          description: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.
          example:
            - ECDHE-RSA-AES128-GCM-SHA256
            - AES128-SHA
          items:
            type: string
          type: array
          uniqueItems: true
        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"
      type: object
    tls-certificates-and-hostnames_state:
      description: State, provided by the CSR
      example: CA
      readOnly: true
      type: string
    tls-certificates-and-hostnames_status:
      description: Status of the zone's custom SSL.
      enum:
        - active
        - expired
        - deleted
        - pending
        - initializing
      example: active
      readOnly: true
    tls-certificates-and-hostnames_total_tls_settings_response:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
        - properties:
            result:
              properties:
                certificate_authority:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_authority'
                enabled:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-enabled'
                validity_period:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_validity_period'
    tls-certificates-and-hostnames_type:
      default: legacy_custom
      description: The type 'legacy_custom' enables support for legacy clients which do not include SNI in the TLS handshake.
      enum:
        - legacy_custom
        - sni_custom
      example: sni_custom
      type: string
    tls-certificates-and-hostnames_universal:
      properties:
        enabled:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-enabled'
      type: object
    tls-certificates-and-hostnames_updated_at:
      description: This is the time the fallback origin was updated.
      example: "2020-03-16T18:11:23.531995Z"
      format: date-time
      type: string
    tls-certificates-and-hostnames_uploaded_on:
      description: When the certificate was uploaded to Cloudflare.
      example: "2014-01-01T05:20:00Z"
      format: date-time
      readOnly: true
      type: string
    tls-certificates-and-hostnames_uuid:
      description: The DCV Delegation unique identifier.
      example: abc123def456ghi7
      type: string
    tls-certificates-and-hostnames_uuidObject:
      properties:
        uuid:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_uuid'
    tls-certificates-and-hostnames_validation_method:
      description: Validation Method selected for the order.
      enum:
        - txt
        - http
        - email
      example: txt
      type: string
    tls-certificates-and-hostnames_validation_method_components-schemas-status:
      description: Result status.
      example: pending_validation
      type: string
    tls-certificates-and-hostnames_validation_method_definition:
      description: Desired validation method.
      enum:
        - http
        - cname
        - txt
        - email
      example: txt
      type: string
    tls-certificates-and-hostnames_validation_record:
      description: Certificate's required validation record.
      properties:
        emails:
          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:
            type: string
          type: array
        http_body:
          description: The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
          example: ca3-574923932a82475cb8592200f1a2a23d
          type: string
        http_url:
          description: The url that will be checked during domain validation.
          example: http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt
          type: string
        txt_name:
          description: The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
          example: _acme-challenge.app.example.com
          type: string
        txt_value:
          description: The TXT record that the certificate authority (CA) will check during domain validation.
          example: 810b7d5f01154524b961ba0cd578acc2
          type: string
      type: object
    tls-certificates-and-hostnames_validity_days:
      description: Validity Days selected for the order.
      enum:
        - 14
        - 30
        - 90
        - 365
      type: integer
    tls-certificates-and-hostnames_validity_period:
      description: The validity period in days for the certificates ordered via Total TLS.
      enum:
        - 90
      type: integer
    tls-certificates-and-hostnames_value:
      description: The tls setting value.
      example:
        - ECDHE-RSA-AES128-GCM-SHA256
        - AES128-GCM-SHA256
      oneOf:
        - type: number
        - type: string
        - items:
            type: string
          type: array
    tls-certificates-and-hostnames_verification:
      properties:
        brand_check:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_brand_check'
        cert_pack_uuid:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_cert_pack_uuid'
        certificate_status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_status'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-signature'
        validation_method:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-validation_method'
        verification_info:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_verification_info'
        verification_status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_verification_status'
        verification_type:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_verification_type'
      required:
        - certificate_status
      type: object
    tls-certificates-and-hostnames_verification_errors:
      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:
        type: string
      type: array
    tls-certificates-and-hostnames_verification_info:
      description: Certificate's required verification information.
      properties:
        record_name:
          description: Name of CNAME record.
          enum:
            - record_name
            - http_url
            - cname
            - txt_name
          example: b3b90cfedd89a3e487d3e383c56c4267.example.com
          format: hostname
          type: string
        record_target:
          description: Target of CNAME record.
          enum:
            - record_value
            - http_body
            - cname_target
            - txt_value
          example: 6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com
          format: hostname
          type: string
      type: object
    tls-certificates-and-hostnames_verification_status:
      description: Status of the required verification information, omitted if verification status is unknown.
      example: true
      type: boolean
    tls-certificates-and-hostnames_verification_type:
      description: Method of verification.
      enum:
        - cname
        - meta tag
      example: cname
      type: string
    tls-certificates-and-hostnames_zone-authenticated-origin-pull:
      allOf:
        - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificateObject'
      properties:
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate'
        enabled:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        private_key:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_private_key'
      type: object
    tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate:
      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-----
      type: string
    tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled:
      description: Indicates whether zone-level authenticated origin pulls is enabled.
      example: true
      type: boolean
    tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-status:
      description: Status of the certificate activation.
      enum:
        - initializing
        - pending_deployment
        - pending_deletion
        - active
        - deleted
        - deployment_timed_out
        - deletion_timed_out
      example: active
    tunnel_account_id:
      description: Cloudflare account ID
      example: 699d98642c564d2e855e9661899b7252
      maxLength: 32
      type: string
    tunnel_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/tunnel_result_info'
      type: object
    tunnel_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/tunnel_messages'
        messages:
          $ref: '#/components/schemas/tunnel_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    tunnel_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/tunnel_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/tunnel_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    tunnel_api-response-single:
      $ref: '#/components/schemas/tunnel_api-response-common'
    tunnel_arch:
      description: The cloudflared OS architecture used to establish this connection.
      example: linux_amd64
      type: string
    tunnel_argo-tunnel:
      properties:
        connections:
          description: The tunnel connections between your origin and Cloudflare's edge.
          items:
            $ref: '#/components/schemas/tunnel_connection'
          type: array
        created_at:
          $ref: '#/components/schemas/tunnel_created_at'
        deleted_at:
          $ref: '#/components/schemas/tunnel_deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_tunnel_id'
        name:
          $ref: '#/components/schemas/tunnel_tunnel_name'
      required:
        - id
        - name
        - created_at
        - connections
      type: object
    tunnel_cfd_tunnel:
      description: A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
      properties:
        account_tag:
          $ref: '#/components/schemas/tunnel_account_id'
        connections:
          $ref: '#/components/schemas/tunnel_connections'
        conns_active_at:
          $ref: '#/components/schemas/tunnel_conns_active_at'
        conns_inactive_at:
          $ref: '#/components/schemas/tunnel_conns_inactive_at'
        created_at:
          $ref: '#/components/schemas/tunnel_created_at'
        deleted_at:
          $ref: '#/components/schemas/tunnel_deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_tunnel_id'
        metadata:
          $ref: '#/components/schemas/tunnel_metadata'
        name:
          $ref: '#/components/schemas/tunnel_tunnel_name'
        remote_config:
          $ref: '#/components/schemas/tunnel_remote_config'
        status:
          $ref: '#/components/schemas/tunnel_status'
        tun_type:
          $ref: '#/components/schemas/tunnel_tunnel_type'
      type: object
    tunnel_client_id:
      description: UUID of the Cloudflare Tunnel connector.
      example: 1bedc50d-42b3-473c-b108-ff3d10c0d925
      format: uuid
      maxLength: 36
      readOnly: true
      type: string
    tunnel_colo_name:
      description: The Cloudflare data center used for this connection.
      example: DFW
      type: string
    tunnel_comment:
      description: Optional remark describing the route.
      example: Example comment for this route.
      type: string
    tunnel_config:
      description: The tunnel configuration and ingress rules.
      properties:
        ingress:
          description: List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel.
          items:
            $ref: '#/components/schemas/tunnel_ingressRule'
          minItems: 1
          type: array
        originRequest:
          $ref: '#/components/schemas/tunnel_originRequest'
        warp-routing:
          description: Enable private network access from WARP users to private network routes. This is enabled if the tunnel has an assigned route.
          properties:
            enabled:
              default: false
              type: boolean
          readOnly: true
          type: object
      type: object
    tunnel_config_src:
      default: local
      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.
      enum:
        - local
        - cloudflare
      example: cloudflare
      type: string
    tunnel_config_version:
      description: The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard.
      type: integer
    tunnel_configuration:
      description: Cloudflare Tunnel configuration
      properties:
        account_id:
          $ref: '#/components/schemas/tunnel_identifier'
        config:
          $ref: '#/components/schemas/tunnel_config'
        created_at:
          $ref: '#/components/schemas/tunnel_timestamp'
        source:
          $ref: '#/components/schemas/tunnel_schemas-config_src'
        tunnel_id:
          $ref: '#/components/schemas/tunnel_tunnel_id'
        version:
          $ref: '#/components/schemas/tunnel_schemas-config_version'
      type: object
    tunnel_configuration_response:
      allOf:
        - $ref: '#/components/schemas/tunnel_schemas-api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tunnel_configuration'
    tunnel_connection:
      properties:
        colo_name:
          $ref: '#/components/schemas/tunnel_colo_name'
        is_pending_reconnect:
          $ref: '#/components/schemas/tunnel_is_pending_reconnect'
        uuid:
          $ref: '#/components/schemas/tunnel_connection_id'
    tunnel_connection_id:
      description: UUID of the Cloudflare Tunnel connection.
      example: 1bedc50d-42b3-473c-b108-ff3d10c0d925
      format: uuid
      maxLength: 36
      readOnly: true
      type: string
    tunnel_connections:
      description: The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
      items:
        $ref: '#/components/schemas/tunnel_schemas-connection'
      type: array
    tunnel_conns_active_at:
      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"
      format: date-time
      type: string
    tunnel_conns_inactive_at:
      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"
      format: date-time
      type: string
    tunnel_created_at:
      description: Timestamp of when the resource was created.
      example: "2021-01-25T18:22:34.317854Z"
      format: date-time
      type: string
    tunnel_deleted_at:
      description: Timestamp of when the resource was deleted. If `null`, the resource has not been deleted.
      example: "2009-11-10T23:00:00Z"
      format: date-time
      type: string
    tunnel_empty_response:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-common'
        - properties:
            result:
              enum:
                - 
              nullable: true
              type: object
          type: object
    tunnel_existed_at:
      description: If provided, include only tunnels that were created (and not deleted) before this time.
      example: "2019-10-12T07:20:50.52Z"
      format: date-time
      type: string
    tunnel_features:
      description: Features enabled for the Cloudflare Tunnel.
      items:
        example: ha-origin
        type: string
      type: array
    tunnel_icmp_proxy_enabled:
      description: A flag to enable the ICMP proxy for the account network.
      example: true
      type: boolean
    tunnel_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    tunnel_ingressRule:
      description: Public hostname
      properties:
        hostname:
          description: Public hostname for this service.
          example: tunnel.example.com
          type: string
        originRequest:
          $ref: '#/components/schemas/tunnel_originRequest'
        path:
          default: ""
          description: Requests with this path route to this public hostname.
          example: subpath
          type: string
        service:
          description: |
            Protocol and address of destination server. Supported protocols: http://, https://, unix://, tcp://, ssh://, rdp://, unix+tls://, smb://. Alternatively can return a HTTP status code http_status:[code] e.g. 'http_status:404'.
          example: https://localhost:8001
          type: string
      required:
        - hostname
        - service
      type: object
    tunnel_ip:
      example: 10.1.0.137
      type: string
    tunnel_ip_network:
      description: The private IPv4 or IPv6 range connected by the route, in CIDR notation.
      example: 172.16.0.0/16
      type: string
    tunnel_ip_network_encoded:
      description: IP/CIDR range in URL-encoded format
      example: 172.16.0.0%2F16
      type: string
    tunnel_is_default_network:
      description: If `true`, this virtual network is the default for the account.
      example: true
      type: boolean
    tunnel_is_pending_reconnect:
      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
      type: boolean
    tunnel_legacy-tunnel-response-collection:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tunnel_argo-tunnel'
              type: array
          type: object
    tunnel_legacy-tunnel-response-single:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tunnel_argo-tunnel'
          type: object
    tunnel_management-resources:
      description: Management resources the token will have access to.
      enum:
        - logs
      example: logs
      type: string
    tunnel_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    tunnel_metadata:
      description: Metadata associated with the tunnel.
      example: {}
      type: object
    tunnel_offramp_warp_enabled:
      description: A flag to enable WARP to WARP traffic.
      example: true
      type: boolean
    tunnel_originRequest:
      description: Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
      properties:
        access:
          description: For all L7 requests to this hostname, cloudflared will validate each request's Cf-Access-Jwt-Assertion request header.
          properties:
            audTag:
              description: Access applications that are allowed to reach this hostname for this Tunnel. Audience tags can be identified in the dashboard or via the List Access policies API.
              items:
                type: string
              type: array
            required:
              default: false
              description: Deny traffic that has not fulfilled Access authorization.
              type: boolean
            teamName:
              default: Your Zero Trust organization name.
              type: string
          required:
            - audTag
            - teamName
          type: object
        caPool:
          default: ""
          description: Path to the certificate authority (CA) for the certificate of your origin. This option should be used only if your certificate is not signed by Cloudflare.
          type: string
        connectTimeout:
          default: 10
          description: Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout.
          type: integer
        disableChunkedEncoding:
          description: Disables chunked transfer encoding. Useful if you are running a WSGI server.
          type: boolean
        http2Origin:
          description: Attempt to connect to origin using HTTP2. Origin must be configured as https.
          type: boolean
        httpHostHeader:
          description: Sets the HTTP Host header on requests sent to the local service.
          type: string
        keepAliveConnections:
          default: 100
          description: Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections.
          type: integer
        keepAliveTimeout:
          default: 90
          description: Timeout after which an idle keepalive connection can be discarded.
          type: integer
        noHappyEyeballs:
          default: false
          description: Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols.
          type: boolean
        noTLSVerify:
          default: false
          description: Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted.
          type: boolean
        originServerName:
          default: ""
          description: Hostname that cloudflared should expect from your origin server certificate.
          type: string
        proxyType:
          default: ""
          description: |
            cloudflared starts a proxy server to translate HTTP traffic into TCP when proxying, for example, SSH or RDP. This configures what type of proxy will be started. Valid options are: "" for the regular proxy and "socks" for a SOCKS5 proxy.
          type: string
        tcpKeepAlive:
          default: 30
          description: The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server.
          type: integer
        tlsTimeout:
          default: 10
          description: Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server.
          type: integer
      type: object
    tunnel_per_page:
      description: Number of results to display.
      maximum: 1000
      minimum: 1
      type: number
    tunnel_remote_config:
      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
      type: boolean
    tunnel_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    tunnel_route:
      properties:
        comment:
          $ref: '#/components/schemas/tunnel_comment'
        created_at:
          $ref: '#/components/schemas/tunnel_created_at'
        deleted_at:
          $ref: '#/components/schemas/tunnel_deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_route_id'
        network:
          $ref: '#/components/schemas/tunnel_ip_network'
        tunnel_id:
          $ref: '#/components/schemas/tunnel_tunnel_id'
        virtual_network_id:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
      type: object
    tunnel_route_id:
      description: UUID of the route.
      example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      readOnly: true
      type: string
    tunnel_route_response_single:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tunnel_route'
          type: object
    tunnel_run_at:
      description: Timestamp of when the tunnel connection was started.
      example: "2009-11-10T23:00:00Z"
      format: date-time
      type: string
    tunnel_schemas-api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/tunnel_messages'
        messages:
          $ref: '#/components/schemas/tunnel_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    tunnel_schemas-api-response-single:
      allOf:
        - $ref: '#/components/schemas/tunnel_schemas-api-response-common'
      type: object
    tunnel_schemas-config_src:
      default: local
      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's configuration on the Zero Trust dashboard.
      enum:
        - local
        - cloudflare
      example: cloudflare
      type: string
    tunnel_schemas-config_version:
      description: The version of the Tunnel Configuration.
      type: integer
    tunnel_schemas-connection:
      properties:
        client_id:
          $ref: '#/components/schemas/tunnel_client_id'
        client_version:
          $ref: '#/components/schemas/tunnel_version'
        colo_name:
          $ref: '#/components/schemas/tunnel_colo_name'
        id:
          $ref: '#/components/schemas/tunnel_connection_id'
        is_pending_reconnect:
          $ref: '#/components/schemas/tunnel_is_pending_reconnect'
        opened_at:
          description: Timestamp of when the connection was established.
          example: "2021-01-25T18:22:34.317854Z"
          format: date-time
          type: string
        origin_ip:
          allOf:
            - $ref: '#/components/schemas/tunnel_ip'
          description: The public IP address of the host running cloudflared.
        uuid:
          $ref: '#/components/schemas/tunnel_connection_id'
    tunnel_status:
      description: The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).
      enum:
        - inactive
        - degraded
        - healthy
        - down
      example: healthy
      type: string
    tunnel_teamnet:
      properties:
        comment:
          $ref: '#/components/schemas/tunnel_comment'
        created_at:
          $ref: '#/components/schemas/tunnel_created_at'
        deleted_at:
          $ref: '#/components/schemas/tunnel_deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_route_id'
        network:
          $ref: '#/components/schemas/tunnel_ip_network'
        tun_type:
          $ref: '#/components/schemas/tunnel_tunnel_type'
        tunnel_id:
          $ref: '#/components/schemas/tunnel_tunnel_id'
        tunnel_name:
          $ref: '#/components/schemas/tunnel_tunnel_name'
        virtual_network_id:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
        virtual_network_name:
          $ref: '#/components/schemas/tunnel_virtual_network_name'
      type: object
    tunnel_teamnet_response_collection:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tunnel_teamnet'
              type: array
          type: object
    tunnel_teamnet_response_single:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tunnel_teamnet'
          type: object
    tunnel_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      type: string
    tunnel_tunnel-response-collection:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-collection'
        - properties:
            result:
              items:
                anyOf:
                  - $ref: '#/components/schemas/tunnel_cfd_tunnel'
                  - $ref: '#/components/schemas/tunnel_warp_connector_tunnel'
              type: array
          type: object
    tunnel_tunnel-response-single:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-single'
        - properties:
            result:
              anyOf:
                - $ref: '#/components/schemas/tunnel_cfd_tunnel'
                - $ref: '#/components/schemas/tunnel_warp_connector_tunnel'
          type: object
    tunnel_tunnel_client:
      description: A client (typically cloudflared) that maintains connections to a Cloudflare data center.
      properties:
        arch:
          $ref: '#/components/schemas/tunnel_arch'
        config_version:
          $ref: '#/components/schemas/tunnel_config_version'
        conns:
          $ref: '#/components/schemas/tunnel_connections'
        features:
          $ref: '#/components/schemas/tunnel_features'
        id:
          $ref: '#/components/schemas/tunnel_connection_id'
        run_at:
          $ref: '#/components/schemas/tunnel_run_at'
        version:
          $ref: '#/components/schemas/tunnel_version'
      type: object
    tunnel_tunnel_client_response:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tunnel_tunnel_client'
          type: object
    tunnel_tunnel_connections_response:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tunnel_tunnel_client'
              type: array
          type: object
    tunnel_tunnel_id:
      description: UUID of the tunnel.
      example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
      format: uuid
      maxLength: 36
      readOnly: true
      type: string
    tunnel_tunnel_link:
      description: The id of the tunnel linked and the date that link was created.
      properties:
        created_at:
          $ref: '#/components/schemas/tunnel_created_at'
        linked_tunnel_id:
          $ref: '#/components/schemas/tunnel_tunnel_id'
      type: object
    tunnel_tunnel_links_response:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tunnel_tunnel_link'
              type: array
          type: object
    tunnel_tunnel_name:
      description: A user-friendly name for a tunnel.
      example: blog
      type: string
    tunnel_tunnel_response_token:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-single'
        - properties:
            result:
              example: eyJhIjoiNWFiNGU5Z...
              type: string
          type: object
    tunnel_tunnel_secret:
      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=
      type: string
    tunnel_tunnel_type:
      description: The type of tunnel.
      enum:
        - cfd_tunnel
        - warp_connector
        - ip_sec
        - gre
        - cni
      example: cfd_tunnel
      type: string
    tunnel_tunnel_types:
      description: The types of tunnels to filter separated by a comma.
      example: cfd_tunnel,warp_connector
      type: string
    tunnel_version:
      description: The cloudflared version used to establish this connection.
      example: 2022.7.1
      type: string
    tunnel_virtual-network:
      properties:
        comment:
          $ref: '#/components/schemas/tunnel_virtual_network_comment'
        created_at:
          $ref: '#/components/schemas/tunnel_created_at'
        deleted_at:
          $ref: '#/components/schemas/tunnel_deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_virtual_network_id'
        is_default_network:
          $ref: '#/components/schemas/tunnel_is_default_network'
        name:
          $ref: '#/components/schemas/tunnel_virtual_network_name'
      required:
        - id
        - name
        - is_default_network
        - comment
        - created_at
      type: object
    tunnel_virtual_network_comment:
      description: Optional remark describing the virtual network.
      example: Staging VPC for data science
      maxLength: 256
      type: string
    tunnel_virtual_network_id:
      description: UUID of the virtual network.
      example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
      format: uuid
      type: string
    tunnel_virtual_network_name:
      description: A user-friendly name for the virtual network.
      example: us-east-1-vpc
      maxLength: 256
      type: string
    tunnel_vnet_response_collection:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/tunnel_virtual-network'
              type: array
          type: object
    tunnel_vnet_response_single:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/tunnel_virtual-network'
          type: object
    tunnel_warp_connector_tunnel:
      description: A Warp Connector Tunnel that connects your origin to Cloudflare's edge.
      properties:
        account_tag:
          $ref: '#/components/schemas/tunnel_account_id'
        connections:
          $ref: '#/components/schemas/tunnel_connections'
        conns_active_at:
          $ref: '#/components/schemas/tunnel_conns_active_at'
        conns_inactive_at:
          $ref: '#/components/schemas/tunnel_conns_inactive_at'
        created_at:
          $ref: '#/components/schemas/tunnel_created_at'
        deleted_at:
          $ref: '#/components/schemas/tunnel_deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_tunnel_id'
        metadata:
          $ref: '#/components/schemas/tunnel_metadata'
        name:
          $ref: '#/components/schemas/tunnel_tunnel_name'
        status:
          $ref: '#/components/schemas/tunnel_status'
        tun_type:
          $ref: '#/components/schemas/tunnel_tunnel_type'
      type: object
    tunnel_zero_trust_connectivity_settings_response:
      allOf:
        - $ref: '#/components/schemas/tunnel_api-response-single'
        - properties:
            result:
              properties:
                icmp_proxy_enabled:
                  $ref: '#/components/schemas/tunnel_icmp_proxy_enabled'
                offramp_warp_enabled:
                  $ref: '#/components/schemas/tunnel_offramp_warp_enabled'
              type: object
          type: object
    turnstile_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/turnstile_messages'
        messages:
          $ref: '#/components/schemas/turnstile_messages'
        success:
          description: Whether the API call was successful
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    turnstile_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/turnstile_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/turnstile_messages'
          example: []
        result:
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    turnstile_bot_fight_mode:
      description: |
        If bot_fight_mode is set to `true`, Cloudflare issues computationally
        expensive challenges in response to malicious bots (ENT only).
      example: false
      type: boolean
    turnstile_clearance_level:
      description: |
        If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance,
        this setting can determine the clearance level to be set
      enum:
        - no_clearance
        - jschallenge
        - managed
        - interactive
      example: interactive
      type: string
    turnstile_created_on:
      description: When the widget was created.
      example: "2014-01-01T05:20:00.123123Z"
      format: date-time
      readOnly: true
      type: string
    turnstile_domains:
      example:
        - 203.0.113.1
        - cloudflare.com
        - blog.example.com
      items:
        description: |
          Hosts as a hostname or IPv4/IPv6 address represented by strings. The
          widget will only work on these domains, and their subdomains.
        example: 203.0.113.1
        type: string
      maxLength: 10
      type: array
    turnstile_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    turnstile_invalidate_immediately:
      default: false
      description: |
        If `invalidate_immediately` is set to `false`, the previous secret will
        remain valid for two hours. Otherwise, the secret is immediately
        invalidated, and requests using it will be rejected.
      type: boolean
    turnstile_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    turnstile_mode:
      description: Widget Mode
      enum:
        - non-interactive
        - invisible
        - managed
      example: invisible
      type: string
    turnstile_modified_on:
      description: When the widget was modified.
      example: "2014-01-01T05:20:00.123123Z"
      format: date-time
      readOnly: true
      type: string
    turnstile_name:
      description: |
        Human readable widget name. Not unique. Cloudflare suggests that you
        set this to a meaningful string to make it easier to identify your
        widget, and where it is used.
      example: blog.cloudflare.com login form
      maxLength: 254
      minLength: 1
      type: string
    turnstile_offlabel:
      description: |
        Do not show any Cloudflare branding on the widget (ENT only).
      example: false
      type: boolean
    turnstile_region:
      default: world
      description: Region where this widget can be used.
      enum:
        - world
      type: string
    turnstile_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      required:
        - page
        - per_page
        - count
        - total_count
      type: object
    turnstile_secret:
      description: Secret key for this widget.
      example: 0x4AAF00AAAABn0R22HWm098HVBjhdsYUc
      type: string
    turnstile_sitekey:
      description: Widget item identifier tag.
      example: 0x4AAF00AAAABn0R22HWm-YUc
      maxLength: 32
      type: string
    turnstile_widget_detail:
      description: A Turnstile widget's detailed configuration
      properties:
        bot_fight_mode:
          $ref: '#/components/schemas/turnstile_bot_fight_mode'
        clearance_level:
          $ref: '#/components/schemas/turnstile_clearance_level'
        created_on:
          $ref: '#/components/schemas/turnstile_created_on'
        domains:
          $ref: '#/components/schemas/turnstile_domains'
        mode:
          $ref: '#/components/schemas/turnstile_mode'
        modified_on:
          $ref: '#/components/schemas/turnstile_modified_on'
        name:
          $ref: '#/components/schemas/turnstile_name'
        offlabel:
          $ref: '#/components/schemas/turnstile_offlabel'
        region:
          $ref: '#/components/schemas/turnstile_region'
        secret:
          $ref: '#/components/schemas/turnstile_secret'
        sitekey:
          $ref: '#/components/schemas/turnstile_sitekey'
      required:
        - sitekey
        - secret
        - created_on
        - modified_on
        - name
        - domains
        - mode
        - region
        - bot_fight_mode
        - offlabel
        - clearance_level
      type: object
    turnstile_widget_list:
      description: A Turnstile Widgets configuration as it appears in listings
      properties:
        bot_fight_mode:
          $ref: '#/components/schemas/turnstile_bot_fight_mode'
        clearance_level:
          $ref: '#/components/schemas/turnstile_clearance_level'
        created_on:
          $ref: '#/components/schemas/turnstile_created_on'
        domains:
          $ref: '#/components/schemas/turnstile_domains'
        mode:
          $ref: '#/components/schemas/turnstile_mode'
        modified_on:
          $ref: '#/components/schemas/turnstile_modified_on'
        name:
          $ref: '#/components/schemas/turnstile_name'
        offlabel:
          $ref: '#/components/schemas/turnstile_offlabel'
        region:
          $ref: '#/components/schemas/turnstile_region'
        sitekey:
          $ref: '#/components/schemas/turnstile_sitekey'
      required:
        - sitekey
        - created_on
        - modified_on
        - name
        - domains
        - mode
        - region
        - bot_fight_mode
        - offlabel
        - clearance_level
      type: object
    vectorize_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/vectorize_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/vectorize_result_info'
      type: object
    vectorize_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/vectorize_messages'
        messages:
          $ref: '#/components/schemas/vectorize_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    vectorize_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/vectorize_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/vectorize_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    vectorize_api-response-single:
      allOf:
        - $ref: '#/components/schemas/vectorize_api-response-common'
        - properties:
            result:
              anyOf:
                - type: object
                - type: string
              nullable: true
              type: object
      type: object
    vectorize_create-index-request:
      properties:
        config:
          allOf:
            - $ref: '#/components/schemas/vectorize_index-configuration'
        description:
          $ref: '#/components/schemas/vectorize_index-description'
        name:
          $ref: '#/components/schemas/vectorize_index-name'
      required:
        - name
        - config
      type: object
    vectorize_create-index-response:
      properties:
        config:
          $ref: '#/components/schemas/vectorize_index-dimension-configuration'
        created_on:
          description: Specifies the timestamp the resource was created as an ISO8601 string.
          example: "2022-11-15T18:25:44.442097Z"
          format: date-time
          readOnly: true
          type: string
        description:
          $ref: '#/components/schemas/vectorize_index-description'
        modified_on:
          description: Specifies the timestamp the resource was modified as an ISO8601 string.
          example: "2022-11-15T18:25:44.442097Z"
          format: date-time
          readOnly: true
          type: string
        name:
          $ref: '#/components/schemas/vectorize_index-name'
      type: object
    vectorize_create-metadata-index-request:
      properties:
        indexType:
          description: Specifies the type of metadata property to index.
          enum:
            - string
            - number
            - boolean
          type: string
        propertyName:
          description: Specifies the metadata property to index.
          example: random_metadata_property
          type: string
      required:
        - propertyName
        - indexType
      type: object
    vectorize_create-metadata-index-response:
      properties:
        mutationId:
          $ref: '#/components/schemas/vectorize_mutation-uuid'
      type: object
    vectorize_delete-metadata-index-request:
      properties:
        propertyName:
          description: Specifies the metadata property for which the index must be deleted.
          example: random_metadata_property
          type: string
      required:
        - propertyName
      type: object
    vectorize_delete-metadata-index-response:
      properties:
        mutationId:
          $ref: '#/components/schemas/vectorize_mutation-uuid'
      type: object
    vectorize_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    vectorize_index-configuration:
      description: Specifies the type of configuration to use for the index.
      oneOf:
        - $ref: '#/components/schemas/vectorize_index-dimension-configuration'
        - $ref: '#/components/schemas/vectorize_index-preset-configuration'
    vectorize_index-delete-vectors-by-id-request:
      properties:
        ids:
          description: A list of vector identifiers to delete from the index indicated by the path.
          example:
            - 5121db81354a40c6aedc3fe1ace51c59
            - f90eb49c2107486abdfd78c67e853430
          items:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          type: array
      type: object
    vectorize_index-delete-vectors-by-id-response:
      properties:
        count:
          description: The count of the vectors successfully deleted.
          example: 42
          type: integer
        ids:
          description: Array of vector identifiers of the vectors that were successfully processed for deletion.
          items:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          type: array
      type: object
    vectorize_index-delete-vectors-by-id-v2-response:
      properties:
        mutationId:
          $ref: '#/components/schemas/vectorize_mutation-uuid'
      type: object
    vectorize_index-description:
      description: Specifies the description of the index.
      example: This is my example index.
      type: string
    vectorize_index-dimension-configuration:
      properties:
        dimensions:
          $ref: '#/components/schemas/vectorize_index-dimensions'
        metric:
          $ref: '#/components/schemas/vectorize_index-metric'
      required:
        - dimensions
        - metric
      type: object
    vectorize_index-dimensions:
      description: Specifies the number of dimensions for the index
      example: 768
      maximum: 1536
      minimum: 1
      type: integer
    vectorize_index-get-vectors-by-id-request:
      properties:
        ids:
          description: A list of vector identifiers to retrieve from the index indicated by the path.
          example:
            - 5121db81354a40c6aedc3fe1ace51c59
            - f90eb49c2107486abdfd78c67e853430
          items:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          type: array
      type: object
    vectorize_index-get-vectors-by-id-response:
      description: Array of vectors with matching ids.
      example:
        - id: some-vector-id
          metadata:
            another-key: another-value
            customer-id: 442
          values:
            - 0.812
            - 0.621
            - 0.261
        - id: other-vector-id
          metadata:
            another-key: with-a-value
            customer-id: 2151
          namespace: namespaced
          values:
            - 0.961
            - 0.751
            - 0.661
      items:
        properties:
          id:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          metadata:
            type: object
          namespace:
            nullable: true
            type: string
          values:
            items:
              type: number
            type: array
        type: object
      type: array
    vectorize_index-info-response:
      properties:
        dimensions:
          $ref: '#/components/schemas/vectorize_index-dimensions'
        processedUpToDatetime:
          description: Specifies the timestamp the last mutation batch was processed as an ISO8601 string.
          example: "2024-07-22T18:25:44.442097Z"
          format: date-time
          nullable: true
          readOnly: true
          type: string
        processedUpToMutation:
          $ref: '#/components/schemas/vectorize_mutation-uuid'
        vectorCount:
          description: Specifies the number of vectors present in the index
          example: 300000
          type: integer
      type: object
    vectorize_index-insert-response:
      properties:
        count:
          description: Specifies the count of the vectors successfully inserted.
          example: 768
          type: integer
        ids:
          description: Array of vector identifiers of the vectors successfully inserted.
          items:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          type: array
      type: object
    vectorize_index-insert-v2-response:
      properties:
        mutationId:
          $ref: '#/components/schemas/vectorize_mutation-uuid'
      type: object
    vectorize_index-metric:
      description: Specifies the type of metric to use calculating distance.
      enum:
        - cosine
        - euclidean
        - dot-product
      type: string
    vectorize_index-name:
      example: example-index
      pattern: ^([a-z]+[a-z0-9_-]*[a-z0-9]+)$
      type: string
    vectorize_index-preset:
      description: Specifies the preset to use for the index.
      enum:
        - '@cf/baai/bge-small-en-v1.5'
        - '@cf/baai/bge-base-en-v1.5'
        - '@cf/baai/bge-large-en-v1.5'
        - openai/text-embedding-ada-002
        - cohere/embed-multilingual-v2.0
      example: '@cf/baai/bge-small-en-v1.5'
      type: string
    vectorize_index-preset-configuration:
      properties:
        preset:
          $ref: '#/components/schemas/vectorize_index-preset'
      required:
        - preset
      type: object
    vectorize_index-query-request:
      properties:
        filter:
          description: A metadata filter expression used to limit nearest neighbor results.
          example:
            has_viewed:
              $ne: true
            streaming_platform: netflix
          type: object
        returnMetadata:
          default: false
          description: Whether to return the metadata associated with the closest vectors.
          type: boolean
        returnValues:
          default: false
          description: Whether to return the values associated with the closest vectors.
          type: boolean
        topK:
          default: 5
          description: The number of nearest neighbors to find.
          example: 5
          type: number
        vector:
          description: The search vector that will be used to find the nearest neighbors.
          example:
            - 0.5
            - 0.5
            - 0.5
          items:
            type: number
          type: array
      required:
        - vector
      type: object
    vectorize_index-query-response:
      properties:
        count:
          description: Specifies the count of vectors returned by the search
          type: integer
        matches:
          description: Array of vectors matched by the search
          items:
            properties:
              id:
                $ref: '#/components/schemas/vectorize_vector-identifier'
              metadata:
                nullable: true
                type: object
              score:
                description: The score of the vector according to the index's distance metric
                type: number
              values:
                items:
                  type: number
                nullable: true
                type: array
            type: object
          type: array
      type: object
    vectorize_index-query-v2-request:
      properties:
        filter:
          description: A metadata filter expression used to limit nearest neighbor results.
          example:
            has_viewed:
              $ne: true
            streaming_platform: netflix
          type: object
        returnMetadata:
          default: none
          description: Whether to return no metadata, indexed metadata or all metadata associated with the closest vectors.
          enum:
            - none
            - indexed
            - all
          type: string
        returnValues:
          default: false
          description: Whether to return the values associated with the closest vectors.
          type: boolean
        topK:
          default: 5
          description: The number of nearest neighbors to find.
          example: 5
          type: number
        vector:
          description: The search vector that will be used to find the nearest neighbors.
          example:
            - 0.5
            - 0.5
            - 0.5
          items:
            type: number
          type: array
      required:
        - vector
      type: object
    vectorize_index-query-v2-response:
      properties:
        count:
          description: Specifies the count of vectors returned by the search
          type: integer
        matches:
          description: Array of vectors matched by the search
          items:
            properties:
              id:
                $ref: '#/components/schemas/vectorize_vector-identifier'
              metadata:
                nullable: true
                type: object
              namespace:
                nullable: true
                type: string
              score:
                description: The score of the vector according to the index's distance metric
                type: number
              values:
                items:
                  type: number
                nullable: true
                type: array
            type: object
          type: array
      type: object
    vectorize_index-upsert-response:
      properties:
        count:
          description: Specifies the count of the vectors successfully inserted.
          example: 768
          type: integer
        ids:
          description: Array of vector identifiers of the vectors successfully inserted.
          items:
            $ref: '#/components/schemas/vectorize_vector-identifier'
          type: array
      type: object
    vectorize_index-upsert-v2-response:
      properties:
        mutationId:
          $ref: '#/components/schemas/vectorize_mutation-uuid'
      type: object
    vectorize_list-metadata-index-response:
      example:
        metadataIndexes:
          - indexType: number
            propertyName: some-num-prop
          - indexType: string
            propertyName: some-str-prop
          - indexType: boolean
            propertyName: some-bool-prop
      properties:
        metadataIndexes:
          description: Array of indexed metadata properties.
          items:
            properties:
              indexType:
                description: Specifies the type of indexed metadata property.
                enum:
                  - string
                  - number
                  - boolean
                type: string
              propertyName:
                description: Specifies the indexed metadata property.
                example: random_metadata_property
                type: string
            type: object
          type: array
      type: object
    vectorize_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    vectorize_mutation-uuid:
      description: The unique identifier for the async mutation operation containing the changeset.
      example: 0000aaaa-11bb-22cc-33dd-444444eeeeee
      maxLength: 36
    vectorize_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    vectorize_update-index-request:
      properties:
        description:
          $ref: '#/components/schemas/vectorize_index-description'
      required:
        - description
      type: object
    vectorize_vector-identifier:
      description: Identifier for a Vector
      example: some-vector-id-023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 64
      readOnly: true
      type: string
    waf-managed-rules_allowed_modes:
      description: The available states for the rule group.
      example:
        - "on"
        - "off"
      items:
        $ref: '#/components/schemas/waf-managed-rules_mode'
      readOnly: true
      type: array
    waf-managed-rules_allowed_modes_allow_traditional:
      description: Defines the available modes for the current WAF rule.
      example:
        - "on"
        - "off"
      items:
        $ref: '#/components/schemas/waf-managed-rules_mode_allow_traditional'
      readOnly: true
      type: array
    waf-managed-rules_allowed_modes_anomaly:
      description: Defines the available modes for the current WAF rule. Applies to anomaly detection WAF rules.
      example:
        - "on"
        - "off"
      items:
        $ref: '#/components/schemas/waf-managed-rules_mode_anomaly'
      readOnly: true
      type: array
    waf-managed-rules_allowed_modes_deny_traditional:
      description: The list of possible actions of the WAF rule when it is triggered.
      example:
        - default
        - disable
        - simulate
        - block
        - challenge
      items:
        $ref: '#/components/schemas/waf-managed-rules_mode_deny_traditional'
      readOnly: true
      type: array
    waf-managed-rules_anomaly_rule:
      allOf:
        - $ref: '#/components/schemas/waf-managed-rules_schemas-base'
        - properties:
            allowed_modes:
              $ref: '#/components/schemas/waf-managed-rules_allowed_modes_anomaly'
            mode:
              $ref: '#/components/schemas/waf-managed-rules_mode_anomaly'
      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
      title: Anomaly detection WAF rule
    waf-managed-rules_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/waf-managed-rules_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/waf-managed-rules_result_info'
      type: object
    waf-managed-rules_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/waf-managed-rules_messages'
        messages:
          $ref: '#/components/schemas/waf-managed-rules_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    waf-managed-rules_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/waf-managed-rules_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/waf-managed-rules_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    waf-managed-rules_api-response-single:
      allOf:
        - $ref: '#/components/schemas/waf-managed-rules_api-response-common'
        - properties:
            result:
              oneOf:
                - nullable: true
                  type: object
                - nullable: true
                  type: string
      type: object
    waf-managed-rules_base:
      properties:
        description:
          $ref: '#/components/schemas/waf-managed-rules_schemas-description'
        group:
          description: The rule group to which the current WAF rule belongs.
          properties:
            id:
              $ref: '#/components/schemas/waf-managed-rules_components-schemas-identifier'
            name:
              $ref: '#/components/schemas/waf-managed-rules_name'
          readOnly: true
          type: object
        id:
          $ref: '#/components/schemas/waf-managed-rules_rule_components-schemas-identifier'
        package_id:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
        priority:
          $ref: '#/components/schemas/waf-managed-rules_priority'
    waf-managed-rules_components-schemas-identifier:
      description: The unique identifier of the rule group.
      example: de677e5818985db1285d0e80225f06e5
      maxLength: 32
      readOnly: true
      type: string
    waf-managed-rules_default_mode:
      description: The default action/mode of a rule.
      enum:
        - disable
        - simulate
        - block
        - challenge
      example: block
      readOnly: true
    waf-managed-rules_description:
      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
      type: string
    waf-managed-rules_group:
      properties:
        description:
          $ref: '#/components/schemas/waf-managed-rules_description'
        id:
          $ref: '#/components/schemas/waf-managed-rules_components-schemas-identifier'
        modified_rules_count:
          $ref: '#/components/schemas/waf-managed-rules_modified_rules_count'
        name:
          $ref: '#/components/schemas/waf-managed-rules_name'
        package_id:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
        rules_count:
          $ref: '#/components/schemas/waf-managed-rules_rules_count'
      type: object
    waf-managed-rules_identifier:
      description: The unique identifier of a WAF package.
      example: a25a9a7e9c00afc1fb2e0245519d725b
      maxLength: 32
      readOnly: true
      type: string
    waf-managed-rules_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    waf-managed-rules_mode:
      default: "on"
      description: The state of the rules contained in the rule group. When `on`, the rules in the group are configurable/usable.
      enum:
        - "on"
        - "off"
      type: string
    waf-managed-rules_mode_allow_traditional:
      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"
      type: string
    waf-managed-rules_mode_anomaly:
      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"
      type: string
    waf-managed-rules_mode_deny_traditional:
      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
      type: string
    waf-managed-rules_modified_rules_count:
      default: 0
      description: The number of rules within the group that have been modified from their default configuration.
      example: 2
      readOnly: true
      type: number
    waf-managed-rules_name:
      description: The name of the rule group.
      example: Project Honey Pot
      readOnly: true
      type: string
    waf-managed-rules_priority:
      description: The order in which the individual WAF rule is executed within its rule group.
      readOnly: true
      type: string
    waf-managed-rules_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    waf-managed-rules_rule:
      oneOf:
        - $ref: '#/components/schemas/waf-managed-rules_anomaly_rule'
        - $ref: '#/components/schemas/waf-managed-rules_traditional_deny_rule'
        - $ref: '#/components/schemas/waf-managed-rules_traditional_allow_rule'
      type: object
    waf-managed-rules_rule_components-schemas-identifier:
      description: The unique identifier of the WAF rule.
      example: f939de3be84e66e757adcdcb87908023
      maxLength: 32
      readOnly: true
      type: string
    waf-managed-rules_rule_group_response_collection:
      allOf:
        - $ref: '#/components/schemas/waf-managed-rules_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/waf-managed-rules_schemas-group'
              type: array
    waf-managed-rules_rule_group_response_single:
      allOf:
        - $ref: '#/components/schemas/waf-managed-rules_api-response-single'
        - properties:
            result:
              type: object
    waf-managed-rules_rule_response_collection:
      allOf:
        - $ref: '#/components/schemas/waf-managed-rules_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/waf-managed-rules_rule'
              type: array
    waf-managed-rules_rule_response_single:
      allOf:
        - $ref: '#/components/schemas/waf-managed-rules_api-response-single'
        - properties:
            result:
              type: object
    waf-managed-rules_rules_count:
      default: 0
      description: The number of rules in the current rule group.
      example: 10
      readOnly: true
      type: number
    waf-managed-rules_schemas-base:
      allOf:
        - $ref: '#/components/schemas/waf-managed-rules_base'
    waf-managed-rules_schemas-description:
      description: The public description of the WAF rule.
      example: SQL injection prevention for SELECT statements
      readOnly: true
      type: string
    waf-managed-rules_schemas-group:
      allOf:
        - $ref: '#/components/schemas/waf-managed-rules_group'
        - properties:
            allowed_modes:
              $ref: '#/components/schemas/waf-managed-rules_allowed_modes'
            mode:
              $ref: '#/components/schemas/waf-managed-rules_mode'
      required:
        - id
        - name
        - description
        - mode
        - rules_count
      type: object
    waf-managed-rules_schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    waf-managed-rules_traditional_allow_rule:
      allOf:
        - $ref: '#/components/schemas/waf-managed-rules_base'
        - properties:
            allowed_modes:
              $ref: '#/components/schemas/waf-managed-rules_allowed_modes_allow_traditional'
            mode:
              $ref: '#/components/schemas/waf-managed-rules_mode_allow_traditional'
      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
      title: Traditional (allow) WAF rule
    waf-managed-rules_traditional_deny_rule:
      allOf:
        - $ref: '#/components/schemas/waf-managed-rules_base'
        - properties:
            allowed_modes:
              $ref: '#/components/schemas/waf-managed-rules_allowed_modes_deny_traditional'
            default_mode:
              $ref: '#/components/schemas/waf-managed-rules_default_mode'
            mode:
              $ref: '#/components/schemas/waf-managed-rules_mode_deny_traditional'
      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
      title: Traditional (deny) WAF rule
    waitingroom_additional_routes:
      description: Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms.
      items:
        properties:
          host:
            description: The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://).
            example: shop2.example.com
            type: string
          path:
            default: /
            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.
            example: /shop2/checkout
            type: string
        type: object
      type: array
    waitingroom_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/waitingroom_schemas-api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/waitingroom_result_info'
      type: object
    waitingroom_api-response-common:
      required:
        - success
        - errors
        - messages
        - result
      type: object
    waitingroom_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/waitingroom_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/waitingroom_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    waitingroom_api-response-single:
      allOf:
        - $ref: '#/components/schemas/waitingroom_api-response-common'
        - properties:
            result:
              oneOf:
                - type: object
                - type: string
      type: object
    waitingroom_cookie_attributes:
      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:
          default: auto
          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
          example: auto
          type: string
        secure:
          default: auto
          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
          example: auto
          type: string
      type: object
    waitingroom_cookie_suffix:
      description: Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`.
      example: abcd
      type: string
    waitingroom_create_rule:
      properties:
        action:
          $ref: '#/components/schemas/waitingroom_rule_action'
        description:
          $ref: '#/components/schemas/waitingroom_rule_description'
        enabled:
          $ref: '#/components/schemas/waitingroom_rule_enabled'
        expression:
          $ref: '#/components/schemas/waitingroom_rule_expression'
      required:
        - action
        - expression
    waitingroom_custom_page_html:
      default: ""
      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:
        1. {{`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**.
        2. {{`waitTimeFormatted`}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use:
        3. {{`waitTime`}} Number of minutes of estimated wait for a user.
        4. {{`waitTimeHours`}} Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`).
        5. {{`waitTimeHourMinutes`}} Number of minutes above the `waitTimeHours` value (`waitTime%60`).
        6. {{`queueIsFull`}} Changes to **true** when no more people can be added to the queue.

        To view the full list of variables, look at the `cfWaitingRoom` object described under the `json_response_enabled` property in other Waiting Room API calls.
      example: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}'
      type: string
    waitingroom_default_template_language:
      default: en-US
      description: The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used.
      enum:
        - en-US
        - es-ES
        - de-DE
        - fr-FR
        - it-IT
        - ja-JP
        - ko-KR
        - pt-BR
        - zh-CN
        - zh-TW
        - nl-NL
        - pl-PL
        - id-ID
        - tr-TR
        - ar-EG
        - ru-RU
        - fa-IR
      example: es-ES
      type: string
    waitingroom_description:
      default: ""
      description: A note that you can use to add more details about the waiting room.
      example: Production - DO NOT MODIFY
      type: string
    waitingroom_disable_session_renewal:
      default: false
      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.
      example: false
      type: boolean
    waitingroom_enabled_origin_commands:
      default: []
      description: A list of enabled origin commands.
      items:
        enum:
          - revoke
        type: string
        uniqueItems: true
      type: array
    waitingroom_estimated_queued_users:
      type: integer
    waitingroom_estimated_total_active_users:
      type: integer
    waitingroom_event_custom_page_html:
      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
      type: string
    waitingroom_event_description:
      default: ""
      description: A note that you can use to add more details about the event.
      example: Production event - DO NOT MODIFY
      type: string
    waitingroom_event_details_custom_page_html:
      example: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}'
      type: string
    waitingroom_event_details_disable_session_renewal:
      example: false
      type: boolean
    waitingroom_event_details_new_users_per_minute:
      type: integer
    waitingroom_event_details_queueing_method:
      example: random
      type: string
    waitingroom_event_details_response:
      allOf:
        - $ref: '#/components/schemas/waitingroom_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/waitingroom_event_details_result'
    waitingroom_event_details_result:
      properties:
        created_on:
          $ref: '#/components/schemas/waitingroom_timestamp'
        custom_page_html:
          $ref: '#/components/schemas/waitingroom_event_details_custom_page_html'
        description:
          $ref: '#/components/schemas/waitingroom_event_description'
        disable_session_renewal:
          $ref: '#/components/schemas/waitingroom_event_details_disable_session_renewal'
        event_end_time:
          $ref: '#/components/schemas/waitingroom_event_end_time'
        event_start_time:
          $ref: '#/components/schemas/waitingroom_event_start_time'
        id:
          $ref: '#/components/schemas/waitingroom_event_id'
        modified_on:
          $ref: '#/components/schemas/waitingroom_timestamp'
        name:
          $ref: '#/components/schemas/waitingroom_event_name'
        new_users_per_minute:
          $ref: '#/components/schemas/waitingroom_event_details_new_users_per_minute'
        prequeue_start_time:
          $ref: '#/components/schemas/waitingroom_event_prequeue_start_time'
        queueing_method:
          $ref: '#/components/schemas/waitingroom_event_details_queueing_method'
        session_duration:
          $ref: '#/components/schemas/waitingroom_event_details_session_duration'
        shuffle_at_event_start:
          $ref: '#/components/schemas/waitingroom_event_shuffle_at_event_start'
        suspended:
          $ref: '#/components/schemas/waitingroom_event_suspended'
        total_active_users:
          $ref: '#/components/schemas/waitingroom_event_details_total_active_users'
      type: object
    waitingroom_event_details_session_duration:
      type: integer
    waitingroom_event_details_total_active_users:
      type: integer
    waitingroom_event_disable_session_renewal:
      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
      type: boolean
    waitingroom_event_end_time:
      description: An ISO 8601 timestamp that marks the end of the event.
      example: "2021-09-28T17:00:00.000Z"
      type: string
    waitingroom_event_id:
      example: 25756b2dfe6e378a06b033b670413757
      type: string
    waitingroom_event_id_response:
      allOf:
        - $ref: '#/components/schemas/waitingroom_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/waitingroom_event_id'
              type: object
    waitingroom_event_name:
      description: A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
      example: production_webinar_event
      type: string
    waitingroom_event_new_users_per_minute:
      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.
      maximum: 2.147483647e+09
      minimum: 200
      nullable: true
      type: integer
    waitingroom_event_prequeue_start_time:
      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
      type: string
    waitingroom_event_queueing_method:
      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
      type: string
    waitingroom_event_response:
      allOf:
        - $ref: '#/components/schemas/waitingroom_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/waitingroom_event_result'
    waitingroom_event_response_collection:
      allOf:
        - $ref: '#/components/schemas/waitingroom_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/waitingroom_event_result'
              type: array
    waitingroom_event_result:
      properties:
        created_on:
          $ref: '#/components/schemas/waitingroom_timestamp'
        custom_page_html:
          $ref: '#/components/schemas/waitingroom_event_custom_page_html'
        description:
          $ref: '#/components/schemas/waitingroom_event_description'
        disable_session_renewal:
          $ref: '#/components/schemas/waitingroom_event_disable_session_renewal'
        event_end_time:
          $ref: '#/components/schemas/waitingroom_event_end_time'
        event_start_time:
          $ref: '#/components/schemas/waitingroom_event_start_time'
        id:
          $ref: '#/components/schemas/waitingroom_event_id'
        modified_on:
          $ref: '#/components/schemas/waitingroom_timestamp'
        name:
          $ref: '#/components/schemas/waitingroom_event_name'
        new_users_per_minute:
          $ref: '#/components/schemas/waitingroom_event_new_users_per_minute'
        prequeue_start_time:
          $ref: '#/components/schemas/waitingroom_event_prequeue_start_time'
        queueing_method:
          $ref: '#/components/schemas/waitingroom_event_queueing_method'
        session_duration:
          $ref: '#/components/schemas/waitingroom_event_session_duration'
        shuffle_at_event_start:
          $ref: '#/components/schemas/waitingroom_event_shuffle_at_event_start'
        suspended:
          $ref: '#/components/schemas/waitingroom_event_suspended'
        total_active_users:
          $ref: '#/components/schemas/waitingroom_event_total_active_users'
      type: object
    waitingroom_event_session_duration:
      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.
      maximum: 30
      minimum: 1
      nullable: true
      type: integer
    waitingroom_event_shuffle_at_event_start:
      default: false
      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.
      type: boolean
    waitingroom_event_start_time:
      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"
      type: string
    waitingroom_event_suspended:
      default: false
      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.
      type: boolean
    waitingroom_event_total_active_users:
      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.
      maximum: 2.147483647e+09
      minimum: 200
      nullable: true
      type: integer
    waitingroom_host:
      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
      type: string
    waitingroom_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    waitingroom_json_response_enabled:
      default: false
      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:
        1. `inWaitingRoom`: Boolean indicating if the user is in the waiting room (always **true**).
        2. `waitTimeKnown`: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available.
        3. `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`.
        4. `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).
        5. `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.
        6. `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).
        7. `waitTimeFormatted`: String displaying the `waitTime` formatted in English for users. If `waitTimeKnown` is **false**, `waitTimeFormatted` will display **unavailable**.
        8. `queueIsFull`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.
        9. `queueAll`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.
        10. `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.
        11. `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**.
        12. `queueingMethod`: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**.
        13. `isFIFOQueue`: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.
        14. `isRandomQueue`: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.
        15. `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.
        16. `isRejectQueue`: Boolean indicating if the waiting room uses a reject queue.
        17. `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.
        18. `isEventPrequeueing`: Valid only when `isEventActive` is **true**. Boolean indicating if an event is currently prequeueing users before it starts.
        19. `timeUntilEventStart`: Valid only when `isEventPrequeueing` is **true**. Integer indicating the number of minutes until the event starts.
        20. `timeUntilEventStartFormatted`: String displaying the `timeUntilEventStart` formatted in English for users. If `isEventPrequeueing` is **false**, `timeUntilEventStartFormatted` will display **unavailable**.
        21. `timeUntilEventEnd`: Valid only when `isEventActive` is **true**. Integer indicating the number of minutes until the event ends.
        22. `timeUntilEventEndFormatted`: String displaying the `timeUntilEventEnd` formatted in English for users. If `isEventActive` is **false**, `timeUntilEventEndFormatted` will display **unavailable**.
        23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.

        An example cURL to a waiting room could be:

        	curl -X GET "https://example.com/waitingroom" \
        		-H "Accept: application/json"

        If `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:

        	{
        		"cfWaitingRoom": {
        			"inWaitingRoom": true,
        			"waitTimeKnown": true,
        			"waitTime": 10,
        			"waitTime25Percentile": 0,
        			"waitTime50Percentile": 0,
        			"waitTime75Percentile": 0,
        			"waitTimeFormatted": "10 minutes",
        			"queueIsFull": false,
        			"queueAll": false,
        			"lastUpdated": "2020-08-03T23:46:00.000Z",
        			"refreshIntervalSeconds": 20,
        			"queueingMethod": "fifo",
        			"isFIFOQueue": true,
        			"isRandomQueue": false,
        			"isPassthroughQueue": false,
        			"isRejectQueue": false,
        			"isEventActive": false,
        			"isEventPrequeueing": false,
        			"timeUntilEventStart": 0,
        			"timeUntilEventStartFormatted": "unavailable",
        			"timeUntilEventEnd": 0,
        			"timeUntilEventEndFormatted": "unavailable",
        			"shuffleAtEventStart": false
        		}
        	}

        If `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:

        	{
        		"cfWaitingRoom": {
        			"inWaitingRoom": true,
        			"waitTimeKnown": true,
        			"waitTime": 10,
        			"waitTime25Percentile": 5,
        			"waitTime50Percentile": 10,
        			"waitTime75Percentile": 15,
        			"waitTimeFormatted": "5 minutes to 15 minutes",
        			"queueIsFull": false,
        			"queueAll": false,
        			"lastUpdated": "2020-08-03T23:46:00.000Z",
        			"refreshIntervalSeconds": 20,
        			"queueingMethod": "random",
        			"isFIFOQueue": false,
        			"isRandomQueue": true,
        			"isPassthroughQueue": false,
        			"isRejectQueue": false,
        			"isEventActive": true,
        			"isEventPrequeueing": false,
        			"timeUntilEventStart": 0,
        			"timeUntilEventStartFormatted": "unavailable",
        			"timeUntilEventEnd": 15,
        			"timeUntilEventEndFormatted": "15 minutes",
        			"shuffleAtEventStart": true
        		}
        	}.
      example: false
      type: boolean
    waitingroom_max_estimated_time_minutes:
      type: integer
    waitingroom_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    waitingroom_name:
      description: A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed.
      example: production_webinar
      type: string
    waitingroom_new_users_per_minute:
      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.
      maximum: 2.147483647e+09
      minimum: 200
      type: integer
    waitingroom_next_event_prequeue_start_time:
      description: An ISO 8601 timestamp that marks when the next event will begin queueing.
      example: "2021-09-28T15:00:00.000Z"
      nullable: true
      type: string
    waitingroom_next_event_start_time:
      description: An ISO 8601 timestamp that marks when the next event will start.
      example: "2021-09-28T15:00:00.000Z"
      nullable: true
      type: string
    waitingroom_patch_rule:
      properties:
        action:
          $ref: '#/components/schemas/waitingroom_rule_action'
        description:
          $ref: '#/components/schemas/waitingroom_rule_description'
        enabled:
          $ref: '#/components/schemas/waitingroom_rule_enabled'
        expression:
          $ref: '#/components/schemas/waitingroom_rule_expression'
        position:
          $ref: '#/components/schemas/waitingroom_rule_position'
      required:
        - action
        - expression
    waitingroom_path:
      default: /
      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.
      example: /shop/checkout
      type: string
    waitingroom_preview_response:
      allOf:
        - $ref: '#/components/schemas/waitingroom_api-response-single'
        - properties:
            result:
              properties:
                preview_url:
                  $ref: '#/components/schemas/waitingroom_preview_url'
              type: object
    waitingroom_preview_url:
      description: URL where the custom waiting room page can temporarily be previewed.
      example: http://waitingrooms.dev/preview/35af8c12-6d68-4608-babb-b53435a5ddfb
      type: string
    waitingroom_query_event:
      properties:
        custom_page_html:
          $ref: '#/components/schemas/waitingroom_event_custom_page_html'
        description:
          $ref: '#/components/schemas/waitingroom_event_description'
        disable_session_renewal:
          $ref: '#/components/schemas/waitingroom_event_disable_session_renewal'
        event_end_time:
          $ref: '#/components/schemas/waitingroom_event_end_time'
        event_start_time:
          $ref: '#/components/schemas/waitingroom_event_start_time'
        name:
          $ref: '#/components/schemas/waitingroom_event_name'
        new_users_per_minute:
          $ref: '#/components/schemas/waitingroom_event_new_users_per_minute'
        prequeue_start_time:
          $ref: '#/components/schemas/waitingroom_event_prequeue_start_time'
        queueing_method:
          $ref: '#/components/schemas/waitingroom_event_queueing_method'
        session_duration:
          $ref: '#/components/schemas/waitingroom_event_session_duration'
        shuffle_at_event_start:
          $ref: '#/components/schemas/waitingroom_event_shuffle_at_event_start'
        suspended:
          $ref: '#/components/schemas/waitingroom_event_suspended'
        total_active_users:
          $ref: '#/components/schemas/waitingroom_event_total_active_users'
      required:
        - name
        - event_start_time
        - event_end_time
      type: object
    waitingroom_query_preview:
      properties:
        custom_html:
          $ref: '#/components/schemas/waitingroom_custom_page_html'
      required:
        - custom_html
      type: object
    waitingroom_query_waitingroom:
      properties:
        additional_routes:
          $ref: '#/components/schemas/waitingroom_additional_routes'
        cookie_attributes:
          $ref: '#/components/schemas/waitingroom_cookie_attributes'
        cookie_suffix:
          $ref: '#/components/schemas/waitingroom_cookie_suffix'
        custom_page_html:
          $ref: '#/components/schemas/waitingroom_custom_page_html'
        default_template_language:
          $ref: '#/components/schemas/waitingroom_default_template_language'
        description:
          $ref: '#/components/schemas/waitingroom_description'
        disable_session_renewal:
          $ref: '#/components/schemas/waitingroom_disable_session_renewal'
        enabled_origin_commands:
          $ref: '#/components/schemas/waitingroom_enabled_origin_commands'
        host:
          $ref: '#/components/schemas/waitingroom_host'
        json_response_enabled:
          $ref: '#/components/schemas/waitingroom_json_response_enabled'
        name:
          $ref: '#/components/schemas/waitingroom_name'
        new_users_per_minute:
          $ref: '#/components/schemas/waitingroom_new_users_per_minute'
        path:
          $ref: '#/components/schemas/waitingroom_path'
        queue_all:
          $ref: '#/components/schemas/waitingroom_queue_all'
        queueing_method:
          $ref: '#/components/schemas/waitingroom_queueing_method'
        queueing_status_code:
          $ref: '#/components/schemas/waitingroom_queueing_status_code'
        session_duration:
          $ref: '#/components/schemas/waitingroom_session_duration'
        suspended:
          $ref: '#/components/schemas/waitingroom_suspended'
        total_active_users:
          $ref: '#/components/schemas/waitingroom_total_active_users'
      required:
        - name
        - host
        - new_users_per_minute
        - total_active_users
      type: object
    waitingroom_queue_all:
      default: false
      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.
      example: true
      type: boolean
    waitingroom_queueing_method:
      default: fifo
      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
      example: fifo
      type: string
    waitingroom_queueing_status_code:
      default: 200
      description: HTTP status code returned to a user while in the queue.
      enum:
        - 200
        - 202
        - 429
      example: 202
      type: integer
    waitingroom_response_collection:
      allOf:
        - $ref: '#/components/schemas/waitingroom_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/waitingroom_waitingroom'
              type: array
    waitingroom_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    waitingroom_rule_action:
      description: The action to take when the expression matches.
      enum:
        - bypass_waiting_room
      example: bypass_waiting_room
      type: string
    waitingroom_rule_description:
      default: ""
      description: The description of the rule.
      example: allow all traffic from 10.20.30.40
      type: string
    waitingroom_rule_enabled:
      default: true
      description: When set to true, the rule is enabled.
      example: true
      type: boolean
    waitingroom_rule_expression:
      description: Criteria defining when there is a match for the current rule.
      example: ip.src in {10.20.30.40}
      type: string
    waitingroom_rule_id:
      description: The ID of the rule.
      example: 25756b2dfe6e378a06b033b670413757
      type: string
    waitingroom_rule_position:
      description: Reorder the position of a rule
      oneOf:
        - properties:
            index:
              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: integer
          type: object
        - properties:
            before:
              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: string
          type: object
        - properties:
            after:
              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: string
          type: object
      type: object
    waitingroom_rule_result:
      properties:
        action:
          $ref: '#/components/schemas/waitingroom_rule_action'
        description:
          $ref: '#/components/schemas/waitingroom_rule_description'
        enabled:
          $ref: '#/components/schemas/waitingroom_rule_enabled'
        expression:
          $ref: '#/components/schemas/waitingroom_rule_expression'
        id:
          $ref: '#/components/schemas/waitingroom_rule_id'
        last_updated:
          $ref: '#/components/schemas/waitingroom_timestamp'
        version:
          $ref: '#/components/schemas/waitingroom_rule_version'
      type: object
    waitingroom_rule_version:
      description: The version of the rule.
      example: "1"
      type: string
    waitingroom_rules_response_collection:
      allOf:
        - $ref: '#/components/schemas/waitingroom_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/waitingroom_rule_result'
              type: array
    waitingroom_schemas-api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/waitingroom_messages'
        messages:
          $ref: '#/components/schemas/waitingroom_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    waitingroom_search_engine_crawler_bypass:
      default: false
      description: |
        Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone.
        Verified search engine crawlers will not be tracked or counted by the waiting room system,
        and will not appear in waiting room analytics.
      example: true
      type: boolean
    waitingroom_session_duration:
      default: 5
      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.
      maximum: 30
      minimum: 1
      type: integer
    waitingroom_single_response:
      allOf:
        - $ref: '#/components/schemas/waitingroom_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/waitingroom_waitingroom'
    waitingroom_status:
      enum:
        - event_prequeueing
        - not_queueing
        - queueing
      example: queueing
      type: string
    waitingroom_status_event_id:
      example: 25756b2dfe6e378a06b033b670413757
      type: string
    waitingroom_status_response:
      allOf:
        - $ref: '#/components/schemas/waitingroom_api-response-single'
        - properties:
            result:
              properties:
                estimated_queued_users:
                  $ref: '#/components/schemas/waitingroom_estimated_queued_users'
                estimated_total_active_users:
                  $ref: '#/components/schemas/waitingroom_estimated_total_active_users'
                event_id:
                  $ref: '#/components/schemas/waitingroom_status_event_id'
                max_estimated_time_minutes:
                  $ref: '#/components/schemas/waitingroom_max_estimated_time_minutes'
                status:
                  $ref: '#/components/schemas/waitingroom_status'
              type: object
    waitingroom_suspended:
      default: false
      description: Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room.
      type: boolean
    waitingroom_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      readOnly: true
      type: string
    waitingroom_total_active_users:
      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.
      maximum: 2.147483647e+09
      minimum: 200
      type: integer
    waitingroom_update_rules:
      items:
        $ref: '#/components/schemas/waitingroom_create_rule'
      type: array
    waitingroom_waiting_room_id:
      example: 699d98642c564d2e855e9661899b7252
      type: string
    waitingroom_waiting_room_id_response:
      allOf:
        - $ref: '#/components/schemas/waitingroom_api-response-single'
        - properties:
            result:
              properties:
                id:
                  $ref: '#/components/schemas/waitingroom_waiting_room_id'
              type: object
    waitingroom_waitingroom:
      properties:
        additional_routes:
          $ref: '#/components/schemas/waitingroom_additional_routes'
        cookie_attributes:
          $ref: '#/components/schemas/waitingroom_cookie_attributes'
        cookie_suffix:
          $ref: '#/components/schemas/waitingroom_cookie_suffix'
        created_on:
          $ref: '#/components/schemas/waitingroom_timestamp'
        custom_page_html:
          $ref: '#/components/schemas/waitingroom_custom_page_html'
        default_template_language:
          $ref: '#/components/schemas/waitingroom_default_template_language'
        description:
          $ref: '#/components/schemas/waitingroom_description'
        disable_session_renewal:
          $ref: '#/components/schemas/waitingroom_disable_session_renewal'
        enabled_origin_commands:
          $ref: '#/components/schemas/waitingroom_enabled_origin_commands'
        host:
          $ref: '#/components/schemas/waitingroom_host'
        id:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
        json_response_enabled:
          $ref: '#/components/schemas/waitingroom_json_response_enabled'
        modified_on:
          $ref: '#/components/schemas/waitingroom_timestamp'
        name:
          $ref: '#/components/schemas/waitingroom_name'
        new_users_per_minute:
          $ref: '#/components/schemas/waitingroom_new_users_per_minute'
        next_event_prequeue_start_time:
          $ref: '#/components/schemas/waitingroom_next_event_prequeue_start_time'
        next_event_start_time:
          $ref: '#/components/schemas/waitingroom_next_event_start_time'
        path:
          $ref: '#/components/schemas/waitingroom_path'
        queue_all:
          $ref: '#/components/schemas/waitingroom_queue_all'
        queueing_method:
          $ref: '#/components/schemas/waitingroom_queueing_method'
        queueing_status_code:
          $ref: '#/components/schemas/waitingroom_queueing_status_code'
        session_duration:
          $ref: '#/components/schemas/waitingroom_session_duration'
        suspended:
          $ref: '#/components/schemas/waitingroom_suspended'
        total_active_users:
          $ref: '#/components/schemas/waitingroom_total_active_users'
      type: object
    waitingroom_zone_settings:
      properties:
        search_engine_crawler_bypass:
          $ref: '#/components/schemas/waitingroom_search_engine_crawler_bypass'
      type: object
    waitingroom_zone_settings_response:
      allOf:
        - $ref: '#/components/schemas/waitingroom_api-response-single'
        - properties:
            result:
              properties:
                search_engine_crawler_bypass:
                  $ref: '#/components/schemas/waitingroom_search_engine_crawler_bypass'
              required:
                - search_engine_crawler_bypass
              type: object
          required:
            - result
    web3_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/web3_api-response-common'
        - properties:
            result:
              items: {}
              nullable: true
              type: array
            result_info:
              $ref: '#/components/schemas/web3_result_info'
      type: object
    web3_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/web3_messages'
        messages:
          $ref: '#/components/schemas/web3_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    web3_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/web3_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/web3_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    web3_api-response-single:
      allOf:
        - $ref: '#/components/schemas/web3_api-response-common'
        - properties:
            result:
              anyOf:
                - nullable: true
                  type: object
                - nullable: true
                  type: string
      type: object
    web3_api-response-single-id:
      allOf:
        - $ref: '#/components/schemas/web3_api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                id:
                  $ref: '#/components/schemas/web3_identifier'
              required:
                - id
              type: object
      type: object
    web3_collection_response:
      allOf:
        - $ref: '#/components/schemas/web3_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/web3_web3-hostname'
              type: array
    web3_content_list_action:
      description: Behavior of the content list.
      enum:
        - block
      example: block
      type: string
    web3_content_list_details:
      properties:
        action:
          $ref: '#/components/schemas/web3_content_list_action'
      type: object
    web3_content_list_details_response:
      allOf:
        - $ref: '#/components/schemas/web3_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/web3_content_list_details'
    web3_content_list_entries:
      description: Content list entries.
      items:
        $ref: '#/components/schemas/web3_content_list_entry'
      type: array
    web3_content_list_entry:
      description: Content list entry to be blocked.
      properties:
        content:
          $ref: '#/components/schemas/web3_content_list_entry_content'
        created_on:
          $ref: '#/components/schemas/web3_timestamp'
        description:
          $ref: '#/components/schemas/web3_content_list_entry_description'
        id:
          $ref: '#/components/schemas/web3_identifier'
        modified_on:
          $ref: '#/components/schemas/web3_timestamp'
        type:
          $ref: '#/components/schemas/web3_content_list_entry_type'
      type: object
    web3_content_list_entry_collection_response:
      allOf:
        - $ref: '#/components/schemas/web3_api-response-collection'
        - properties:
            result:
              properties:
                entries:
                  $ref: '#/components/schemas/web3_content_list_entries'
              type: object
    web3_content_list_entry_content:
      description: CID or content path of content to block.
      example: QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB
      maxLength: 500
      type: string
    web3_content_list_entry_create_request:
      properties:
        content:
          $ref: '#/components/schemas/web3_content_list_entry_content'
        description:
          $ref: '#/components/schemas/web3_content_list_entry_description'
        type:
          $ref: '#/components/schemas/web3_content_list_entry_type'
      required:
        - type
        - content
      type: object
    web3_content_list_entry_description:
      description: An optional description of the content list entry.
      example: this is my content list entry
      maxLength: 500
      type: string
    web3_content_list_entry_single_response:
      allOf:
        - $ref: '#/components/schemas/web3_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/web3_content_list_entry'
    web3_content_list_entry_type:
      description: Type of content list entry to block.
      enum:
        - cid
        - content_path
      example: cid
      type: string
    web3_content_list_update_request:
      properties:
        action:
          $ref: '#/components/schemas/web3_content_list_action'
        entries:
          $ref: '#/components/schemas/web3_content_list_entries'
      required:
        - action
        - entries
      type: object
    web3_create_request:
      properties:
        description:
          $ref: '#/components/schemas/web3_description'
        dnslink:
          $ref: '#/components/schemas/web3_dnslink'
        name:
          $ref: '#/components/schemas/web3_name'
        target:
          $ref: '#/components/schemas/web3_target'
      required:
        - name
        - target
      type: object
    web3_description:
      description: An optional description of the hostname.
      example: This is my IPFS gateway.
      maxLength: 500
      type: string
    web3_dnslink:
      description: DNSLink value used if the target is ipfs.
      example: /ipns/onboarding.ipfs.cloudflare.com
      type: string
    web3_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    web3_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    web3_modify_request:
      properties:
        description:
          $ref: '#/components/schemas/web3_description'
        dnslink:
          $ref: '#/components/schemas/web3_dnslink'
      type: object
    web3_name:
      description: The hostname that will point to the target gateway via CNAME.
      example: gateway.example.com
      maxLength: 255
      readOnly: true
      type: string
    web3_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    web3_single_response:
      allOf:
        - $ref: '#/components/schemas/web3_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/web3_web3-hostname'
    web3_status:
      description: Status of the hostname's activation.
      enum:
        - active
        - pending
        - deleting
        - error
      example: active
      readOnly: true
      type: string
    web3_target:
      description: Target gateway of the hostname.
      enum:
        - ethereum
        - ipfs
        - ipfs_universal_path
      example: ipfs
      type: string
    web3_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      readOnly: true
      type: string
    web3_web3-hostname:
      properties:
        created_on:
          $ref: '#/components/schemas/web3_timestamp'
        description:
          $ref: '#/components/schemas/web3_description'
        dnslink:
          $ref: '#/components/schemas/web3_dnslink'
        id:
          $ref: '#/components/schemas/web3_identifier'
        modified_on:
          $ref: '#/components/schemas/web3_timestamp'
        name:
          $ref: '#/components/schemas/web3_name'
        status:
          $ref: '#/components/schemas/web3_status'
        target:
          $ref: '#/components/schemas/web3_target'
      type: object
    workers-kv_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/workers-kv_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/workers-kv_result_info'
          type: object
      type: object
    workers-kv_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/workers-kv_messages'
        messages:
          $ref: '#/components/schemas/workers-kv_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    workers-kv_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/workers-kv_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/workers-kv_messages'
          example: []
        result:
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    workers-kv_api-response-common-no-result:
      allOf:
        - $ref: '#/components/schemas/workers-kv_api-response-common'
        - properties:
            result:
              nullable: true
              type: object
              x-stainless-empty-object: true
          type: object
    workers-kv_bulk_delete:
      items:
        $ref: '#/components/schemas/workers-kv_key_name_bulk'
      type: array
    workers-kv_bulk_write:
      items:
        properties:
          base64:
            default: false
            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.
            type: boolean
          expiration:
            $ref: '#/components/schemas/workers-kv_expiration'
          expiration_ttl:
            $ref: '#/components/schemas/workers-kv_expiration_ttl'
          key:
            $ref: '#/components/schemas/workers-kv_key_name_bulk'
          metadata:
            $ref: '#/components/schemas/workers-kv_list_metadata'
          value:
            description: A UTF-8 encoded string to be stored, up to 25 MiB in length.
            example: Some string
            maxLength: 26214400
            type: string
        type: object
      required:
        - key
        - value
      type: array
    workers-kv_components-schemas-result:
      allOf:
        - $ref: '#/components/schemas/workers-kv_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/workers-kv_query'
            totals:
              example:
                storedBytes: 48
                storedKeys: 6
    workers-kv_create_rename_namespace_body:
      properties:
        title:
          $ref: '#/components/schemas/workers-kv_namespace_title'
      required:
        - title
      type: object
    workers-kv_cursor:
      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
      type: string
    workers-kv_expiration:
      description: The time, measured in number of seconds since the UNIX epoch, at which the key should expire.
      example: 1.578435e+09
      type: number
    workers-kv_expiration_ttl:
      description: The number of seconds for which the key should be visible before it expires. At least 60.
      example: 300
      type: number
    workers-kv_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    workers-kv_key:
      description: A name for a value. A value stored under a given key may be retrieved via the same key.
      properties:
        expiration:
          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
          type: number
        metadata:
          $ref: '#/components/schemas/workers-kv_list_metadata'
        name:
          $ref: '#/components/schemas/workers-kv_key_name'
      required:
        - name
      type: object
    workers-kv_key_name:
      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
      type: string
    workers-kv_key_name_bulk:
      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
      type: string
    workers-kv_list_metadata:
      additionalProperties: true
      description: Arbitrary JSON that is associated with a key.
      example:
        someMetadataKey: someMetadataValue
      type: object
    workers-kv_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    workers-kv_metadata:
      description: Arbitrary JSON to be associated with a key/value pair.
      example: '{"someMetadataKey": "someMetadataValue"}'
      type: string
    workers-kv_namespace:
      properties:
        id:
          $ref: '#/components/schemas/workers-kv_namespace_identifier'
        supports_url_encoding:
          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
          type: boolean
        title:
          $ref: '#/components/schemas/workers-kv_namespace_title'
      required:
        - id
        - title
      type: object
    workers-kv_namespace_identifier:
      description: Namespace identifier tag.
      example: 0f2ac74b498b48028cb68387c421e279
      maxLength: 32
      readOnly: true
      type: string
    workers-kv_namespace_title:
      description: A human-readable string name for a Namespace.
      example: My Own Namespace
      type: string
    workers-kv_query:
      description: For specifying result metrics.
      properties:
        dimensions:
          default: '[]'
          description: Can be used to break down the data by given attributes.
          items:
            description: For drilling down on metrics.
            type: string
          type: array
        filters:
          default: '""'
          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:

            Operator                  | Name                            | URL Encoded
            --------------------------|---------------------------------|--------------------------
            ==                        | Equals                          | %3D%3D
            !=                        | Does not equals                 | !%3D
            >                        | Greater Than                    | %3E
            <                         | Less Than                       | %3C
            >=                       | Greater than or equal to        | %3E%3D
            <=                        | Less than or equal to           | %3C%3D     .
          type: string
        limit:
          default: 10000
          description: Limit number of returned metrics.
          type: integer
        metrics:
          description: One or more metrics to compute.
          items:
            description: A quantitative measurement of KV usage.
            type: string
          type: array
        since:
          default: <6 hours ago>
          description: Start of time interval to query, defaults to 6 hours before request received.
          example: "2019-01-02T02:20:00Z"
          format: date-time
          type: string
        sort:
          default: '[]'
          description: Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending).
          items:
            type: string
          type: array
        until:
          default: <now>
          description: End of time interval to query, defaults to current time.
          example: "2019-01-02T03:20:00Z"
          format: date-time
          type: string
      type: object
    workers-kv_result:
      description: Metrics on Workers KV requests.
      properties:
        data:
          items:
            properties:
              dimensions:
                items:
                  type: string
                type: array
              metrics:
                description: List of metrics returned by the query.
                items:
                  items:
                    format: float
                    type: number
                  type: array
                type: array
            required:
              - metrics
            type: object
          nullable: true
          type: array
        data_lag:
          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
          type: number
        max:
          additionalProperties:
            type: number
          description: Maximum results for each metric.
          type: object
        min:
          additionalProperties:
            type: number
          description: Minimum results for each metric.
          type: object
        query:
          $ref: '#/components/schemas/workers-kv_query'
        rows:
          description: Total number of rows in the result.
          example: 2
          minimum: 0
          type: number
        time_intervals:
          description: Time interval buckets by beginning and ending
          items:
            items:
              example: "2019-01-02T02:20:00Z"
              format: date-time
              maxItems: 2
              minItems: 2
              type: string
            type: array
          type: array
        totals:
          additionalProperties:
            type: number
          description: Total results for metrics across all data.
          type: object
      required:
        - rows
        - data
        - data_lag
        - min
        - max
        - totals
        - query
      type: object
    workers-kv_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    workers-kv_schemas-result:
      allOf:
        - $ref: '#/components/schemas/workers-kv_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/workers-kv_query'
            totals:
              example:
                readKiB: 48
                requests: 6
    workers-kv_value:
      description: A byte sequence to be stored, up to 25 MiB in length.
      example: Some Value
      type: string
    workers_account-settings:
      properties:
        default_usage_model:
          type: string
        green_compute:
          type: boolean
      type: object
    workers_account-settings-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/workers_account-settings'
    workers_account_identifier:
      description: Identifer of the account.
      example: 9a7806061c88ada191ed06f989cc3dac
      type: string
    workers_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/workers_result_info'
      type: object
    workers_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/workers_messages'
        messages:
          $ref: '#/components/schemas/workers_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    workers_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/workers_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/workers_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    workers_api-response-single:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
      type: object
    workers_api-response-single-id:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                id:
                  $ref: '#/components/schemas/workers_identifier'
              required:
                - id
              type: object
      type: object
    workers_binding:
      description: A binding to allow the Worker to communicate with resources
      oneOf:
        - $ref: '#/components/schemas/workers_kv_namespace_binding'
        - $ref: '#/components/schemas/workers_service_binding'
        - $ref: '#/components/schemas/workers_do_binding'
        - $ref: '#/components/schemas/workers_r2_binding'
        - $ref: '#/components/schemas/workers_queue_binding'
        - $ref: '#/components/schemas/workers_d1_binding'
        - $ref: '#/components/schemas/workers_dispatch_namespace_binding'
        - $ref: '#/components/schemas/workers_mtls_cert_binding'
      type: object
    workers_binding_name:
      description: A JavaScript variable name for the binding.
      example: myBinding
      readOnly: true
      type: string
    workers_bindings:
      description: List of bindings attached to this Worker
      items:
        $ref: '#/components/schemas/workers_binding'
      type: array
    workers_compatibility_date:
      description: Opt your Worker into changes after this date
      example: "2022-04-05"
      type: string
    workers_compatibility_flag:
      description: A flag to opt into a specific change
      example: formdata_parser_supports_files
      type: string
    workers_compatibility_flags:
      description: Opt your Worker into specific changes
      items:
        $ref: '#/components/schemas/workers_compatibility_flag'
      type: array
    workers_created_on:
      description: When the script was created.
      example: "2017-01-01T00:00:00Z"
      format: date-time
      readOnly: true
      type: string
    workers_cron-object:
      properties:
        created_on:
          readOnly: true
          type: string
        cron:
          example: '*/30 * * * *'
          type: string
        modified_on:
          readOnly: true
          type: string
      type: object
    workers_cron-trigger-response-collection:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              properties:
                schedules:
                  items:
                    $ref: '#/components/schemas/workers_cron-object'
                  type: array
              type: object
    workers_cursor:
      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
      type: string
    workers_d1_binding:
      properties:
        binding:
          $ref: '#/components/schemas/workers_binding_name'
        id:
          description: ID of the D1 database to bind to
          example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          type: string
        name:
          description: The name of the D1 database associated with the 'id' provided.
          example: prod-database-auth
          type: string
        type:
          description: The class of resource that the binding provides.
          enum:
            - d1
          example: d1
          type: string
      required:
        - id
        - name
        - type
        - binding
      type: object
    workers_deployment_identifier:
      example: bcf48806-b317-4351-9ee7-36e7d557d4de
      maxLength: 36
      readOnly: true
      type: string
    workers_deployments-base:
      properties:
        annotations:
          properties:
            workers/message:
              description: Human-readable message about the deployment.
              example: Deploy bug fix.
              maxLength: 50
              type: string
          type: object
        author_email:
          example: user@example.com
          readOnly: true
          type: string
        created_on:
          example: "2022-11-08T17:19:29.176266Z"
          readOnly: true
          type: string
        id:
          allOf:
            - $ref: '#/components/schemas/workers_schemas-deployment_identifier'
          readOnly: true
        source:
          example: api
          readOnly: true
          type: string
        strategy:
          type: string
      type: object
    workers_deployments-create-body:
      allOf:
        - $ref: '#/components/schemas/workers_deployments-base'
        - oneOf:
            - $ref: '#/components/schemas/workers_deployments-strategy-percentage'
    workers_deployments-list-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              properties:
                items:
                  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:
                    $ref: '#/components/schemas/workers_version-item-short'
                  type: array
                latest:
                  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
                  type: object
              type: object
    workers_deployments-single-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              properties:
                id:
                  example: 18f97339-c287-4872-9bdd-e2135c07ec12
                  type: string
                metadata:
                  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
                  type: object
                number:
                  example: 1
                  type: number
                resources:
                  example:
                    bindings:
                      - json: example_binding
                        name: JSON_VAR
                        type: json
                    script:
                      etag: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794
                      handlers:
                        - fetch
                      last_deployed_from: api
                    script_runtime:
                      usage_model: bundled
                  type: object
              type: object
    workers_deployments-strategy-percentage:
      properties:
        strategy:
          enum:
            - percentage
          type: string
        versions:
          items:
            properties:
              percentage:
                example: 100
                maximum: 100
                minimum: 0.01
                type: number
              version_id:
                $ref: '#/components/schemas/workers_schemas-version_identifier'
            required:
              - version_id
              - percentage
            type: object
          type: array
      required:
        - strategy
        - versions
      type: object
    workers_dispatch_namespace_binding:
      properties:
        name:
          $ref: '#/components/schemas/workers_binding_name'
        namespace:
          description: Namespace to bind to
          example: my-namespace
          type: string
        outbound:
          description: Outbound worker
          properties:
            params:
              description: Pass information from the Dispatch Worker to the Outbound Worker through the parameters
              items:
                example: url
                type: string
              type: array
            worker:
              description: Outbound worker
              properties:
                environment:
                  description: Environment of the outbound worker
                  type: string
                service:
                  description: Name of the outbound worker
                  type: string
              type: object
          type: object
        type:
          description: The class of resource that the binding provides.
          enum:
            - dispatch_namespace
          example: dispatch_namespace
          type: string
      required:
        - name
        - type
        - namespace
      type: object
    workers_dispatch_namespace_name:
      description: Name of the Workers for Platforms dispatch namespace.
      example: my-dispatch-namespace
      pattern: ^.+$
      type: string
    workers_do_binding:
      properties:
        class_name:
          description: The exported class name of the Durable Object
          example: MyDurableObject
          type: string
        environment:
          description: The environment of the script_name to bind to
          example: production
          type: string
        name:
          $ref: '#/components/schemas/workers_binding_name'
        namespace_id:
          $ref: '#/components/schemas/workers_namespace_identifier'
        script_name:
          description: The script where the Durable Object is defined, if it is external to this Worker
          example: my-other-worker
          type: string
        type:
          description: The class of resource that the binding provides.
          enum:
            - durable_object_namespace
          example: durable_object_namespace
          type: string
      required:
        - name
        - type
        - class_name
      type: object
    workers_domain:
      properties:
        environment:
          $ref: '#/components/schemas/workers_schemas-environment'
        hostname:
          $ref: '#/components/schemas/workers_hostname'
        id:
          $ref: '#/components/schemas/workers_domain_identifier'
        service:
          $ref: '#/components/schemas/workers_schemas-service'
        zone_id:
          $ref: '#/components/schemas/workers_zone_identifier'
        zone_name:
          $ref: '#/components/schemas/workers_zone_name'
      type: object
    workers_domain-response-collection:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/workers_domain'
              type: array
          type: object
    workers_domain-response-single:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/workers_domain'
          type: object
    workers_domain_identifier:
      description: Identifer of the Worker Domain.
      example: dbe10b4bc17c295377eabd600e1787fd
      type: string
    workers_enabled:
      example: true
      title: Whether or not this filter will run a script
      type: boolean
    workers_environment:
      description: Optional environment if the Worker utilizes one.
      example: production
      type: string
    workers_etag:
      description: Hashed script content, can be used in a If-None-Match header when updating.
      example: ea95132c15732412d22c1476fa83f27a
      readOnly: true
      type: string
    workers_filter-no-id:
      properties:
        enabled:
          $ref: '#/components/schemas/workers_enabled'
        pattern:
          $ref: '#/components/schemas/workers_schemas-pattern'
      required:
        - pattern
        - enabled
    workers_filter-response-collection:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/workers_filters'
              type: array
    workers_filter-response-single:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/workers_filters'
    workers_filters:
      properties:
        enabled:
          $ref: '#/components/schemas/workers_enabled'
        id:
          $ref: '#/components/schemas/workers_identifier'
        pattern:
          $ref: '#/components/schemas/workers_schemas-pattern'
      required:
        - id
        - pattern
        - enabled
      type: object
    workers_hostname:
      description: Hostname of the Worker Domain.
      example: foo.example.com
      type: string
    workers_id:
      description: Identifier for the tail.
      example: 03dc9f77817b488fb26c5861ec18f791
      type: string
    workers_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    workers_kv_namespace_binding:
      properties:
        name:
          $ref: '#/components/schemas/workers_binding_name'
        namespace_id:
          $ref: '#/components/schemas/workers_namespace_identifier'
        type:
          description: The class of resource that the binding provides.
          enum:
            - kv_namespace
          example: kv_namespace
          type: string
      required:
        - name
        - type
        - namespace_id
      type: object
    workers_limits:
      description: Limits to apply for this Worker.
      properties:
        cpu_ms:
          description: The amount of CPU time this Worker can use in milliseconds.
          example: 50
          type: integer
      type: object
    workers_logpush:
      description: Whether Logpush is turned on for the Worker.
      example: false
      type: boolean
    workers_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    workers_migration_step:
      properties:
        deleted_classes:
          description: A list of classes to delete Durable Object namespaces from.
          items:
            type: string
          type: array
        new_classes:
          description: A list of classes to create Durable Object namespaces from.
          items:
            type: string
          type: array
        new_sqlite_classes:
          description: A list of classes to create Durable Object namespaces with SQLite from.
          items:
            type: string
          type: array
        renamed_classes:
          description: A list of classes with Durable Object namespaces that were renamed.
          items:
            properties:
              from:
                type: string
              to:
                type: string
            type: object
          type: array
        transferred_classes:
          description: A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
          items:
            properties:
              from:
                type: string
              from_script:
                type: string
              to:
                type: string
            type: object
          type: array
      type: object
    workers_migration_tag_conditions:
      properties:
        new_tag:
          description: Tag to set as the latest migration tag.
          example: v2
          type: string
        old_tag:
          description: Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected.
          example: v1
          type: string
      type: object
    workers_modified_on:
      description: When the script was last modified.
      example: "2017-01-01T00:00:00Z"
      format: date-time
      readOnly: true
      type: string
    workers_mtls_cert_binding:
      properties:
        certificate_id:
          description: ID of the certificate to bind to
          example: efwu2n6s-q69d-2kr9-184j-4913e8h391k6
          type: string
        name:
          $ref: '#/components/schemas/workers_binding_name'
        type:
          description: The class of resource that the binding provides.
          enum:
            - mtls_certificate
          example: mtls_certificate
          type: string
      required:
        - name
        - type
        - certificate
      type: object
    workers_namespace:
      properties:
        class:
          type: string
        id:
          readOnly: true
          type: string
        name:
          type: string
        script:
          type: string
        use_sqlite:
          type: boolean
      type: object
    workers_namespace-delete-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              enum:
                - 
              nullable: true
              type: object
    workers_namespace-list-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/workers_namespace-response'
              type: array
    workers_namespace-response:
      properties:
        created_by:
          $ref: '#/components/schemas/workers_identifier'
        created_on:
          $ref: '#/components/schemas/workers_created_on'
        modified_by:
          $ref: '#/components/schemas/workers_identifier'
        modified_on:
          $ref: '#/components/schemas/workers_modified_on'
        namespace_id:
          $ref: '#/components/schemas/workers_uuid'
        namespace_name:
          $ref: '#/components/schemas/workers_dispatch_namespace_name'
        script_count:
          $ref: '#/components/schemas/workers_script_count'
    workers_namespace-script-response:
      description: Details about a worker uploaded to a Workers for Platforms namespace.
      properties:
        created_on:
          $ref: '#/components/schemas/workers_created_on'
        dispatch_namespace:
          $ref: '#/components/schemas/workers_dispatch_namespace_name'
        modified_on:
          $ref: '#/components/schemas/workers_modified_on'
        script:
          $ref: '#/components/schemas/workers_script-response'
      type: object
    workers_namespace-script-response-single:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/workers_namespace-script-response'
    workers_namespace-single-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/workers_namespace-response'
    workers_namespace_identifier:
      description: Namespace identifier tag.
      example: 0f2ac74b498b48028cb68387c421e279
      maxLength: 32
      readOnly: true
      type: string
    workers_object:
      properties:
        hasStoredData:
          description: Whether the Durable Object has stored data.
          example: true
          readOnly: true
          type: boolean
        id:
          description: ID of the Durable Object.
          example: fe7803fc55b964e09d94666545aab688d360c6bda69ba349ced1e5f28d2fc2c8
          readOnly: true
          type: string
      type: object
    workers_pattern:
      example: example.net/*
      title: Route pattern
      type: string
    workers_placement_config:
      properties:
        mode:
          description: Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). Only `"smart"` is currently supported
          enum:
            - smart
          type: string
      type: object
    workers_placement_mode:
      description: Specifies the placement mode for the Worker (e.g. 'smart').
      example: smart
      type: string
    workers_queue_binding:
      properties:
        name:
          $ref: '#/components/schemas/workers_binding_name'
        queue_name:
          description: Name of the Queue to bind to
          example: my-queue
          type: string
        type:
          description: The class of resource that the binding provides.
          enum:
            - queue
          example: queue
          type: string
      required:
        - name
        - type
        - queue_name
      type: object
    workers_r2_binding:
      properties:
        bucket_name:
          description: R2 bucket to bind to
          example: my-r2-bucket
          type: string
        name:
          $ref: '#/components/schemas/workers_binding_name'
        type:
          description: The class of resource that the binding provides.
          enum:
            - r2_bucket
          example: r2_bucket
          type: string
      required:
        - name
        - type
        - bucket_name
      type: object
    workers_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    workers_route-no-id:
      properties:
        pattern:
          $ref: '#/components/schemas/workers_pattern'
        script:
          $ref: '#/components/schemas/workers_script_name'
      required:
        - pattern
    workers_route-response-collection:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/workers_routes'
              type: array
    workers_route-response-single:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/workers_routes'
    workers_routes:
      properties:
        id:
          $ref: '#/components/schemas/workers_identifier'
        pattern:
          $ref: '#/components/schemas/workers_pattern'
        script:
          $ref: '#/components/schemas/workers_script_name'
      required:
        - id
        - pattern
        - script
      type: object
    workers_schemas-binding:
      oneOf:
        - $ref: '#/components/schemas/workers_kv_namespace_binding'
        - $ref: '#/components/schemas/workers_wasm_module_binding'
    workers_schemas-deployment_identifier:
      example: dc78f0bc-05c5-46b7-bb4e-137f55930378
      maxLength: 36
      type: string
    workers_schemas-deployments-list-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              properties:
                deployments:
                  items:
                    allOf:
                      - $ref: '#/components/schemas/workers_deployments-base'
                      - oneOf:
                          - $ref: '#/components/schemas/workers_deployments-strategy-percentage'
                  type: array
              type: object
          type: object
    workers_schemas-deployments-single-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/workers_deployments-base'
                - oneOf:
                    - $ref: '#/components/schemas/workers_deployments-strategy-percentage'
          type: object
    workers_schemas-environment:
      description: Worker environment associated with the zone and hostname.
      example: production
      type: string
    workers_schemas-id:
      description: ID of the namespace.
      example: 5fd1cafff895419c8bcc647fc64ab8f0
      type: string
    workers_schemas-pattern:
      example: example.net/*
      title: Filter pattern
      type: string
    workers_schemas-script-response-single:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-single'
        - properties:
            result:
              type: object
    workers_schemas-script_name:
      description: Name of the script.
      example: this-is_my_script-01
      pattern: ^[a-z0-9_][a-z0-9-_]*$
      type: string
    workers_schemas-service:
      description: Worker service associated with the zone and hostname.
      example: foo
      type: string
    workers_schemas-version_identifier:
      example: bcf48806-b317-4351-9ee7-36e7d557d4de
      maxLength: 36
      type: string
    workers_script-and-version-settings-item:
      properties:
        bindings:
          $ref: '#/components/schemas/workers_bindings'
        compatibility_date:
          $ref: '#/components/schemas/workers_compatibility_date'
        compatibility_flags:
          $ref: '#/components/schemas/workers_compatibility_flags'
        limits:
          $ref: '#/components/schemas/workers_limits'
        logpush:
          $ref: '#/components/schemas/workers_logpush'
        migrations:
          description: |
            Migrations to apply for Durable Objects associated with this Worker.
          oneOf:
            - $ref: '#/components/schemas/workers_single_step_migrations'
            - $ref: '#/components/schemas/workers_stepped_migrations'
        placement:
          $ref: '#/components/schemas/workers_placement_config'
        tags:
          $ref: '#/components/schemas/workers_tags'
        tail_consumers:
          $ref: '#/components/schemas/workers_tail_consumers'
        usage_model:
          $ref: '#/components/schemas/workers_usage_model'
      type: object
    workers_script-and-version-settings-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/workers_script-and-version-settings-item'
    workers_script-response:
      properties:
        created_on:
          $ref: '#/components/schemas/workers_created_on'
        etag:
          $ref: '#/components/schemas/workers_etag'
        id:
          description: The id of the script in the Workers system. Usually the script name.
          example: my-workers-script
          readOnly: true
          type: string
        logpush:
          $ref: '#/components/schemas/workers_logpush'
        modified_on:
          $ref: '#/components/schemas/workers_modified_on'
        placement_mode:
          $ref: '#/components/schemas/workers_placement_mode'
        tail_consumers:
          $ref: '#/components/schemas/workers_tail_consumers'
        usage_model:
          $ref: '#/components/schemas/workers_usage_model'
    workers_script-response-collection:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/workers_script-response'
              type: array
    workers_script-response-single:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/workers_script-response'
          x-cfLinkErrors:
            "10001": Unsupported or unexpected Content Type
            "10002": Unexpected internal server error
            "10003": Missing required URL parameter
            "10004": Malformed URL parameter
            "10006": Unparseable script body
            "10007": Resource not found (similar to HTTP 404)
            "10014": Internal error while attempting authorization checks
            "10015": The current account is not authorized to use workers
            "10018": Attempted to update a script where the e-tag does not match
            "10021": Script content failed validation checks, but was otherwise parseable
            "10023": Unauthorized access attempt
            "10027": Script body was too large
            "10075": Requires a Workers Paid plan
    workers_script-response-upload:
      allOf:
        - $ref: '#/components/schemas/workers_script-response'
        - properties:
            startup_time_ms:
              example: 10
              type: integer
    workers_script-response-upload-single:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/workers_script-response-upload'
          x-cfLinkErrors:
            "10001": Unsupported or unexpected Content Type
            "10002": Unexpected internal server error
            "10003": Missing required URL parameter
            "10004": Malformed URL parameter
            "10006": Unparseable script body
            "10007": Resource not found (similar to HTTP 404)
            "10014": Internal error while attempting authorization checks
            "10015": The current account is not authorized to use workers
            "10018": Attempted to update a script where the e-tag does not match
            "10021": Script content failed validation checks, but was otherwise parseable
            "10023": Unauthorized access attempt
            "10027": Script body was too large
            "10075": Requires a Workers Paid plan
    workers_script-settings-item:
      properties:
        logpush:
          $ref: '#/components/schemas/workers_logpush'
        tail_consumers:
          $ref: '#/components/schemas/workers_tail_consumers'
      type: object
    workers_script-settings-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/workers_script-settings-item'
    workers_script_count:
      description: The current number of scripts in this Dispatch Namespace
      example: 800
      type: integer
    workers_script_identifier:
      example: 8ee82b3a2c0f42928b8f14dae4a97121
      maxLength: 32
      readOnly: true
      type: string
    workers_script_name:
      description: Name of the script, used in URLs and route configuration.
      example: this-is_my_script-01
      pattern: ^[a-z0-9_][a-z0-9-_]*$
      type: string
    workers_secret:
      properties:
        name:
          description: The name of this secret, this is what will be used to access it inside the Worker.
          example: MY_SECRET
          type: string
        text:
          description: The value of the secret.
          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
          type: string
        type:
          description: The type of secret to put.
          enum:
            - secret_text
          example: secret_text
          type: string
      type: object
    workers_secret-response:
      properties:
        name:
          description: The name of this secret, this is what will be used to access it inside the Worker.
          example: MY_SECRET
          type: string
        type:
          description: The type of secret.
          enum:
            - secret_text
          example: secret_text
          type: string
      type: object
    workers_secret_name:
      description: A JavaScript variable name for the secret binding.
      example: mySecret
      readOnly: true
      type: string
    workers_service:
      description: Name of Worker to bind to
      example: my-worker
      type: string
    workers_service_binding:
      properties:
        environment:
          description: Optional environment if the Worker utilizes one.
          example: production
          type: string
        name:
          $ref: '#/components/schemas/workers_binding_name'
        service:
          description: Name of Worker to bind to
          example: my-worker
          type: string
        type:
          description: The class of resource that the binding provides.
          enum:
            - service
          example: service
          type: string
      required:
        - name
        - type
        - service
        - environment
      type: object
    workers_single_step_migrations:
      allOf:
        - $ref: '#/components/schemas/workers_migration_tag_conditions'
        - $ref: '#/components/schemas/workers_migration_step'
      description: A single set of migrations to apply.
    workers_stepped_migrations:
      allOf:
        - $ref: '#/components/schemas/workers_migration_tag_conditions'
        - properties:
            steps:
              description: Migrations to apply in order.
              items:
                $ref: '#/components/schemas/workers_migration_step'
              type: array
          type: object
    workers_subdomain-object:
      properties:
        subdomain:
          example: example-subdomain
          type: string
      type: object
    workers_subdomain-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/workers_subdomain-object'
    workers_tag:
      description: Tag to help you manage your Worker
      example: my-tag
      type: string
    workers_tags:
      description: Tags to help you manage your Workers
      items:
        $ref: '#/components/schemas/workers_tag'
      type: array
    workers_tail-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              properties:
                expires_at:
                  readOnly: true
                  type: string
                id:
                  readOnly: true
                  type: string
                url:
                  readOnly: true
                  type: string
              type: object
    workers_tail_consumers:
      description: List of Workers that will consume logs from the attached Worker.
      items:
        $ref: '#/components/schemas/workers_tail_consumers_script'
      type: array
    workers_tail_consumers_script:
      description: A reference to a script that will consume logs from the attached Worker.
      properties:
        environment:
          description: Optional environment if the Worker utilizes one.
          example: production
          type: string
        namespace:
          description: Optional dispatch namespace the script belongs to.
          example: my-namespace
          type: string
        service:
          description: Name of Worker that is to be the consumer.
          example: my-log-consumer
          type: string
      required:
        - service
      type: object
    workers_usage-model-object:
      properties:
        usage_model:
          type: string
      type: object
    workers_usage-model-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/workers_usage-model-object'
    workers_usage_model:
      description: Specifies the usage model for the Worker (e.g. 'bundled' or 'unbound').
      example: unbound
      pattern: ^(bundled|unbound)$
      type: string
    workers_uuid:
      description: API Resource UUID tag.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    workers_version-item-full:
      allOf:
        - $ref: '#/components/schemas/workers_version-item-short'
        - properties:
            resources:
              example:
                bindings:
                  - json: example_binding
                    name: JSON_VAR
                    type: json
                script:
                  etag: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794
                  handlers:
                    - fetch
                  last_deployed_from: api
                script_runtime:
                  usage_model: bundled
              readOnly: true
              type: object
          required:
            - resources
          type: object
    workers_version-item-short:
      properties:
        id:
          example: 18f97339-c287-4872-9bdd-e2135c07ec12
          readOnly: true
          type: string
        metadata:
          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
          readOnly: true
          type: object
        number:
          example: 1
          readOnly: true
          type: number
      type: object
    workers_version-item-uploaded:
      allOf:
        - $ref: '#/components/schemas/workers_version-item-full'
        - properties:
            startup_time_ms:
              example: 10
              type: integer
          required:
            - resources
          type: object
    workers_version_identifier:
      example: bcf48806-b317-4351-9ee7-36e7d557d4de
      maxLength: 36
      readOnly: true
      type: string
    workers_versions-list-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/workers_version-item-short'
                  type: array
              type: object
    workers_versions-single-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/workers_version-item-full'
    workers_versions-upload-response:
      allOf:
        - $ref: '#/components/schemas/workers_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/workers_version-item-uploaded'
    workers_wasm_module_binding:
      properties:
        name:
          $ref: '#/components/schemas/workers_binding_name'
        type:
          description: The class of resource that the binding provides.
          enum:
            - wasm_module
          example: wasm_module
          type: string
      required:
        - name
        - type
      type: object
    workers_zone_identifier:
      description: Identifier of the zone.
      example: 593c9c94de529bbbfaac7c53ced0447d
      type: string
    workers_zone_name:
      description: Name of the zone.
      example: example.com
      type: string
    zaraz_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/zaraz_messages'
        messages:
          $ref: '#/components/schemas/zaraz_messages'
        success:
          description: Whether the API call was successful
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    zaraz_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/zaraz_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/zaraz_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    zaraz_base-mc:
      allOf:
        - $ref: '#/components/schemas/zaraz_base-tool'
        - properties:
            actions:
              additionalProperties:
                properties:
                  actionType:
                    description: Tool event type
                    type: string
                  blockingTriggers:
                    description: List of blocking triggers IDs
                    items:
                      type: string
                    type: array
                  data:
                    description: Event payload
                    type: object
                  firingTriggers:
                    description: List of firing triggers IDs
                    items:
                      type: string
                    minItems: 1
                    type: array
                required:
                  - actionType
                  - blockingTriggers
                  - firingTriggers
                  - data
                type: object
              description: Actions configured on a tool. Either this or neoEvents field is required.
              type: object
            component:
              description: Tool's internal name
              type: string
            neoEvents:
              description: DEPRECATED - List of actions configured on a tool. Either this or actions field is required. If both are present, actions field will take precedence.
              items:
                properties:
                  actionType:
                    description: Tool event type
                    type: string
                  blockingTriggers:
                    description: List of blocking triggers IDs
                    items:
                      type: string
                    type: array
                  data:
                    description: Event payload
                    type: object
                  firingTriggers:
                    description: List of firing triggers IDs
                    items:
                      type: string
                    minItems: 1
                    type: array
                required:
                  - actionType
                  - blockingTriggers
                  - firingTriggers
                  - data
                type: object
              type: array
            permissions:
              description: List of permissions granted to the component
              items:
                type: string
              type: array
            settings:
              additionalProperties:
                anyOf:
                  - type: string
                  - type: boolean
              description: Tool's settings
              type: object
          required:
            - component
            - settings
            - permissions
    zaraz_base-tool:
      properties:
        blockingTriggers:
          description: List of blocking trigger IDs
          items:
            type: string
          type: array
        defaultFields:
          additionalProperties:
            anyOf:
              - type: string
              - type: boolean
          description: Default fields for tool's actions
          type: object
        defaultPurpose:
          description: Default consent purpose ID
          type: string
        enabled:
          description: Whether tool is enabled
          type: boolean
        name:
          description: Tool's name defined by the user
          type: string
        vendorName:
          description: Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned
          type: string
        vendorPolicyUrl:
          description: Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned
          type: string
      required:
        - enabled
        - blockingTriggers
        - name
        - defaultFields
      type: object
    zaraz_click-listener-rule:
      properties:
        action:
          enum:
            - clickListener
          type: string
        id:
          type: string
        settings:
          properties:
            selector:
              type: string
            type:
              enum:
                - xpath
                - css
              type: string
            waitForTags:
              minimum: 0
              type: integer
          required:
            - type
            - selector
            - waitForTags
          type: object
      required:
        - id
        - action
        - settings
      type: object
    zaraz_custom-managed-component:
      allOf:
        - $ref: '#/components/schemas/zaraz_base-mc'
        - properties:
            type:
              enum:
                - custom-mc
              type: string
            worker:
              description: Cloudflare worker that acts as a managed component
              properties:
                escapedWorkerName:
                  type: string
                workerTag:
                  type: string
              required:
                - workerTag
                - escapedWorkerName
              type: object
          required:
            - worker
            - type
    zaraz_element-visibility-rule:
      properties:
        action:
          enum:
            - elementVisibility
          type: string
        id:
          type: string
        settings:
          properties:
            selector:
              type: string
          required:
            - selector
          type: object
      required:
        - id
        - action
        - settings
      type: object
    zaraz_form-submission-rule:
      properties:
        action:
          enum:
            - formSubmission
          type: string
        id:
          type: string
        settings:
          properties:
            selector:
              type: string
            validate:
              type: boolean
          required:
            - selector
            - validate
          type: object
      required:
        - id
        - action
        - settings
      type: object
    zaraz_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    zaraz_legacy-tool:
      allOf:
        - $ref: '#/components/schemas/zaraz_base-tool'
        - properties:
            library:
              description: Tool's internal name
              type: string
            neoEvents:
              description: List of actions configured on a tool
              items:
                properties:
                  blockingTriggers:
                    description: List of blocking triggers IDs
                    items:
                      type: string
                    type: array
                  data:
                    description: Event payload
                    type: object
                  firingTriggers:
                    description: List of firing triggers IDs
                    items:
                      type: string
                    minItems: 1
                    type: array
                required:
                  - blockingTriggers
                  - firingTriggers
                  - data
                type: object
              type: array
            type:
              enum:
                - library
              type: string
          required:
            - library
            - neoEvents
            - type
    zaraz_load-rule:
      properties:
        id:
          type: string
        match:
          type: string
        op:
          enum:
            - CONTAINS
            - EQUALS
            - STARTS_WITH
            - ENDS_WITH
            - MATCH_REGEX
            - NOT_MATCH_REGEX
            - GREATER_THAN
            - GREATER_THAN_OR_EQUAL
            - LESS_THAN
            - LESS_THAN_OR_EQUAL
          type: string
        value:
          type: string
      required:
        - id
        - match
        - op
        - value
      type: object
    zaraz_managed-component:
      allOf:
        - $ref: '#/components/schemas/zaraz_base-mc'
        - properties:
            type:
              enum:
                - component
              type: string
          required:
            - type
    zaraz_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    zaraz_scroll-depth-rule:
      properties:
        action:
          enum:
            - scrollDepth
          type: string
        id:
          type: string
        settings:
          properties:
            positions:
              type: string
          required:
            - positions
          type: object
      required:
        - id
        - action
        - settings
      type: object
    zaraz_timer-rule:
      properties:
        action:
          enum:
            - timer
          type: string
        id:
          type: string
        settings:
          properties:
            interval:
              minimum: 50
              type: integer
            limit:
              minimum: 0
              type: integer
          required:
            - interval
            - limit
          type: object
      required:
        - id
        - action
        - settings
      type: object
    zaraz_variable-match-rule:
      properties:
        action:
          enum:
            - variableMatch
          type: string
        id:
          type: string
        settings:
          properties:
            match:
              type: string
            variable:
              type: string
          required:
            - variable
            - match
          type: object
      required:
        - id
        - action
        - settings
      type: object
    zaraz_zaraz-config-base:
      description: Zaraz configuration
      example:
        consent:
          cookieName: zaraz-consent
          customIntroDisclaimerDismissed: true
          enabled: false
        dataLayer: true
        debugKey: my-debug-key
        settings:
          autoInjectScript: true
          ecommerce: true
          initPath: /i
        tools:
          aJvt:
            actions:
              hrnc:
                actionType: pageview
                blockingTriggers: []
                data:
                  __zaraz_setting_name: Page view
                  ev: PageView
                firingTriggers:
                  - Pageview
            component: facebook-pixel
            defaultFields:
              testKey: TEST123456
            enabled: true
            name: Facebook Pixel
            permissions:
              - access_client_kv
            settings:
              accessToken: ABcdEFg
              ecommerce: true
              property: "12345"
            type: component
        triggers:
          ktBn:
            Pageview:
              clientRules: []
              description: All page loads
              excludeRules: []
              loadRules:
                - match: '{{ client.__zarazTrack }}'
                  op: EQUALS
                  value: Pageview
              name: Pageview
              system: pageload
        variables:
          Autd:
            name: ip
            type: string
            value: '{{ system.device.ip }}'
        zarazVersion: 43
      properties:
        consent:
          description: Consent management configuration.
          properties:
            buttonTextTranslations:
              properties:
                accept_all:
                  additionalProperties:
                    type: string
                  description: Object where keys are language codes
                  type: object
                confirm_my_choices:
                  additionalProperties:
                    type: string
                  description: Object where keys are language codes
                  type: object
                reject_all:
                  additionalProperties:
                    type: string
                  description: Object where keys are language codes
                  type: object
              required:
                - accept_all
                - reject_all
                - confirm_my_choices
              type: object
            companyEmail:
              type: string
            companyName:
              type: string
            companyStreetAddress:
              type: string
            consentModalIntroHTML:
              type: string
            consentModalIntroHTMLWithTranslations:
              additionalProperties:
                type: string
              description: Object where keys are language codes
              type: object
            cookieName:
              type: string
            customCSS:
              type: string
            customIntroDisclaimerDismissed:
              type: boolean
            defaultLanguage:
              type: string
            enabled:
              type: boolean
            hideModal:
              type: boolean
            purposes:
              additionalProperties:
                properties:
                  description:
                    type: string
                  name:
                    type: string
                required:
                  - name
                  - description
                type: object
              description: Object where keys are purpose alpha-numeric IDs
              type: object
            purposesWithTranslations:
              additionalProperties:
                properties:
                  description:
                    additionalProperties:
                      type: string
                    description: Object where keys are language codes
                    type: object
                  name:
                    additionalProperties:
                      type: string
                    description: Object where keys are language codes
                    type: object
                  order:
                    type: integer
                required:
                  - name
                  - description
                  - order
                type: object
              description: Object where keys are purpose alpha-numeric IDs
              type: object
            tcfCompliant:
              type: boolean
          required:
            - enabled
          type: object
        dataLayer:
          description: Data layer compatibility mode enabled.
          type: boolean
        debugKey:
          description: The key for Zaraz debug mode.
          type: string
        historyChange:
          description: Single Page Application support enabled.
          type: boolean
        settings:
          description: General Zaraz settings.
          properties:
            autoInjectScript:
              description: Automatic injection of Zaraz scripts enabled.
              type: boolean
            contextEnricher:
              description: Details of the worker that receives and edits Zaraz Context object.
              properties:
                escapedWorkerName:
                  type: string
                workerTag:
                  type: string
              required:
                - escapedWorkerName
                - workerTag
              type: object
            cookieDomain:
              description: The domain Zaraz will use for writing and reading its cookies.
              type: string
            ecommerce:
              description: Ecommerce API enabled.
              type: boolean
            eventsApiPath:
              description: Custom endpoint for server-side track events.
              type: string
            hideExternalReferer:
              description: Hiding external referrer URL enabled.
              type: boolean
            hideIPAddress:
              description: Trimming IP address enabled.
              type: boolean
            hideQueryParams:
              description: Removing URL query params enabled.
              type: boolean
            hideUserAgent:
              description: Removing sensitive data from User Aagent string enabled.
              type: boolean
            initPath:
              description: Custom endpoint for Zaraz init script.
              type: string
            injectIframes:
              description: Injection of Zaraz scripts into iframes enabled.
              type: boolean
            mcRootPath:
              description: Custom path for Managed Components server functionalities.
              type: string
            scriptPath:
              description: Custom endpoint for Zaraz main script.
              type: string
            trackPath:
              description: Custom endpoint for Zaraz tracking requests.
              type: string
          required:
            - autoInjectScript
          type: object
        triggers:
          additionalProperties:
            properties:
              description:
                description: Trigger description.
                type: string
              excludeRules:
                description: Rules defining when the trigger is not fired.
                items:
                  anyOf:
                    - $ref: '#/components/schemas/zaraz_load-rule'
                    - $ref: '#/components/schemas/zaraz_click-listener-rule'
                    - $ref: '#/components/schemas/zaraz_timer-rule'
                    - $ref: '#/components/schemas/zaraz_form-submission-rule'
                    - $ref: '#/components/schemas/zaraz_variable-match-rule'
                    - $ref: '#/components/schemas/zaraz_scroll-depth-rule'
                    - $ref: '#/components/schemas/zaraz_element-visibility-rule'
                type: array
              loadRules:
                description: Rules defining when the trigger is fired.
                items:
                  anyOf:
                    - $ref: '#/components/schemas/zaraz_load-rule'
                    - $ref: '#/components/schemas/zaraz_click-listener-rule'
                    - $ref: '#/components/schemas/zaraz_timer-rule'
                    - $ref: '#/components/schemas/zaraz_form-submission-rule'
                    - $ref: '#/components/schemas/zaraz_variable-match-rule'
                    - $ref: '#/components/schemas/zaraz_scroll-depth-rule'
                    - $ref: '#/components/schemas/zaraz_element-visibility-rule'
                type: array
              name:
                description: Trigger name.
                type: string
              system:
                enum:
                  - pageload
                type: string
            required:
              - name
              - loadRules
              - excludeRules
            type: object
          description: Triggers set up under Zaraz configuration, where key is the trigger alpha-numeric ID and value is the trigger configuration.
          type: object
        variables:
          additionalProperties:
            anyOf:
              - properties:
                  name:
                    type: string
                  type:
                    enum:
                      - string
                      - secret
                    type: string
                  value:
                    type: string
                required:
                  - name
                  - type
                  - value
                type: object
              - properties:
                  name:
                    type: string
                  type:
                    enum:
                      - worker
                    type: string
                  value:
                    properties:
                      escapedWorkerName:
                        type: string
                      workerTag:
                        type: string
                    required:
                      - escapedWorkerName
                      - workerTag
                    type: object
                required:
                  - name
                  - type
                  - value
                type: object
          description: Variables set up under Zaraz configuration, where key is the variable alpha-numeric ID and value is the variable configuration. Values of variables of type secret are not included.
          type: object
        zarazVersion:
          description: Zaraz internal version of the config.
          type: integer
      required:
        - tools
        - triggers
        - variables
        - settings
        - dataLayer
        - debugKey
        - zarazVersion
      type: object
    zaraz_zaraz-config-body:
      allOf:
        - $ref: '#/components/schemas/zaraz_zaraz-config-base'
        - properties:
            tools:
              additionalProperties:
                anyOf:
                  - $ref: '#/components/schemas/zaraz_legacy-tool'
                  - $ref: '#/components/schemas/zaraz_managed-component'
                  - $ref: '#/components/schemas/zaraz_custom-managed-component'
              description: Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID and value is the tool configuration object.
              type: object
    zaraz_zaraz-config-history-response:
      allOf:
        - $ref: '#/components/schemas/zaraz_api-response-common'
        - properties:
            result:
              additionalProperties:
                allOf:
                  - $ref: '#/components/schemas/zaraz_zaraz-config-row-base'
                  - description: Configuration record correspoding to an ID provided in query params
                    nullable: true
                    properties:
                      config:
                        $ref: '#/components/schemas/zaraz_zaraz-config-return'
                    required:
                      - config
                    type: object
              description: Object where keys are numericc onfiguration IDs
              example:
                "12345":
                  config:
                    consent:
                      cookieName: zaraz-consent
                      customIntroDisclaimerDismissed: true
                      enabled: false
                    dataLayer: true
                    debugKey: my-debug-key
                    settings:
                      autoInjectScript: true
                    tools:
                      aJvt:
                        component: facebook-pixel
                        defaultFields:
                          testKey: TEST123456
                        enabled: true
                        name: Facebook Pixel
                        neoEvents:
                          - actionType: pageview
                            blockingTriggers: []
                            data:
                              __zaraz_setting_name: Page view
                              ev: PageView
                            firingTriggers:
                              - Pageview
                        permissions:
                          - access_client_kv
                        settings:
                          accessToken: ABcdEFg
                          ecommerce: true
                          property: "12345"
                        type: component
                    triggers:
                      ktBn:
                        Pageview:
                          clientRules: []
                          description: All page loads
                          excludeRules: []
                          loadRules:
                            - match: '{{ client.__zarazTrack }}'
                              op: EQUALS
                              value: Pageview
                          name: Pageview
                          system: pageload
                    variables:
                      Autd:
                        name: ip
                        type: string
                        value: '{{ system.device.ip }}'
                    zarazVersion: 43
                  createdAt: "2023-02-23T05:05:55.155273Z"
                  id: 12345
                  updatedAt: "2023-02-23T05:05:55.155273Z"
                  userId: 278d0d0g123cd8e49d45ea64f12faa37
                "23456":
              type: object
    zaraz_zaraz-config-response:
      allOf:
        - $ref: '#/components/schemas/zaraz_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/zaraz_zaraz-config-return'
    zaraz_zaraz-config-return:
      allOf:
        - $ref: '#/components/schemas/zaraz_zaraz-config-base'
        - properties:
            tools:
              additionalProperties:
                anyOf:
                  - $ref: '#/components/schemas/zaraz_managed-component'
                  - $ref: '#/components/schemas/zaraz_custom-managed-component'
              description: Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID and value is the tool configuration object.
              type: object
    zaraz_zaraz-config-row-base:
      properties:
        createdAt:
          description: Date and time the configuration was created
          format: date-time
          type: string
        id:
          description: ID of the configuration
          type: integer
        updatedAt:
          description: Date and time the configuration was last updated
          format: date-time
          type: string
        userId:
          description: Alpha-numeric ID of the account user who published the configuration
          type: string
      required:
        - id
        - createdAt
        - updatedAt
        - userId
    zaraz_zaraz-history-response:
      allOf:
        - $ref: '#/components/schemas/zaraz_api-response-common'
        - properties:
            result:
              items:
                allOf:
                  - $ref: '#/components/schemas/zaraz_zaraz-config-row-base'
                  - example:
                      createdAt: "2023-02-23T05:05:55.155273Z"
                      description: Config with enabled ecommerce tracking
                      id: 12345
                      updatedAt: "2023-02-23T05:05:55.155273Z"
                      userId: 278d0d0g123cd8e49d45ea64f12faa37
                    properties:
                      description:
                        description: Configuration description provided by the user who published this configuration
                        type: string
                    required:
                      - description
                    type: object
              type: array
    zaraz_zaraz-workflow:
      description: Zaraz workflow
      enum:
        - realtime
        - preview
      type: string
    zaraz_zaraz-workflow-response:
      allOf:
        - $ref: '#/components/schemas/zaraz_api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/zaraz_zaraz-workflow'
    zaraz_zone-identifier:
      $ref: '#/components/schemas/zaraz_identifier'
    zero-trust-gateway_action:
      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
        - egress
        - audit_ssh
        - resolve
      example: allow
      type: string
    zero-trust-gateway_activity-log-settings:
      description: Activity log settings.
      properties:
        enabled:
          description: Enable activity logging.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_anti-virus-settings:
      description: Anti-virus settings.
      properties:
        enabled_download_phase:
          $ref: '#/components/schemas/zero-trust-gateway_enabled_download_phase'
        enabled_upload_phase:
          $ref: '#/components/schemas/zero-trust-gateway_enabled_upload_phase'
        fail_closed:
          $ref: '#/components/schemas/zero-trust-gateway_fail_closed'
        notification_settings:
          $ref: '#/components/schemas/zero-trust-gateway_notification_settings'
      type: object
    zero-trust-gateway_api-response-collection:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-common'
        - properties:
            result_info:
              $ref: '#/components/schemas/zero-trust-gateway_result_info'
      type: object
    zero-trust-gateway_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/zero-trust-gateway_messages'
        messages:
          $ref: '#/components/schemas/zero-trust-gateway_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    zero-trust-gateway_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/zero-trust-gateway_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/zero-trust-gateway_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    zero-trust-gateway_api-response-single:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-common'
      type: object
    zero-trust-gateway_app-types:
      oneOf:
        - $ref: '#/components/schemas/zero-trust-gateway_application'
        - $ref: '#/components/schemas/zero-trust-gateway_application_type'
      readOnly: true
      type: object
    zero-trust-gateway_app-types_components-schemas-name:
      description: The name of the application or application type.
      example: Facebook
      type: string
    zero-trust-gateway_app-types_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/zero-trust-gateway_app-types'
              type: array
    zero-trust-gateway_app_id:
      description: The identifier for this application. There is only one application per ID.
      type: integer
    zero-trust-gateway_app_type_id:
      description: The identifier for the type of this application. There can be many applications with the same type. This refers to the `id` of a returned application type.
      type: integer
    zero-trust-gateway_application:
      properties:
        application_type_id:
          $ref: '#/components/schemas/zero-trust-gateway_app_type_id'
        created_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        id:
          $ref: '#/components/schemas/zero-trust-gateway_app_id'
        name:
          $ref: '#/components/schemas/zero-trust-gateway_app-types_components-schemas-name'
      type: object
    zero-trust-gateway_application_type:
      properties:
        created_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        description:
          description: A short summary of applications with this type.
          example: Applications used to communicate or collaborate in a business setting.
          type: string
        id:
          $ref: '#/components/schemas/zero-trust-gateway_app_type_id'
        name:
          $ref: '#/components/schemas/zero-trust-gateway_app-types_components-schemas-name'
      type: object
    zero-trust-gateway_audit_ssh_settings_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/zero-trust-gateway_settings'
    zero-trust-gateway_audit_ssh_settings_components-schemas-uuid:
      description: Seed ID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    zero-trust-gateway_beta:
      description: True if the category is in beta and subject to change.
      example: false
      type: boolean
    zero-trust-gateway_binding_status:
      description: The deployment status of the certificate on Cloudflare's edge. Certificates in the 'active' state may be used for Gateway TLS interception.
      enum:
        - pending_deployment
        - active
        - pending_deletion
        - inactive
      type: string
    zero-trust-gateway_block-page-settings:
      description: Block page layout settings.
      properties:
        background_color:
          description: 'Block page background color in #rrggbb format.'
          type: string
        enabled:
          description: Enable only cipher suites and TLS versions compliant with FIPS 140-2.
          example: true
          type: boolean
        footer_text:
          description: Block page footer text.
          example: --footer--
          type: string
        header_text:
          description: Block page header text.
          example: --header--
          type: string
        logo_path:
          description: Full URL to the logo file.
          example: https://logos.com/a.png
          type: string
        mailto_address:
          description: Admin email for users to contact.
          example: admin@example.com
          type: string
        mailto_subject:
          description: Subject line for emails created from block page.
          example: Blocked User Inquiry
          type: string
        name:
          description: Block page title.
          example: Cloudflare
          type: string
        suppress_footer:
          description: Suppress detailed info at the bottom of the block page.
          example: false
          type: boolean
      type: object
    zero-trust-gateway_body-scanning-settings:
      description: DLP body scanning settings.
      properties:
        inspection_mode:
          description: Set the inspection mode to either `deep` or `shallow`.
          example: deep
          type: string
      type: object
    zero-trust-gateway_browser-isolation-settings:
      description: Browser isolation settings.
      properties:
        non_identity_enabled:
          description: Enable non-identity onramp support for Browser Isolation.
          example: true
          type: boolean
        url_browser_isolation_enabled:
          description: Enable Clientless Browser Isolation.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_categories:
      properties:
        beta:
          $ref: '#/components/schemas/zero-trust-gateway_beta'
        class:
          $ref: '#/components/schemas/zero-trust-gateway_class'
        description:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-description'
        id:
          $ref: '#/components/schemas/zero-trust-gateway_id'
        name:
          $ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-name'
        subcategories:
          description: All subcategories for this category.
          items:
            $ref: '#/components/schemas/zero-trust-gateway_subcategory'
          type: array
      readOnly: true
      type: object
    zero-trust-gateway_categories_components-schemas-name:
      description: The name of the category.
      example: Education
      type: string
    zero-trust-gateway_categories_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/zero-trust-gateway_categories'
              type: array
    zero-trust-gateway_certificate-settings:
      description: Certificate settings for Gateway TLS interception. If not specified, the Cloudflare Root CA will be used.
      properties:
        id:
          description: UUID of certificate to be used for interception. Certificate must be active on the edge. A nil UUID will indicate the Cloudflare Root CA should be used.
          example: d1b364c5-1311-466e-a194-f0e943e0799f
          type: string
      required:
        - id
      type: object
    zero-trust-gateway_certificates:
      properties:
        binding_status:
          $ref: '#/components/schemas/zero-trust-gateway_binding_status'
        certificate:
          description: The CA certificate
          example: '-----BEGIN CERTIFICATE-----\nMIIDmDCCAoCgAwIBAgIUKTOAZNjcXVZRj4oQt0SHsl1c1vMwDQYJKoZIhvcNAQELBQAwUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjAgFw0yMjExMjIxNjU5NDdaGA8yMTIyMTAyOTE2NTk0N1owUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMRcORwgJFTdcG/2GKI+cFYiOBNDKjCZUXEOvXWY42BkH9wxiMT869CO+enA1w5pIrXow6kCM1sQspHHaVmJUlotEMJxyoLFfA/8Kt1EKFyobOjuZs2SwyVyJ2sStvQuUQEosULZCNGZEqoH5g6zhMPxaxm7ZLrrsDZ9maNGVqo7EWLWHrZ57Q/5MtTrbxQL+eXjUmJ9K3kS+3uEwMdqR6Z3BluU1ivanpPc1CN2GNhdO0/hSY4YkGEnuLsqJyDd3cIiB1MxuCBJ4ZaqOd2viV1WcP3oU3dxVPm4MWyfYIldMWB14FahScxLhWdRnM9YZ/i9IFcLypXsuz7DjrJPtPUCAwEAAaNmMGQwHQYDVR0OBBYEFP5JzLUawNF+c3AXsYTEWHh7z2czMB8GA1UdIwQYMBaAFP5JzLUawNF+c3AXsYTEWHh7z2czMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMA0GCSqGSIb3DQEBCwUAA4IBAQBc+Be7NDhpE09y7hLPZGRPl1cSKBw4RI0XIv6rlbSTFs5EebpTGjhx/whNxwEZhB9HZ7111Oa1YlT8xkI9DshB78mjAHCKBAJ76moK8tkG0aqdYpJ4ZcJTVBB7l98Rvgc7zfTii7WemTy72deBbSeiEtXavm4EF0mWjHhQ5Nxpnp00Bqn5g1x8CyTDypgmugnep+xG+iFzNmTdsz7WI9T/7kDMXqB7M/FPWBORyS98OJqNDswCLF8bIZYwUBEe+bRHFomoShMzaC3tvim7WCb16noDkSTMlfKO4pnvKhpcVdSgwcruATV7y+W+Lvmz2OT/Gui4JhqeoTewsxndhDDE\n-----END CERTIFICATE-----\n'
          type: string
        created_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        expires_on:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        fingerprint:
          description: The SHA256 fingerprint of the certificate.
          example: E9:19:49:AA:DD:D8:1E:C1:20:2A:D8:22:BF:A5:F8:FC:1A:F7:10:9F:C7:5B:69:AB:0:31:91:8B:61:B4:BF:1C
          type: string
        id:
          $ref: '#/components/schemas/zero-trust-gateway_uuid'
        in_use:
          description: Use this certificate for Gateway TLS interception
          type: boolean
        issuer_org:
          description: The organization that issued the certificate.
          example: Example Inc.
          type: string
        issuer_raw:
          description: The entire issuer field of the certificate.
          example: O=Example Inc.,L=California,ST=San Francisco,C=US
          type: string
        type:
          $ref: '#/components/schemas/zero-trust-gateway_type'
        updated_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        uploaded_on:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
      type: object
    zero-trust-gateway_cf_account_id:
      description: Cloudflare account ID.
      example: 699d98642c564d2e855e9661899b7252
      maxLength: 32
      type: string
    zero-trust-gateway_class:
      description: Which account types are allowed to create policies based on this category. `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
      type: string
    zero-trust-gateway_client-default:
      description: True if the location is the default location.
      example: false
      type: boolean
    zero-trust-gateway_components-schemas-description:
      description: A short summary of domains in the category.
      example: Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.
      type: string
    zero-trust-gateway_components-schemas-name:
      description: The name of the rule.
      example: block bad websites
      type: string
    zero-trust-gateway_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/zero-trust-gateway_locations'
              type: array
    zero-trust-gateway_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/zero-trust-gateway_locations'
    zero-trust-gateway_components-schemas-uuid:
      example: ed35569b41ce4d1facfe683550f54086
      type: string
    zero-trust-gateway_count:
      description: The number of items in the list.
      example: 20
      readOnly: true
      type: number
    zero-trust-gateway_custom-certificate-settings:
      deprecated: true
      description: Custom certificate settings for BYO-PKI. (deprecated and replaced by `certificate`)
      properties:
        binding_status:
          description: Certificate status (internal).
          example: pending_deployment
          readOnly: true
          type: string
        enabled:
          description: Enable use of custom certificate authority for signing Gateway traffic.
          example: true
          type: boolean
        id:
          description: UUID of certificate (ID from MTLS certificate store).
          example: d1b364c5-1311-466e-a194-f0e943e0799f
          type: string
        updated_at:
          format: date-time
          readOnly: true
          type: string
      required:
        - enabled
      type: object
    zero-trust-gateway_deleted_at:
      description: Date of deletion, if any.
      format: date-time
      nullable: true
      readOnly: true
      type: string
    zero-trust-gateway_description:
      description: The description of the list.
      example: The serial numbers for administrators
      type: string
    zero-trust-gateway_description_item:
      description: The description of the list item, if present
      example: Austin office IP
      minimum: 0
      type: string
    zero-trust-gateway_device_posture:
      description: The wirefilter expression used for device posture check matching.
      example: any(device_posture.checks.passed[*] in {"1308749e-fcfb-4ebc-b051-fe022b632644"})
      type: string
    zero-trust-gateway_dns-destination-ips-id-read:
      description: The identifier of the pair of IPv4 addresses assigned to this location.
      example: 0e4a32c6-6fb8-4858-9296-98f51631e8e6
      type: string
    zero-trust-gateway_dns-destination-ips-id-write:
      description: The identifier of the pair of IPv4 addresses assigned to this location. When creating a location, if this field is absent or set with null, the pair of shared IPv4 addresses (0e4a32c6-6fb8-4858-9296-98f51631e8e6) is auto-assigned. When updating a location, if the field is absent or set with null, the pre-assigned pair remains unchanged.
      example: 0e4a32c6-6fb8-4858-9296-98f51631e8e6
      type: string
    zero-trust-gateway_dns_resolver_settings_v4:
      properties:
        ip:
          description: IPv4 address of upstream resolver.
          example: 2.2.2.2
          type: string
        port:
          description: A port number to use for upstream resolver. Defaults to 53 if unspecified.
          example: 5053
          type: integer
        route_through_private_network:
          description: Whether to connect to this resolver over a private network. Must be set when vnet_id is set.
          example: true
          type: boolean
        vnet_id:
          description: Optionally specify a virtual network for this resolver. Uses default virtual network id if omitted.
          example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
          type: string
      required:
        - ip
      type: object
    zero-trust-gateway_dns_resolver_settings_v6:
      properties:
        ip:
          description: IPv6 address of upstream resolver.
          example: '2001:DB8::'
          type: string
        port:
          description: A port number to use for upstream resolver. Defaults to 53 if unspecified.
          example: 5053
          type: integer
        route_through_private_network:
          description: Whether to connect to this resolver over a private network. Must be set when vnet_id is set.
          example: true
          type: boolean
        vnet_id:
          description: Optionally specify a virtual network for this resolver. Uses default virtual network id if omitted.
          example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
          type: string
      required:
        - ip
      type: object
    zero-trust-gateway_doh_endpoint:
      properties:
        enabled:
          description: True if the endpoint is enabled for this location.
          example: true
          type: boolean
        networks:
          $ref: '#/components/schemas/zero-trust-gateway_ip_networks'
        require_token:
          description: True if the endpoint requires [user identity](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/agentless/dns/dns-over-https/#filter-doh-requests-by-user) authentication.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_dot_endpoint:
      properties:
        enabled:
          description: True if the endpoint is enabled for this location.
          example: true
          type: boolean
        networks:
          $ref: '#/components/schemas/zero-trust-gateway_ip_networks'
      type: object
    zero-trust-gateway_ecs-support:
      description: True if the location needs to resolve EDNS queries.
      example: false
      type: boolean
    zero-trust-gateway_empty_response:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
        - properties:
            result:
              type: object
    zero-trust-gateway_enabled:
      description: True if the rule is enabled.
      example: true
      type: boolean
    zero-trust-gateway_enabled_download_phase:
      description: Enable anti-virus scanning on downloads.
      example: false
      type: boolean
    zero-trust-gateway_enabled_upload_phase:
      description: Enable anti-virus scanning on uploads.
      example: false
      type: boolean
    zero-trust-gateway_endpoints:
      description: The destination endpoints configured for this location. When updating a location, if this field is absent or set with null, the endpoints configuration remains unchanged.
      properties:
        doh:
          $ref: '#/components/schemas/zero-trust-gateway_doh_endpoint'
        dot:
          $ref: '#/components/schemas/zero-trust-gateway_dot_endpoint'
        ipv4:
          $ref: '#/components/schemas/zero-trust-gateway_ipv4_endpoint'
        ipv6:
          $ref: '#/components/schemas/zero-trust-gateway_ipv6_endpoint'
      type: object
    zero-trust-gateway_extended-email-matching:
      description: Extended e-mail matching settings.
      properties:
        enabled:
          description: Enable matching all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_fail_closed:
      description: Block requests for files that cannot be scanned.
      example: false
      type: boolean
    zero-trust-gateway_filters:
      description: The protocol or layer to evaluate the traffic, identity, and device posture expressions.
      example:
        - http
      items:
        description: The protocol or layer to use.
        enum:
          - http
          - dns
          - l4
          - egress
        example: http
        type: string
      type: array
    zero-trust-gateway_fips-settings:
      description: FIPS settings.
      properties:
        tls:
          description: Enable only cipher suites and TLS versions compliant with FIPS 140-2.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_gateway-account-logging-settings:
      properties:
        redact_pii:
          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
          type: boolean
        settings_by_rule_type:
          description: Logging settings by rule type.
          properties:
            dns:
              description: Logging settings for DNS firewall.
              type: object
            http:
              description: Logging settings for HTTP/HTTPS firewall.
              type: object
            l4:
              description: Logging settings for Network firewall.
              type: object
          type: object
      type: object
    zero-trust-gateway_gateway-account-logging-settings-response:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings'
      type: object
    zero-trust-gateway_gateway-account-settings:
      description: account settings.
      properties:
        settings:
          description: account settings.
          properties:
            activity_log:
              $ref: '#/components/schemas/zero-trust-gateway_activity-log-settings'
            antivirus:
              $ref: '#/components/schemas/zero-trust-gateway_anti-virus-settings'
            block_page:
              $ref: '#/components/schemas/zero-trust-gateway_block-page-settings'
            body_scanning:
              $ref: '#/components/schemas/zero-trust-gateway_body-scanning-settings'
            browser_isolation:
              $ref: '#/components/schemas/zero-trust-gateway_browser-isolation-settings'
            certificate:
              $ref: '#/components/schemas/zero-trust-gateway_certificate-settings'
            custom_certificate:
              $ref: '#/components/schemas/zero-trust-gateway_custom-certificate-settings'
            extended_email_matching:
              $ref: '#/components/schemas/zero-trust-gateway_extended-email-matching'
            fips:
              $ref: '#/components/schemas/zero-trust-gateway_fips-settings'
            protocol_detection:
              $ref: '#/components/schemas/zero-trust-gateway_protocol-detection'
            tls_decrypt:
              $ref: '#/components/schemas/zero-trust-gateway_tls-settings'
          type: object
      type: object
    zero-trust-gateway_gateway_account:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
        - properties:
            result:
              properties:
                gateway_tag:
                  $ref: '#/components/schemas/zero-trust-gateway_gateway_tag'
                id:
                  $ref: '#/components/schemas/zero-trust-gateway_cf_account_id'
                provider_name:
                  $ref: '#/components/schemas/zero-trust-gateway_provider_name'
              type: object
      type: object
    zero-trust-gateway_gateway_account_config:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
        - properties:
            result:
              allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_gateway-account-settings'
                - properties:
                    created_at:
                      $ref: '#/components/schemas/zero-trust-gateway_timestamp'
                    updated_at:
                      $ref: '#/components/schemas/zero-trust-gateway_timestamp'
              type: object
      type: object
    zero-trust-gateway_gateway_tag:
      description: Gateway internal ID.
      example: f174e90afafe4643bbbc4a0ed4fc8415
      maxLength: 32
      type: string
    zero-trust-gateway_generate-cert-request:
      properties:
        validity_period_days:
          description: Number of days the generated certificate will be valid, minimum 1 day and maximum 30 years. Defaults to 5 years.
          example: 1826
          type: integer
      type: object
    zero-trust-gateway_id:
      description: The identifier for this category. There is only one category per ID.
      type: integer
    zero-trust-gateway_identifier:
      example: 699d98642c564d2e855e9661899b7252
      type: string
    zero-trust-gateway_identity:
      description: The wirefilter expression used for identity matching.
      example: any(identity.groups.name[*] in {"finance"})
      type: string
    zero-trust-gateway_ip:
      description: IPV6 destination ip assigned to this location. DNS requests sent to this IP will counted as the request under this location. This field is auto-generated by Gateway.
      example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
      type: string
    zero-trust-gateway_ip_network:
      properties:
        network:
          description: The IP address or IP CIDR.
          example: 2001:85a3::/64
          type: string
      required:
        - network
      type: object
    zero-trust-gateway_ip_networks:
      description: A list of allowed source IP network ranges for this endpoint. When empty, all source IPs are allowed. A non-empty list is only effective if the endpoint is enabled for this location.
      items:
        $ref: '#/components/schemas/zero-trust-gateway_ip_network'
      type: array
    zero-trust-gateway_ips:
      description: A list of CIDRs to restrict ingress connections.
      items:
        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
        type: string
      type: array
    zero-trust-gateway_ipv4_endpoint:
      properties:
        enabled:
          description: True if the endpoint is enabled for this location.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_ipv4_network:
      properties:
        network:
          description: The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24.
          example: 192.0.2.1/32
          type: string
      required:
        - network
      type: object
    zero-trust-gateway_ipv4_networks:
      description: A list of network ranges that requests from this location would originate from. A non-empty list is only effective if the ipv4 endpoint is enabled for this location.
      items:
        $ref: '#/components/schemas/zero-trust-gateway_ipv4_network'
      type: array
    zero-trust-gateway_ipv6_endpoint:
      properties:
        enabled:
          description: True if the endpoint is enabled for this location.
          example: true
          type: boolean
        networks:
          $ref: '#/components/schemas/zero-trust-gateway_ipv6_networks'
      type: object
    zero-trust-gateway_ipv6_network:
      properties:
        network:
          description: The IPv6 address or IPv6 CIDR.
          example: 2001:85a3::/64
          type: string
      required:
        - network
      type: object
    zero-trust-gateway_ipv6_networks:
      description: A list of allowed source IPv6 network ranges for this endpoint. When empty, all source IPs are allowed. A non-empty list is only effective if the endpoint is enabled for this location.
      items:
        $ref: '#/components/schemas/zero-trust-gateway_ipv6_network'
      type: array
    zero-trust-gateway_items:
      description: The items in the list.
      items:
        properties:
          created_at:
            $ref: '#/components/schemas/zero-trust-gateway_timestamp'
          description:
            $ref: '#/components/schemas/zero-trust-gateway_description_item'
          value:
            $ref: '#/components/schemas/zero-trust-gateway_value'
        type: object
      type: array
    zero-trust-gateway_list_item_response_collection:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/zero-trust-gateway_items'
              type: array
        - properties:
            result_info:
              properties:
                count:
                  description: Total results returned based on your search parameters.
                  example: 1
                  type: number
                page:
                  description: Current page within paginated list of results.
                  example: 1
                  type: number
                per_page:
                  description: Number of results per page of results.
                  example: 20
                  type: number
                total_count:
                  description: Total results available without any search parameters.
                  example: 2000
                  type: number
              type: object
    zero-trust-gateway_lists:
      properties:
        count:
          $ref: '#/components/schemas/zero-trust-gateway_count'
        created_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        description:
          $ref: '#/components/schemas/zero-trust-gateway_description'
        id:
          $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
        name:
          $ref: '#/components/schemas/zero-trust-gateway_name'
        type:
          $ref: '#/components/schemas/zero-trust-gateway_schemas-type'
        updated_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
      type: object
    zero-trust-gateway_locations:
      properties:
        client_default:
          $ref: '#/components/schemas/zero-trust-gateway_client-default'
        created_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        dns_destination_ips_id:
          $ref: '#/components/schemas/zero-trust-gateway_dns-destination-ips-id-read'
        doh_subdomain:
          $ref: '#/components/schemas/zero-trust-gateway_subdomain'
        ecs_support:
          $ref: '#/components/schemas/zero-trust-gateway_ecs-support'
        endpoints:
          $ref: '#/components/schemas/zero-trust-gateway_endpoints'
        id:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
        ip:
          $ref: '#/components/schemas/zero-trust-gateway_ip'
        ipv4_destination:
          description: The primary destination IPv4 address from the pair identified by the dns_destination_ips_id. This field is read-only.
          example: 172.64.36.1
          type: string
        ipv4_destination_backup:
          description: The backup destination IPv4 address from the pair identified by the dns_destination_ips_id. This field is read-only.
          example: 172.64.36.2
          type: string
        name:
          $ref: '#/components/schemas/zero-trust-gateway_schemas-name'
        networks:
          $ref: '#/components/schemas/zero-trust-gateway_ipv4_networks'
        updated_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
      type: object
    zero-trust-gateway_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    zero-trust-gateway_name:
      description: The name of the list.
      example: Admin Serial Numbers
      type: string
    zero-trust-gateway_notification_settings:
      description: Configure a message to display on the user's device when an antivirus search is performed.
      properties:
        enabled:
          description: Set notification on
          type: boolean
        msg:
          description: Customize the message shown in the notification.
          type: string
        support_url:
          description: Optional URL to direct users to additional information. If not set, the notification will open a block page.
          type: string
      type: object
    zero-trust-gateway_precedence:
      description: Precedence sets the order of your rules. Lower values indicate higher precedence. At each processing phase, applicable rules are evaluated in ascending order of this value.
      type: integer
    zero-trust-gateway_protocol-detection:
      description: Protocol Detection settings.
      properties:
        enabled:
          description: Enable detecting protocol on initial bytes of client traffic.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_provider_name:
      description: The name of the provider. Usually Cloudflare.
      example: Cloudflare
      type: string
    zero-trust-gateway_proxy-endpoints:
      properties:
        created_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        id:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
        ips:
          $ref: '#/components/schemas/zero-trust-gateway_ips'
        name:
          $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name'
        subdomain:
          $ref: '#/components/schemas/zero-trust-gateway_schemas-subdomain'
        updated_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
      type: object
    zero-trust-gateway_proxy-endpoints_components-schemas-name:
      description: The name of the proxy endpoint.
      example: Devops team
      type: string
    zero-trust-gateway_proxy-endpoints_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints'
              type: array
    zero-trust-gateway_proxy-endpoints_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints'
    zero-trust-gateway_public_key:
      description: SSH encryption public key
      example: 1pyl6I1tL7xfJuFYVzXlUW8uXXlpxegHXBzGCBKaSFA=
      type: string
    zero-trust-gateway_response_collection:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/zero-trust-gateway_certificates'
              type: array
    zero-trust-gateway_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    zero-trust-gateway_rule-settings:
      description: Additional settings that modify the rule's action.
      properties:
        add_headers:
          additionalProperties:
            type: string
          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
          type: object
        allow_child_bypass:
          description: Set by parent MSP accounts to enable their children to bypass this rule.
          example: false
          type: boolean
        audit_ssh:
          description: Settings for the Audit SSH action.
          properties:
            command_logging:
              description: Enable to turn on SSH command logging.
              example: false
              type: boolean
          type: object
        biso_admin_controls:
          description: Configure how browser isolation behaves.
          properties:
            dcp:
              description: Set to false to enable copy-pasting.
              example: false
              type: boolean
            dd:
              description: Set to false to enable downloading.
              example: false
              type: boolean
            dk:
              description: Set to false to enable keyboard usage.
              example: false
              type: boolean
            dp:
              description: Set to false to enable printing.
              example: false
              type: boolean
            du:
              description: Set to false to enable uploading.
              example: false
              type: boolean
          type: object
        block_page_enabled:
          description: Enable the custom block page.
          example: true
          type: boolean
        block_reason:
          description: The text describing why this block occurred, displayed on the custom block page (if enabled).
          example: This website is a security risk
          type: string
        bypass_parent_rule:
          description: Set by children MSP accounts to bypass their parent's rules.
          example: false
          type: boolean
        check_session:
          description: Configure how session check behaves.
          properties:
            duration:
              description: Configure how fresh the session needs to be to be considered valid.
              example: 300s
              type: string
            enforce:
              description: Set to true to enable session enforcement.
              example: true
              type: boolean
          type: object
        dns_resolvers:
          description: Add your own custom resolvers to route queries that match the resolver policy. Cannot be used when resolve_dns_through_cloudflare is set. DNS queries will route to the address closest to their origin. Only valid when a rule's action is set to 'resolve'.
          properties:
            ipv4:
              items:
                $ref: '#/components/schemas/zero-trust-gateway_dns_resolver_settings_v4'
              type: array
            ipv6:
              items:
                $ref: '#/components/schemas/zero-trust-gateway_dns_resolver_settings_v6'
              type: array
          type: object
        egress:
          description: Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs.
          properties:
            ipv4:
              description: The IPv4 address to be used for egress.
              example: 192.0.2.2
              type: string
            ipv4_fallback:
              description: The fallback IPv4 address to be used for egress in the event of an error egressing with the primary IPv4. Can be '0.0.0.0' to indicate local egress via WARP IPs.
              example: 192.0.2.3
              type: string
            ipv6:
              description: The IPv6 range to be used for egress.
              example: 2001:DB8::/64
              type: string
          type: object
        ignore_cname_category_matches:
          description: Set to true, to ignore the category matches at CNAME domains in a response. If unchecked, the categories in this rule will be checked against all the CNAME domain categories in a response.
          example: true
          type: boolean
        insecure_disable_dnssec_validation:
          description: INSECURE - disable DNSSEC validation (for Allow actions).
          example: false
          type: boolean
        ip_categories:
          description: Set to true to enable IPs in DNS resolver category blocks. By default categories only block based on domain names.
          example: true
          type: boolean
        ip_indicator_feeds:
          description: Set to true to include IPs in DNS resolver indicator feed blocks. By default indicator feeds only block based on domain names.
          example: true
          type: boolean
        l4override:
          description: Send matching traffic to the supplied destination IP address and port.
          properties:
            ip:
              description: IPv4 or IPv6 address.
              example: 1.1.1.1
              type: string
            port:
              description: A port number to use for TCP/UDP overrides.
              type: integer
          type: object
        notification_settings:
          description: Configure a notification to display on the user's device when this rule is matched.
          properties:
            enabled:
              description: Set notification on
              type: boolean
            msg:
              description: Customize the message shown in the notification.
              type: string
            support_url:
              description: Optional URL to direct users to additional information. If not set, the notification will open a block page.
              type: string
          type: object
        override_host:
          description: Override matching DNS queries with a hostname.
          example: example.com
          type: string
        override_ips:
          description: Override matching DNS queries with an IP or set of IPs.
          example:
            - 1.1.1.1
            - 2.2.2.2
          items:
            description: IPv4 or IPv6 address.
            example: 1.1.1.1
            type: string
          type: array
        payload_log:
          description: Configure DLP payload logging.
          properties:
            enabled:
              description: Set to true to enable DLP payload logging for this rule.
              example: true
              type: boolean
          type: object
        resolve_dns_through_cloudflare:
          description: Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot be set when dns_resolvers are specified. Only valid when a rule's action is set to 'resolve'.
          example: true
          type: boolean
        untrusted_cert:
          description: Configure behavior when an upstream cert is invalid or an SSL error occurs.
          properties:
            action:
              description: The action performed when an untrusted certificate is seen. The default action is an error with HTTP code 526.
              enum:
                - pass_through
                - block
                - error
              example: error
              type: string
          type: object
      type: object
    zero-trust-gateway_rules:
      properties:
        action:
          $ref: '#/components/schemas/zero-trust-gateway_action'
        created_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        deleted_at:
          $ref: '#/components/schemas/zero-trust-gateway_deleted_at'
        description:
          $ref: '#/components/schemas/zero-trust-gateway_schemas-description'
        device_posture:
          $ref: '#/components/schemas/zero-trust-gateway_device_posture'
        enabled:
          $ref: '#/components/schemas/zero-trust-gateway_enabled'
        filters:
          $ref: '#/components/schemas/zero-trust-gateway_filters'
        id:
          $ref: '#/components/schemas/zero-trust-gateway_rules_components-schemas-uuid'
        identity:
          $ref: '#/components/schemas/zero-trust-gateway_identity'
        name:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-name'
        precedence:
          $ref: '#/components/schemas/zero-trust-gateway_precedence'
        rule_settings:
          $ref: '#/components/schemas/zero-trust-gateway_rule-settings'
        schedule:
          $ref: '#/components/schemas/zero-trust-gateway_schedule'
        traffic:
          $ref: '#/components/schemas/zero-trust-gateway_traffic'
        updated_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
      type: object
    zero-trust-gateway_rules_components-schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/zero-trust-gateway_rules'
              type: array
    zero-trust-gateway_rules_components-schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/zero-trust-gateway_rules'
    zero-trust-gateway_rules_components-schemas-uuid:
      description: The API resource UUID.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    zero-trust-gateway_schedule:
      description: The schedule for activating DNS policies. This does not apply to HTTP or network policies.
      properties:
        fri:
          description: The time intervals when the rule will be active on Fridays, in increasing order from 00:00-24:00.  If this parameter is omitted, the rule will be deactivated on Fridays.
          example: 08:00-12:30,13:30-17:00
          type: string
        mon:
          description: The time intervals when the rule will be active on Mondays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Mondays.
          example: 08:00-12:30,13:30-17:00
          type: string
        sat:
          description: The time intervals when the rule will be active on Saturdays, in increasing order from 00:00-24:00.  If this parameter is omitted, the rule will be deactivated on Saturdays.
          example: 08:00-12:30,13:30-17:00
          type: string
        sun:
          description: The time intervals when the rule will be active on Sundays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Sundays.
          example: 08:00-12:30,13:30-17:00
          type: string
        thu:
          description: The time intervals when the rule will be active on Thursdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Thursdays.
          example: 08:00-12:30,13:30-17:00
          type: string
        time_zone:
          description: The time zone the rule will be evaluated against. If a [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) is provided, Gateway will always use the current time at that time zone. If this parameter is omitted, then Gateway will use the time zone inferred from the user's source IP to evaluate the rule. If Gateway cannot determine the time zone from the IP, we will fall back to the time zone of the user's connected data center.
          example: America/New York
          type: string
        tue:
          description: The time intervals when the rule will be active on Tuesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Tuesdays.
          example: 08:00-12:30,13:30-17:00
          type: string
        wed:
          description: The time intervals when the rule will be active on Wednesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Wednesdays.
          example: 08:00-12:30,13:30-17:00
          type: string
      type: object
    zero-trust-gateway_schemas-description:
      description: The description of the rule.
      example: Block bad websites based on their host name.
      type: string
    zero-trust-gateway_schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    zero-trust-gateway_schemas-name:
      description: The name of the location.
      example: Austin Office Location
      type: string
    zero-trust-gateway_schemas-response_collection:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/zero-trust-gateway_lists'
              type: array
    zero-trust-gateway_schemas-single_response:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/zero-trust-gateway_lists'
    zero-trust-gateway_schemas-subdomain:
      description: The subdomain to be used as the destination in the proxy client.
      example: oli3n9zkz5.proxy.cloudflare-gateway.com
      type: string
    zero-trust-gateway_schemas-type:
      description: The type of list.
      enum:
        - SERIAL
        - URL
        - DOMAIN
        - EMAIL
        - IP
      example: SERIAL
      type: string
    zero-trust-gateway_schemas-uuid:
      description: API Resource UUID tag.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    zero-trust-gateway_settings:
      properties:
        created_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        public_key:
          $ref: '#/components/schemas/zero-trust-gateway_public_key'
        seed_id:
          $ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-uuid'
        updated_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
      type: object
    zero-trust-gateway_single_response:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
        - properties:
            result:
              $ref: '#/components/schemas/zero-trust-gateway_certificates'
    zero-trust-gateway_single_response_with_list_items:
      allOf:
        - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
        - properties:
            result:
              properties:
                created_at:
                  $ref: '#/components/schemas/zero-trust-gateway_timestamp'
                description:
                  $ref: '#/components/schemas/zero-trust-gateway_description'
                id:
                  $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
                items:
                  $ref: '#/components/schemas/zero-trust-gateway_items'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_name'
                type:
                  $ref: '#/components/schemas/zero-trust-gateway_schemas-type'
                updated_at:
                  $ref: '#/components/schemas/zero-trust-gateway_timestamp'
    zero-trust-gateway_subcategory:
      properties:
        beta:
          $ref: '#/components/schemas/zero-trust-gateway_beta'
        class:
          $ref: '#/components/schemas/zero-trust-gateway_class'
        description:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-description'
        id:
          $ref: '#/components/schemas/zero-trust-gateway_id'
        name:
          $ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-name'
      type: object
    zero-trust-gateway_subdomain:
      description: The DNS over HTTPS domain to send DNS requests to. This field is auto-generated by Gateway.
      example: oli3n9zkz5
      type: string
    zero-trust-gateway_timestamp:
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      type: string
    zero-trust-gateway_tls-settings:
      description: TLS interception settings.
      properties:
        enabled:
          description: Enable inspecting encrypted HTTP traffic.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_traffic:
      description: The wirefilter expression used for traffic matching.
      example: http.request.uri matches ".*a/partial/uri.*" and http.request.host in $01302951-49f9-47c9-a400-0297e60b6a10
      type: string
    zero-trust-gateway_type:
      description: The type of certificate, either BYO-PKI (custom) or Gateway-managed.
      enum:
        - custom
        - gateway_managed
      example: gateway_managed
      type: string
    zero-trust-gateway_uuid:
      description: Certificate UUID tag.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    zero-trust-gateway_value:
      description: The value of the item in a list.
      example: 8GE8721REF
      type: string
    zone-activation_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/zone-activation_messages'
        messages:
          $ref: '#/components/schemas/zone-activation_messages'
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    zone-activation_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/zone-activation_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/zone-activation_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    zone-activation_api-response-single:
      allOf:
        - $ref: '#/components/schemas/zone-activation_api-response-common'
      type: object
    zone-activation_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    zone-activation_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    zone-analytics-api_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/zone-analytics-api_messages'
        messages:
          $ref: '#/components/schemas/zone-analytics-api_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    zone-analytics-api_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/zone-analytics-api_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/zone-analytics-api_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    zone-analytics-api_api-response-single:
      allOf:
        - $ref: '#/components/schemas/zone-analytics-api_api-response-common'
        - properties:
            result:
              anyOf:
                - nullable: true
                  type: object
                - nullable: true
                  type: string
      type: object
    zone-analytics-api_bandwidth:
      description: Breakdown of totals for bandwidth in the form of bytes.
      properties:
        all:
          description: The total number of bytes served within the time frame.
          type: integer
        cached:
          description: The number of bytes that were cached (and served) by Cloudflare.
          type: integer
        content_type:
          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
          type: object
        country:
          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
          type: object
        ssl:
          description: A break down of bytes served over HTTPS.
          properties:
            encrypted:
              description: The number of bytes served over HTTPS.
              type: integer
            unencrypted:
              description: The number of bytes served over HTTP.
              type: integer
          type: object
        ssl_protocols:
          description: A breakdown of requests by their SSL protocol.
          properties:
            TLSv1:
              description: The number of requests served over TLS v1.0.
              type: integer
            TLSv1.1:
              description: The number of requests served over TLS v1.1.
              type: integer
            TLSv1.2:
              description: The number of requests served over TLS v1.2.
              type: integer
            TLSv1.3:
              description: The number of requests served over TLS v1.3.
              type: integer
            none:
              description: The number of requests served over HTTP.
              type: integer
          type: object
        uncached:
          description: The number of bytes that were fetched and served from the origin server.
          type: integer
      type: object
    zone-analytics-api_bandwidth_by_colo:
      description: Breakdown of totals for bandwidth in the form of bytes.
      properties:
        all:
          description: The total number of bytes served within the time frame.
          type: integer
        cached:
          description: The number of bytes that were cached (and served) by Cloudflare.
          type: integer
        uncached:
          description: The number of bytes that were fetched and served from the origin server.
          type: integer
      type: object
    zone-analytics-api_colo_response:
      allOf:
        - $ref: '#/components/schemas/zone-analytics-api_api-response-single'
        - properties:
            query:
              $ref: '#/components/schemas/zone-analytics-api_query_response'
            result:
              $ref: '#/components/schemas/zone-analytics-api_datacenters'
    zone-analytics-api_dashboard:
      description: Totals and timeseries data.
      properties:
        timeseries:
          $ref: '#/components/schemas/zone-analytics-api_timeseries'
        totals:
          $ref: '#/components/schemas/zone-analytics-api_totals'
      title: Dashboard response
      type: object
    zone-analytics-api_dashboard_response:
      allOf:
        - $ref: '#/components/schemas/zone-analytics-api_api-response-single'
        - properties:
            query:
              $ref: '#/components/schemas/zone-analytics-api_query_response'
            result:
              $ref: '#/components/schemas/zone-analytics-api_dashboard'
    zone-analytics-api_datacenters:
      description: A breakdown of all dashboard analytics data by co-locations. This is limited to Enterprise zones only.
      items:
        properties:
          colo_id:
            description: The airport code identifer for the co-location.
            example: SFO
            type: string
          timeseries:
            $ref: '#/components/schemas/zone-analytics-api_timeseries_by_colo'
          totals:
            $ref: '#/components/schemas/zone-analytics-api_totals_by_colo'
        type: object
      title: Analytics data by datacenter
      type: array
    zone-analytics-api_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    zone-analytics-api_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    zone-analytics-api_pageviews:
      description: Breakdown of totals for pageviews.
      properties:
        all:
          description: The total number of pageviews served within the time range.
          type: integer
        search_engine:
          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
          type: object
      type: object
    zone-analytics-api_query_response:
      description: The exact parameters/timestamps the analytics service used to return data.
      properties:
        since:
          $ref: '#/components/schemas/zone-analytics-api_since'
        time_delta:
          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.
          type: integer
        until:
          $ref: '#/components/schemas/zone-analytics-api_until'
      readOnly: true
      type: object
    zone-analytics-api_requests:
      description: Breakdown of totals for requests.
      properties:
        all:
          description: Total number of requests served.
          type: integer
        cached:
          description: Total number of cached requests served.
          type: integer
        content_type:
          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
          type: object
        country:
          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
          type: object
        http_status:
          additionalProperties: true
          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
          type: object
        ssl:
          description: A break down of requests served over HTTPS.
          properties:
            encrypted:
              description: The number of requests served over HTTPS.
              type: integer
            unencrypted:
              description: The number of requests served over HTTP.
              type: integer
          type: object
        ssl_protocols:
          description: A breakdown of requests by their SSL protocol.
          properties:
            TLSv1:
              description: The number of requests served over TLS v1.0.
              type: integer
            TLSv1.1:
              description: The number of requests served over TLS v1.1.
              type: integer
            TLSv1.2:
              description: The number of requests served over TLS v1.2.
              type: integer
            TLSv1.3:
              description: The number of requests served over TLS v1.3.
              type: integer
            none:
              description: The number of requests served over HTTP.
              type: integer
          type: object
        uncached:
          description: Total number of requests served from the origin.
          type: integer
      type: object
    zone-analytics-api_requests_by_colo:
      description: Breakdown of totals for requests.
      properties:
        all:
          description: Total number of requests served.
          type: integer
        cached:
          description: Total number of cached requests served.
          type: integer
        country:
          additionalProperties: true
          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
          type: object
        http_status:
          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
          type: object
        uncached:
          description: Total number of requests served from the origin.
          type: integer
      type: object
    zone-analytics-api_since:
      anyOf:
        - type: string
        - type: integer
      default: -10080
      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.
      example: "2015-01-01T12:23:00Z"
    zone-analytics-api_threats:
      description: Breakdown of totals for threats.
      properties:
        all:
          description: The total number of identifiable threats received over the time frame.
          type: integer
        country:
          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: object
        type:
          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
          type: object
      type: object
    zone-analytics-api_timeseries:
      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:
        properties:
          bandwidth:
            $ref: '#/components/schemas/zone-analytics-api_bandwidth'
          pageviews:
            $ref: '#/components/schemas/zone-analytics-api_pageviews'
          requests:
            $ref: '#/components/schemas/zone-analytics-api_requests'
          since:
            $ref: '#/components/schemas/zone-analytics-api_since'
          threats:
            $ref: '#/components/schemas/zone-analytics-api_threats'
          uniques:
            $ref: '#/components/schemas/zone-analytics-api_uniques'
          until:
            $ref: '#/components/schemas/zone-analytics-api_until'
        type: object
      type: array
    zone-analytics-api_timeseries_by_colo:
      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:
        properties:
          bandwidth:
            $ref: '#/components/schemas/zone-analytics-api_bandwidth_by_colo'
          requests:
            $ref: '#/components/schemas/zone-analytics-api_requests_by_colo'
          since:
            $ref: '#/components/schemas/zone-analytics-api_since'
          threats:
            $ref: '#/components/schemas/zone-analytics-api_threats'
          until:
            $ref: '#/components/schemas/zone-analytics-api_until'
        type: object
      type: array
    zone-analytics-api_totals:
      description: Breakdown of totals by data type.
      properties:
        bandwidth:
          $ref: '#/components/schemas/zone-analytics-api_bandwidth'
        pageviews:
          $ref: '#/components/schemas/zone-analytics-api_pageviews'
        requests:
          $ref: '#/components/schemas/zone-analytics-api_requests'
        since:
          $ref: '#/components/schemas/zone-analytics-api_since'
        threats:
          $ref: '#/components/schemas/zone-analytics-api_threats'
        uniques:
          $ref: '#/components/schemas/zone-analytics-api_uniques'
        until:
          $ref: '#/components/schemas/zone-analytics-api_until'
      type: object
    zone-analytics-api_totals_by_colo:
      description: Breakdown of totals by data type.
      properties:
        bandwidth:
          $ref: '#/components/schemas/zone-analytics-api_bandwidth_by_colo'
        requests:
          $ref: '#/components/schemas/zone-analytics-api_requests_by_colo'
        since:
          $ref: '#/components/schemas/zone-analytics-api_since'
        threats:
          $ref: '#/components/schemas/zone-analytics-api_threats'
        until:
          $ref: '#/components/schemas/zone-analytics-api_until'
      type: object
    zone-analytics-api_uniques:
      properties:
        all:
          description: Total number of unique IP addresses within the time range.
          type: integer
      type: object
    zone-analytics-api_until:
      anyOf:
        - type: string
        - type: integer
      default: 0
      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.
      example: "2015-01-02T12:23:00Z"
    zones_0rtt:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - 0rtt
              example: 0rtt
            value:
              $ref: '#/components/schemas/zones_0rtt_value'
      description: 0-RTT session resumption enabled for this zone.
      title: 0-RTT Value
    zones_0rtt_value:
      default: "off"
      description: Value of the 0-RTT setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_actions:
      description: The set of actions to perform if the targets of this rule match the request. Actions can redirect to another URL or override settings, but not both.
      example:
        - id: browser_check
          value: "on"
      items:
        oneOf:
          - $ref: '#/components/schemas/zones_route'
      type: array
    zones_advanced_ddos:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - advanced_ddos
              example: advanced_ddos
            value:
              $ref: '#/components/schemas/zones_advanced_ddos_value'
      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.
      title: Advanced DDoS Protection
    zones_advanced_ddos_value:
      default: "off"
      description: |-
        Value of the zone setting.
        Notes: Defaults to on for Business+ plans
      enum:
        - "on"
        - "off"
      type: string
    zones_always_online:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - always_online
              example: always_online
            value:
              $ref: '#/components/schemas/zones_always_online_value'
      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.
      title: Always Online Mode
    zones_always_online_value:
      default: "on"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_always_use_https:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - always_use_https
              example: always_use_https
            value:
              $ref: '#/components/schemas/zones_always_use_https_value'
      default: "off"
      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.
      title: Zone Enable Always Use HTTPS
    zones_always_use_https_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/zones_messages'
        messages:
          $ref: '#/components/schemas/zones_messages'
        success:
          description: Whether the API call was successful
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
      type: object
    zones_api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/zones_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/zones_messages'
          example: []
        result:
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    zones_api-response-single:
      allOf:
        - $ref: '#/components/schemas/zones_schemas-api-response-common'
        - properties:
            result:
              anyOf:
                - type: object
                - type: string
      type: object
    zones_api-response-single-id:
      allOf:
        - $ref: '#/components/schemas/zones_api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                id:
                  $ref: '#/components/schemas/zones_identifier'
              required:
                - id
              type: object
      type: object
    zones_automatic_https_rewrites:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - automatic_https_rewrites
              example: automatic_https_rewrites
            value:
              $ref: '#/components/schemas/zones_automatic_https_rewrites_value'
      default: "off"
      description: Enable the Automatic HTTPS Rewrites feature for this zone.
      title: Zone Enable Automatic HTTPS Rewrites
    zones_automatic_https_rewrites_value:
      default: "on"
      description: |-
        Value of the zone setting.
        Notes: Default value depends on the zone's plan level.
      enum:
        - "on"
        - "off"
      type: string
    zones_automatic_platform_optimization:
      properties:
        cache_by_device_type:
          description: Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled.
          example: false
          type: boolean
        cf:
          default: false
          description: Indicates whether or not Cloudflare proxy is enabled.
          example: true
          type: boolean
        enabled:
          default: false
          description: Indicates whether or not Automatic Platform Optimization is enabled.
          example: true
          type: boolean
        hostnames:
          description: An array of hostnames where Automatic Platform Optimization for WordPress is activated.
          example:
            - www.example.com
            - example.com
            - shop.example.com
          items:
            format: hostname
            type: string
          type: array
        wordpress:
          default: false
          description: Indicates whether or not site is powered by WordPress.
          example: true
          type: boolean
        wp_plugin:
          default: false
          description: Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed.
          example: true
          type: boolean
      required:
        - enabled
        - cf
        - wordpress
        - wp_plugin
        - hostnames
        - cache_by_device_type
      type: object
    zones_base:
      properties:
        editable:
          default: true
          description: Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).
          enum:
            - true
            - false
          readOnly: true
          type: boolean
        id:
          description: Identifier of the zone setting.
          example: development_mode
          type: string
        modified_on:
          description: last time this setting was modified.
          example: "2014-01-01T05:20:00.12345Z"
          format: date-time
          nullable: true
          readOnly: true
          type: string
        value:
          description: Current value of the zone setting.
          example: "on"
      required:
        - id
        - value
    zones_brotli:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - brotli
              example: brotli
            value:
              $ref: '#/components/schemas/zones_brotli_value'
      description: When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.
      title: Brotli Compression
    zones_brotli_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "off"
        - "on"
      type: string
    zones_browser_cache_ttl:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - browser_cache_ttl
              example: browser_cache_ttl
            value:
              $ref: '#/components/schemas/zones_browser_cache_ttl_value'
      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).
      title: Browser Cache TTL
    zones_browser_cache_ttl_value:
      default: 14400
      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
      type: number
    zones_browser_check:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - browser_check
              example: browser_check
            value:
              $ref: '#/components/schemas/zones_browser_check_value'
      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).
      title: Browser Check
    zones_browser_check_value:
      default: "on"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_cache_level:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - cache_level
              example: cache_level
            value:
              $ref: '#/components/schemas/zones_cache_level_value'
      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).
      title: Cloudflare Cache Level
    zones_cache_level_value:
      default: aggressive
      description: Value of the zone setting.
      enum:
        - aggressive
        - basic
        - simplified
      type: string
    zones_challenge_ttl:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - challenge_ttl
              example: challenge_ttl
            value:
              $ref: '#/components/schemas/zones_challenge_ttl_value'
      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).
      title: Challenge Page TTL
    zones_challenge_ttl_value:
      default: 1800
      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
      type: number
    zones_ciphers:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - ciphers
              example: ciphers
            value:
              $ref: '#/components/schemas/zones_ciphers_value'
      default: []
      description: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.
      title: Zone ciphers allowed for TLS termination
    zones_ciphers_value:
      default: []
      description: Value of the zone setting.
      example:
        - ECDHE-RSA-AES128-GCM-SHA256
        - AES128-SHA
      items:
        type: string
      type: array
      uniqueItems: true
    zones_cname_flattening:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: How to flatten the cname destination.
              enum:
                - cname_flattening
            value:
              $ref: '#/components/schemas/zones_cname_flattening_value'
      description: Whether or not cname flattening is on.
      title: Cloudflare CNAME Flattening
    zones_cname_flattening_value:
      default: flatten_at_root
      description: Value of the cname flattening setting.
      enum:
        - flatten_at_root
        - flatten_all
      type: string
    zones_created_on:
      description: The timestamp of when the Page Rule was created.
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      readOnly: true
      type: string
    zones_development_mode:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - development_mode
              example: development_mode
            time_remaining:
              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
              type: number
            value:
              $ref: '#/components/schemas/zones_development_mode_value'
      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.
      title: Development Mode
    zones_development_mode_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_early_hints:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - early_hints
              example: early_hints
            value:
              $ref: '#/components/schemas/zones_early_hints_value'
      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.
      title: Early Hints
    zones_early_hints_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_edge_cache_ttl:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - edge_cache_ttl
              example: edge_cache_ttl
            value:
              $ref: '#/components/schemas/zones_edge_cache_ttl_value'
      description: Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers.
      title: Edge Cache TTL
    zones_edge_cache_ttl_value:
      default: 7200
      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
      type: number
    zones_email_obfuscation:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - email_obfuscation
              example: email_obfuscation
            value:
              $ref: '#/components/schemas/zones_email_obfuscation_value'
      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).
      title: Email Obfuscation
    zones_email_obfuscation_value:
      default: "on"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_h2_prioritization:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - h2_prioritization
              example: h2_prioritization
            value:
              $ref: '#/components/schemas/zones_h2_prioritization_value'
      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.
      title: HTTP/2 Edge Prioritization
    zones_h2_prioritization_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
        - custom
      type: string
    zones_hotlink_protection:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - hotlink_protection
              example: hotlink_protection
            value:
              $ref: '#/components/schemas/zones_hotlink_protection_value'
      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).
      title: Hotlink Protection
    zones_hotlink_protection_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_http2:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - http2
              example: http2
            value:
              $ref: '#/components/schemas/zones_http2_value'
      description: HTTP2 enabled for this zone.
      title: HTTP2 Value
    zones_http2_value:
      default: "off"
      description: Value of the HTTP2 setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_http3:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - http3
              example: http3
            value:
              $ref: '#/components/schemas/zones_http3_value'
      description: HTTP3 enabled for this zone.
      title: HTTP3 Value
    zones_http3_value:
      default: "off"
      description: Value of the HTTP3 setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    zones_image_resizing:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - image_resizing
              example: image_resizing
            value:
              $ref: '#/components/schemas/zones_image_resizing_value'
      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.
      title: Image Resizing
    zones_image_resizing_value:
      default: "off"
      description: Whether the feature is enabled, disabled, or enabled in `open proxy` mode.
      enum:
        - "on"
        - "off"
        - open
      type: string
    zones_ip_geolocation:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - ip_geolocation
              example: ip_geolocation
            value:
              $ref: '#/components/schemas/zones_ip_geolocation_value'
      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).
      title: IP Geolocation
    zones_ip_geolocation_value:
      default: "on"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_ipv6:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - ipv6
              example: ipv6
            value:
              $ref: '#/components/schemas/zones_ipv6_value'
      description: Enable IPv6 on all subdomains that are Cloudflare enabled.  (https://support.cloudflare.com/hc/en-us/articles/200168586).
      title: IPv6
    zones_ipv6_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "off"
        - "on"
      type: string
    zones_max_upload:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: identifier of the zone setting.
              enum:
                - max_upload
              example: max_upload
            value:
              $ref: '#/components/schemas/zones_max_upload_value'
      description: Maximum size of an allowable upload.
      title: Max Upload
    zones_max_upload_value:
      default: 100
      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
      type: number
    zones_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
          - code
          - message
        type: object
        uniqueItems: true
      type: array
    zones_min_tls_version:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - min_tls_version
              example: min_tls_version
            value:
              $ref: '#/components/schemas/zones_min_tls_version_value'
      default: "1.0"
      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.
      title: Zone Minimum TLS Version value
    zones_min_tls_version_value:
      default: "1.0"
      description: Value of the zone setting.
      enum:
        - "1.0"
        - "1.1"
        - "1.2"
        - "1.3"
      type: string
    zones_mirage:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - mirage
              example: mirage
            value:
              $ref: '#/components/schemas/zones_mirage_value'
      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.
      title: Mirage Image Optimization
    zones_mirage_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_multiple_settings:
      items:
        anyOf:
          - $ref: '#/components/schemas/zones_0rtt'
          - $ref: '#/components/schemas/zones_advanced_ddos'
          - $ref: '#/components/schemas/zones_always_online'
          - $ref: '#/components/schemas/zones_always_use_https'
          - $ref: '#/components/schemas/zones_automatic_https_rewrites'
          - $ref: '#/components/schemas/zones_brotli'
          - $ref: '#/components/schemas/zones_browser_cache_ttl'
          - $ref: '#/components/schemas/zones_browser_check'
          - $ref: '#/components/schemas/zones_cache_level'
          - $ref: '#/components/schemas/zones_challenge_ttl'
          - $ref: '#/components/schemas/zones_ciphers'
          - $ref: '#/components/schemas/zones_cname_flattening'
          - $ref: '#/components/schemas/zones_development_mode'
          - $ref: '#/components/schemas/zones_early_hints'
          - $ref: '#/components/schemas/zones_edge_cache_ttl'
          - $ref: '#/components/schemas/zones_email_obfuscation'
          - $ref: '#/components/schemas/zones_h2_prioritization'
          - $ref: '#/components/schemas/zones_hotlink_protection'
          - $ref: '#/components/schemas/zones_http2'
          - $ref: '#/components/schemas/zones_http3'
          - $ref: '#/components/schemas/zones_ip_geolocation'
          - $ref: '#/components/schemas/zones_ipv6'
          - $ref: '#/components/schemas/zones_max_upload'
          - $ref: '#/components/schemas/zones_min_tls_version'
          - $ref: '#/components/schemas/zones_mirage'
          - $ref: '#/components/schemas/zones_nel'
          - $ref: '#/components/schemas/zones_opportunistic_encryption'
          - $ref: '#/components/schemas/zones_opportunistic_onion'
          - $ref: '#/components/schemas/zones_orange_to_orange'
          - $ref: '#/components/schemas/zones_origin_error_page_pass_thru'
          - $ref: '#/components/schemas/zones_polish'
          - $ref: '#/components/schemas/zones_prefetch_preload'
          - $ref: '#/components/schemas/zones_proxy_read_timeout'
          - $ref: '#/components/schemas/zones_pseudo_ipv4'
          - $ref: '#/components/schemas/zones_replace_insecure_js'
          - $ref: '#/components/schemas/zones_response_buffering'
          - $ref: '#/components/schemas/zones_rocket_loader'
          - $ref: '#/components/schemas/zones_schemas-automatic_platform_optimization'
          - $ref: '#/components/schemas/zones_security_header'
          - $ref: '#/components/schemas/zones_security_level'
          - $ref: '#/components/schemas/zones_server_side_exclude'
          - $ref: '#/components/schemas/zones_sha1_support'
          - $ref: '#/components/schemas/zones_sort_query_string_for_cache'
          - $ref: '#/components/schemas/zones_ssl'
          - $ref: '#/components/schemas/zones_ssl_recommender'
          - $ref: '#/components/schemas/zones_tls_1_2_only'
          - $ref: '#/components/schemas/zones_tls_1_3'
          - $ref: '#/components/schemas/zones_tls_client_auth'
          - $ref: '#/components/schemas/zones_true_client_ip_header'
          - $ref: '#/components/schemas/zones_waf'
          - $ref: '#/components/schemas/zones_webp'
          - $ref: '#/components/schemas/zones_websockets'
      type: array
    zones_name:
      description: The domain name
      example: example.com
      maxLength: 253
      pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$
      type: string
    zones_nel:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: Zone setting identifier.
              enum:
                - nel
              example: nel
            value:
              $ref: '#/components/schemas/zones_nel_value'
      description: 'Enable Network Error Logging reporting on your zone. (Beta) '
      title: Network Error Logging
    zones_nel_value:
      default:
        enabled: false
      description: Value of the zone setting.
      properties:
        enabled:
          default: false
          example: false
          type: boolean
      type: object
    zones_opportunistic_encryption:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - opportunistic_encryption
              example: opportunistic_encryption
            value:
              $ref: '#/components/schemas/zones_opportunistic_encryption_value'
      description: Enables the Opportunistic Encryption feature for a zone.
      title: Enable Opportunistic Encryption for a zone
    zones_opportunistic_encryption_value:
      default: "on"
      description: |-
        Value of the zone setting.
        Notes: Default value depends on the zone's plan level.
      enum:
        - "on"
        - "off"
      type: string
    zones_opportunistic_onion:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - opportunistic_onion
              example: opportunistic_onion
            value:
              $ref: '#/components/schemas/zones_opportunistic_onion_value'
      default: "off"
      description: Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.
      title: Zone Enable Onion Routing
    zones_opportunistic_onion_value:
      default: "off"
      description: |-
        Value of the zone setting.
        Notes: Default value depends on the zone's plan level.
      enum:
        - "on"
        - "off"
      type: string
    zones_orange_to_orange:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - orange_to_orange
              example: orange_to_orange
            value:
              $ref: '#/components/schemas/zones_orange_to_orange_value'
      description: Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.
      title: Orange to Orange
    zones_orange_to_orange_value:
      default: "on"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_origin_error_page_pass_thru:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - origin_error_page_pass_thru
              example: origin_error_page_pass_thru
            value:
              $ref: '#/components/schemas/zones_origin_error_page_pass_thru_value'
      default: "off"
      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.
      title: Error Pages On
    zones_origin_error_page_pass_thru_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_page-rule:
      properties:
        actions:
          $ref: '#/components/schemas/zones_actions'
        created_on:
          $ref: '#/components/schemas/zones_created_on'
        id:
          $ref: '#/components/schemas/zones_schemas-identifier'
        modified_on:
          $ref: '#/components/schemas/zones_schemas-modified_on'
        priority:
          $ref: '#/components/schemas/zones_priority'
        status:
          $ref: '#/components/schemas/zones_status'
        targets:
          $ref: '#/components/schemas/zones_targets'
      required:
        - id
        - targets
        - actions
        - priority
        - status
        - modified_on
        - created_on
      type: object
    zones_pagerule_response_collection:
      allOf:
        - $ref: '#/components/schemas/zones_schemas-api-response-common'
        - properties:
            result:
              items:
                $ref: '#/components/schemas/zones_page-rule'
              type: array
    zones_pagerule_response_single:
      allOf:
        - $ref: '#/components/schemas/zones_api-response-single'
        - properties:
            result:
              type: object
    zones_pagerule_settings_response_collection:
      allOf:
        - $ref: '#/components/schemas/zones_schemas-api-response-common'
        - properties:
            result:
              $ref: '#/components/schemas/zones_settings'
    zones_paused:
      default: false
      description: |
        Indicates whether the zone is only using Cloudflare DNS services. A
        true value means the zone will not receive security or performance
        benefits.
      readOnly: true
      type: boolean
    zones_polish:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - polish
              example: polish
            value:
              $ref: '#/components/schemas/zones_polish_value'
      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.'
      title: Polish Image Optimization
    zones_polish_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "off"
        - lossless
        - lossy
      type: string
    zones_prefetch_preload:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - prefetch_preload
              example: prefetch_preload
            value:
              $ref: '#/components/schemas/zones_prefetch_preload_value'
      default: "off"
      description: Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.
      title: Prefetch preload
    zones_prefetch_preload_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_priority:
      default: 1
      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.'
      type: integer
    zones_proxy_read_timeout:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - proxy_read_timeout
              example: proxy_read_timeout
            value:
              $ref: '#/components/schemas/zones_proxy_read_timeout_value'
      description: Maximum time between two read operations from origin.
      title: Proxy Read Timeout
    zones_proxy_read_timeout_value:
      default: 100
      description: |-
        Value of the zone setting.
        Notes: Value must be between 1 and 6000
      type: number
    zones_pseudo_ipv4:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              default: pseudo_ipv4
              description: Value of the Pseudo IPv4 setting.
              enum:
                - pseudo_ipv4
            value:
              $ref: '#/components/schemas/zones_pseudo_ipv4_value'
      description: The value set for the Pseudo IPv4 setting.
      title: Pseudo IPv4 Value
    zones_pseudo_ipv4_value:
      default: "off"
      description: Value of the Pseudo IPv4 setting.
      enum:
        - "off"
        - add_header
        - overwrite_header
      type: string
    zones_replace_insecure_js:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - replace_insecure_js
              example: replace_insecure_js
            value:
              $ref: '#/components/schemas/zones_replace_insecure_js_value'
      description: |
        Automatically replace insecure JavaScript libraries with safer and faster alternatives provided under cdnjs and powered by Cloudflare. Currently supports the following libraries: Polyfill under polyfill.io.
      title: Replace insecure JavaScript libraries
    zones_replace_insecure_js_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_response_buffering:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - response_buffering
              example: response_buffering
            value:
              $ref: '#/components/schemas/zones_response_buffering_value'
      default: "off"
      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.
      title: Response Buffering
    zones_response_buffering_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    zones_rocket_loader:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - rocket_loader
              example: rocket_loader
            value:
              $ref: '#/components/schemas/zones_rocket_loader_value'
      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.
      title: Rocket Loader
    zones_rocket_loader_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_route:
      properties:
        modified_on:
          description: The timestamp of when the override was last modified.
          example: "2014-01-01T05:20:00.12345Z"
          format: date-time
          readOnly: true
          type: string
        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:
              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
              type: string
      type: object
    zones_schemas-api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/zones_messages'
        messages:
          $ref: '#/components/schemas/zones_messages'
        result:
          anyOf:
            - type: object
            - items: {}
              type: array
            - type: string
        success:
          description: Whether the API call was successful
          enum:
            - true
          example: true
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    zones_schemas-api-response-common-failure:
      properties:
        errors:
          allOf:
            - $ref: '#/components/schemas/zones_messages'
          example:
            - code: 7003
              message: No route for the URI
          minLength: 1
        messages:
          allOf:
            - $ref: '#/components/schemas/zones_messages'
          example: []
        result:
          enum:
            - 
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
            - false
          example: false
          type: boolean
      required:
        - success
        - errors
        - messages
        - result
      type: object
    zones_schemas-api-response-single-id:
      allOf:
        - $ref: '#/components/schemas/zones_schemas-api-response-common'
        - properties:
            result:
              nullable: true
              properties:
                id:
                  $ref: '#/components/schemas/zones_schemas-identifier'
              required:
                - id
              type: object
      type: object
    zones_schemas-automatic_platform_optimization:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - automatic_platform_optimization
              example: automatic_platform_optimization
            value:
              $ref: '#/components/schemas/zones_automatic_platform_optimization'
      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.'
      title: Automatic Platform Optimization for WordPress
    zones_schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    zones_schemas-modified_on:
      description: The timestamp of when the Page Rule was last modified.
      example: "2014-01-01T05:20:00.12345Z"
      format: date-time
      readOnly: true
      type: string
    zones_security_header:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone's security header.
              enum:
                - security_header
              example: security_header
            value:
              $ref: '#/components/schemas/zones_security_header_value'
      description: Cloudflare security header for a zone.
      title: Security Header
    zones_security_header_value:
      default:
        strict_transport_security:
          enabled: true
          include_subdomains: true
          max_age: 86400
          nosniff: true
          preload: false
      properties:
        strict_transport_security:
          description: Strict Transport Security.
          properties:
            enabled:
              description: Whether or not strict transport security is enabled.
              example: true
              type: boolean
            include_subdomains:
              description: Include all subdomains for strict transport security.
              example: true
              type: boolean
            max_age:
              description: Max age in seconds of the strict transport security.
              example: 86400
              type: number
            nosniff:
              description: 'Whether or not to include ''X-Content-Type-Options: nosniff'' header.'
              example: true
              type: boolean
            preload:
              description: Enable automatic preload of the HSTS configuration.
              example: true
              type: boolean
          type: object
      type: object
    zones_security_level:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - security_level
              example: security_level
            value:
              $ref: '#/components/schemas/zones_security_level_value'
      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).
      title: Security Level
    zones_security_level_value:
      default: medium
      description: Value of the zone setting.
      enum:
        - "off"
        - essentially_off
        - low
        - medium
        - high
        - under_attack
      type: string
    zones_server_side_exclude:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - server_side_exclude
              example: server_side_exclude
            value:
              $ref: '#/components/schemas/zones_server_side_exclude_value'
      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).'
      title: Server Side Exclude
    zones_server_side_exclude_value:
      default: "on"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_setting:
      oneOf:
        - $ref: '#/components/schemas/zones_0rtt'
        - $ref: '#/components/schemas/zones_advanced_ddos'
        - $ref: '#/components/schemas/zones_always_online'
        - $ref: '#/components/schemas/zones_always_use_https'
        - $ref: '#/components/schemas/zones_automatic_https_rewrites'
        - $ref: '#/components/schemas/zones_brotli'
        - $ref: '#/components/schemas/zones_browser_cache_ttl'
        - $ref: '#/components/schemas/zones_browser_check'
        - $ref: '#/components/schemas/zones_cache_level'
        - $ref: '#/components/schemas/zones_challenge_ttl'
        - $ref: '#/components/schemas/zones_ciphers'
        - $ref: '#/components/schemas/zones_cname_flattening'
        - $ref: '#/components/schemas/zones_development_mode'
        - $ref: '#/components/schemas/zones_early_hints'
        - $ref: '#/components/schemas/zones_edge_cache_ttl'
        - $ref: '#/components/schemas/zones_email_obfuscation'
        - $ref: '#/components/schemas/zones_h2_prioritization'
        - $ref: '#/components/schemas/zones_hotlink_protection'
        - $ref: '#/components/schemas/zones_http2'
        - $ref: '#/components/schemas/zones_http3'
        - $ref: '#/components/schemas/zones_image_resizing'
        - $ref: '#/components/schemas/zones_ip_geolocation'
        - $ref: '#/components/schemas/zones_ipv6'
        - $ref: '#/components/schemas/zones_max_upload'
        - $ref: '#/components/schemas/zones_min_tls_version'
        - $ref: '#/components/schemas/zones_mirage'
        - $ref: '#/components/schemas/zones_nel'
        - $ref: '#/components/schemas/zones_opportunistic_encryption'
        - $ref: '#/components/schemas/zones_opportunistic_onion'
        - $ref: '#/components/schemas/zones_orange_to_orange'
        - $ref: '#/components/schemas/zones_origin_error_page_pass_thru'
        - $ref: '#/components/schemas/zones_polish'
        - $ref: '#/components/schemas/zones_prefetch_preload'
        - $ref: '#/components/schemas/zones_proxy_read_timeout'
        - $ref: '#/components/schemas/zones_pseudo_ipv4'
        - $ref: '#/components/schemas/zones_replace_insecure_js'
        - $ref: '#/components/schemas/zones_response_buffering'
        - $ref: '#/components/schemas/zones_rocket_loader'
        - $ref: '#/components/schemas/zones_schemas-automatic_platform_optimization'
        - $ref: '#/components/schemas/zones_security_header'
        - $ref: '#/components/schemas/zones_security_level'
        - $ref: '#/components/schemas/zones_server_side_exclude'
        - $ref: '#/components/schemas/zones_sha1_support'
        - $ref: '#/components/schemas/zones_sort_query_string_for_cache'
        - $ref: '#/components/schemas/zones_ssl'
        - $ref: '#/components/schemas/zones_ssl_recommender'
        - $ref: '#/components/schemas/zones_tls_1_2_only'
        - $ref: '#/components/schemas/zones_tls_1_3'
        - $ref: '#/components/schemas/zones_tls_client_auth'
        - $ref: '#/components/schemas/zones_true_client_ip_header'
        - $ref: '#/components/schemas/zones_waf'
        - $ref: '#/components/schemas/zones_webp'
        - $ref: '#/components/schemas/zones_websockets'
      type: object
    zones_setting_name:
      description: Setting name
      example: always_online
      type: string
    zones_setting_readonly:
      enum:
        - false
      type: boolean
    zones_setting_toggle:
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_setting_writable:
      enum:
        - true
      type: boolean
    zones_settings:
      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: 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
      type: array
    zones_sha1_support:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: Zone setting identifier.
              enum:
                - sha1_support
              example: sha1_support
            value:
              $ref: '#/components/schemas/zones_sha1_support_value'
      description: Allow SHA1 support.
      title: Toggle SHA1 support
    zones_sha1_support_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "off"
        - "on"
      type: string
    zones_sort_query_string_for_cache:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - sort_query_string_for_cache
              example: sort_query_string_for_cache
            value:
              $ref: '#/components/schemas/zones_sort_query_string_for_cache_value'
      default: "off"
      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.
      title: Get String Sort
    zones_sort_query_string_for_cache_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_ssl:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - ssl
              example: ssl
            value:
              $ref: '#/components/schemas/zones_ssl_value'
      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).'
      title: SSL
    zones_ssl_recommender:
      allOf:
        - properties:
            enabled:
              $ref: '#/components/schemas/zones_ssl_recommender_enabled'
            id:
              description: Enrollment value for SSL/TLS Recommender.
              enum:
                - ssl_recommender
              example: ssl_recommender
      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.
      title: SSL/TLS Recommender
    zones_ssl_recommender_enabled:
      default: false
      description: ssl-recommender enrollment setting.
      type: boolean
    zones_ssl_value:
      default: "off"
      description: |-
        Value of the zone setting.
        Notes: Depends on the zone's plan level
      enum:
        - "off"
        - flexible
        - full
        - strict
      type: string
    zones_status:
      default: disabled
      description: The status of the Page Rule.
      enum:
        - active
        - disabled
      example: active
      type: string
    zones_string_constraint:
      description: String constraint.
      properties:
        operator:
          default: contains
          description: The matches operator can use asterisks and pipes as wildcard and 'or' operators.
          enum:
            - matches
            - contains
            - equals
            - not_equal
            - not_contain
        value:
          description: The value to apply the operator to.
          type: string
      required:
        - operator
        - value
      type: object
    zones_target:
      description: A request condition target.
      oneOf:
        - $ref: '#/components/schemas/zones_url_target'
      required:
        - target
        - constraint
    zones_targets:
      description: The rule targets to evaluate on each request.
      example:
        - constraint:
            operator: matches
            value: '*example.com/images/*'
          target: url
      items:
        $ref: '#/components/schemas/zones_target'
      type: array
    zones_tls_1_2_only:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: Zone setting identifier.
              enum:
                - tls_1_2_only
              example: tls_1_2_only
            value:
              $ref: '#/components/schemas/zones_tls_1_2_only_value'
      description: Only allows TLS1.2.
      title: TLS1.2 only
    zones_tls_1_2_only_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "off"
        - "on"
      type: string
    zones_tls_1_3:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - tls_1_3
              example: tls_1_3
            value:
              $ref: '#/components/schemas/zones_tls_1_3_value'
      default: "off"
      description: Enables Crypto TLS 1.3 feature for a zone.
      title: Enable TLS 1.3 value for a zone
    zones_tls_1_3_value:
      default: "off"
      description: |-
        Value of the zone setting.
        Notes: Default value depends on the zone's plan level.
      enum:
        - "on"
        - "off"
        - zrt
      type: string
    zones_tls_client_auth:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - tls_client_auth
              example: tls_client_auth
            value:
              $ref: '#/components/schemas/zones_tls_client_auth_value'
      description: TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).
      title: TLS Client Authentication
    zones_tls_client_auth_value:
      default: "on"
      description: value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_true_client_ip_header:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - true_client_ip_header
              example: true_client_ip_header
            value:
              $ref: '#/components/schemas/zones_true_client_ip_header_value'
      default: "off"
      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.
      title: True Client IP Header
    zones_true_client_ip_header_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_type:
      default: full
      description: |
        A full zone implies that DNS is hosted with Cloudflare. A partial zone is
        typically a partner-hosted zone or a CNAME setup.
      enum:
        - full
        - partial
        - secondary
      example: full
      type: string
    zones_url_target:
      description: URL target.
      properties:
        constraint:
          allOf:
            - $ref: '#/components/schemas/zones_string_constraint'
            - properties:
                value:
                  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: string
          description: The constraint of a target.
          type: object
        target:
          description: A target based on the URL of the request.
          enum:
            - url
          example: url
      type: object
    zones_vanity_name_servers:
      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:
        format: hostname
        maxLength: 253
        type: string
      type: array
    zones_waf:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - waf
              example: waf
            value:
              $ref: '#/components/schemas/zones_waf_value'
      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).
      title: Web Application Firewall
    zones_waf_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "on"
        - "off"
      type: string
    zones_webp:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - webp
              example: webp
            value:
              $ref: '#/components/schemas/zones_webp_value'
      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.
      title: Polish WebP Conversion
    zones_webp_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "off"
        - "on"
      type: string
    zones_websockets:
      allOf:
        - $ref: '#/components/schemas/zones_base'
        - properties:
            id:
              description: ID of the zone setting.
              enum:
                - websockets
              example: websockets
            value:
              $ref: '#/components/schemas/zones_websockets_value'
      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-).
      title: WebSockets
    zones_websockets_value:
      default: "off"
      description: Value of the zone setting.
      enum:
        - "off"
        - "on"
      type: string
    zones_zone:
      properties:
        account:
          description: The account the zone belongs to
          properties:
            id:
              $ref: '#/components/schemas/zones_identifier'
            name:
              description: The name of the account
              example: Example Account Name
              type: string
          type: object
        activated_on:
          description: |-
            The last time proof of ownership was detected and the zone was made
            active
          example: "2014-01-02T00:01:00.12345Z"
          format: date-time
          nullable: true
          readOnly: true
          type: string
        created_on:
          description: When the zone was created
          example: "2014-01-01T05:20:00.12345Z"
          format: date-time
          readOnly: true
          type: string
        development_mode:
          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
          type: number
        id:
          $ref: '#/components/schemas/zones_identifier'
        meta:
          description: Metadata about the zone
          properties:
            cdn_only:
              description: The zone is only configured for CDN
              example: true
              type: boolean
            custom_certificate_quota:
              description: Number of Custom Certificates the zone can have
              example: 1
              type: integer
            dns_only:
              description: The zone is only configured for DNS
              example: true
              type: boolean
            foundation_dns:
              description: The zone is setup with Foundation DNS
              example: true
              type: boolean
            page_rule_quota:
              description: Number of Page Rules a zone can have
              example: 100
              type: integer
            phishing_detected:
              description: The zone has been flagged for phishing
              example: false
              type: boolean
            step:
              example: 2
              type: integer
          type: object
        modified_on:
          description: When the zone was last modified
          example: "2014-01-01T05:20:00.12345Z"
          format: date-time
          readOnly: true
          type: string
        name:
          description: The domain name
          example: example.com
          maxLength: 253
          pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$
          type: string
        name_servers:
          description: The name servers Cloudflare assigns to a zone
          example:
            - bob.ns.cloudflare.com
            - lola.ns.cloudflare.com
          items:
            format: hostname
            type: string
          readOnly: true
          type: array
        original_dnshost:
          description: DNS host at the time of switching to Cloudflare
          example: NameCheap
          maxLength: 50
          nullable: true
          readOnly: true
          type: string
        original_name_servers:
          description: Original name servers before moving to Cloudflare
          example:
            - ns1.originaldnshost.com
            - ns2.originaldnshost.com
          items:
            format: hostname
            type: string
          nullable: true
          readOnly: true
          type: array
        original_registrar:
          description: Registrar for the domain at the time of switching to Cloudflare
          example: GoDaddy
          nullable: true
          readOnly: true
          type: string
        owner:
          description: The owner of the zone
          properties:
            id:
              $ref: '#/components/schemas/zones_identifier'
            name:
              description: Name of the owner
              example: Example Org
              type: string
            type:
              description: The type of owner
              example: organization
              type: string
          type: object
        paused:
          $ref: '#/components/schemas/zones_paused'
        status:
          description: The zone status on Cloudflare.
          enum:
            - initializing
            - pending
            - active
            - moved
          example: active
          readOnly: true
          type: string
        type:
          $ref: '#/components/schemas/zones_type'
        vanity_name_servers:
          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:
            format: hostname
            maxLength: 253
            type: string
          type: array
      required:
        - id
        - name
        - development_mode
        - owner
        - account
        - meta
        - name_servers
        - original_name_servers
        - original_registrar
        - original_dnshost
        - created_on
        - modified_on
        - activated_on
      type: object
    zones_zone_settings_response_collection:
      allOf:
        - $ref: '#/components/schemas/zones_api-response-common'
        - properties:
            result:
              items:
                anyOf:
                  - $ref: '#/components/schemas/zones_0rtt'
                  - $ref: '#/components/schemas/zones_advanced_ddos'
                  - $ref: '#/components/schemas/zones_always_online'
                  - $ref: '#/components/schemas/zones_always_use_https'
                  - $ref: '#/components/schemas/zones_automatic_https_rewrites'
                  - $ref: '#/components/schemas/zones_brotli'
                  - $ref: '#/components/schemas/zones_browser_cache_ttl'
                  - $ref: '#/components/schemas/zones_browser_check'
                  - $ref: '#/components/schemas/zones_cache_level'
                  - $ref: '#/components/schemas/zones_challenge_ttl'
                  - $ref: '#/components/schemas/zones_ciphers'
                  - $ref: '#/components/schemas/zones_cname_flattening'
                  - $ref: '#/components/schemas/zones_development_mode'
                  - $ref: '#/components/schemas/zones_early_hints'
                  - $ref: '#/components/schemas/zones_edge_cache_ttl'
                  - $ref: '#/components/schemas/zones_email_obfuscation'
                  - $ref: '#/components/schemas/zones_h2_prioritization'
                  - $ref: '#/components/schemas/zones_hotlink_protection'
                  - $ref: '#/components/schemas/zones_http2'
                  - $ref: '#/components/schemas/zones_http3'
                  - $ref: '#/components/schemas/zones_image_resizing'
                  - $ref: '#/components/schemas/zones_ip_geolocation'
                  - $ref: '#/components/schemas/zones_ipv6'
                  - $ref: '#/components/schemas/zones_max_upload'
                  - $ref: '#/components/schemas/zones_min_tls_version'
                  - $ref: '#/components/schemas/zones_mirage'
                  - $ref: '#/components/schemas/zones_nel'
                  - $ref: '#/components/schemas/zones_opportunistic_encryption'
                  - $ref: '#/components/schemas/zones_opportunistic_onion'
                  - $ref: '#/components/schemas/zones_orange_to_orange'
                  - $ref: '#/components/schemas/zones_origin_error_page_pass_thru'
                  - $ref: '#/components/schemas/zones_polish'
                  - $ref: '#/components/schemas/zones_prefetch_preload'
                  - $ref: '#/components/schemas/zones_proxy_read_timeout'
                  - $ref: '#/components/schemas/zones_pseudo_ipv4'
                  - $ref: '#/components/schemas/zones_replace_insecure_js'
                  - $ref: '#/components/schemas/zones_response_buffering'
                  - $ref: '#/components/schemas/zones_rocket_loader'
                  - $ref: '#/components/schemas/zones_schemas-automatic_platform_optimization'
                  - $ref: '#/components/schemas/zones_security_header'
                  - $ref: '#/components/schemas/zones_security_level'
                  - $ref: '#/components/schemas/zones_server_side_exclude'
                  - $ref: '#/components/schemas/zones_sha1_support'
                  - $ref: '#/components/schemas/zones_sort_query_string_for_cache'
                  - $ref: '#/components/schemas/zones_ssl'
                  - $ref: '#/components/schemas/zones_ssl_recommender'
                  - $ref: '#/components/schemas/zones_tls_1_2_only'
                  - $ref: '#/components/schemas/zones_tls_1_3'
                  - $ref: '#/components/schemas/zones_tls_client_auth'
                  - $ref: '#/components/schemas/zones_true_client_ip_header'
                  - $ref: '#/components/schemas/zones_waf'
                  - $ref: '#/components/schemas/zones_webp'
                  - $ref: '#/components/schemas/zones_websockets'
              type: array
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey
info:
  description: |-
    To get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.

    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.

    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. 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
  title: APIs.io Engineering Platform Cloudflare API
  version: 4.0.0
openapi: 3.0.3
paths:
  /accounts:
    get:
      description: List all accounts you have ownership or verified access to.
      operationId: accounts-list-accounts
      parameters:
        - in: query
          name: name
          schema:
            description: Name of the account.
            example: example.com
            readOnly: true
            type: string
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 20
            description: Maximum number of results per page.
            maximum: 50
            minimum: 5
            type: number
        - in: query
          name: direction
          schema:
            description: Direction to order results.
            enum:
              - asc
              - desc
            example: desc
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Accounts response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_response_collection_accounts'
          description: List Accounts response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Accounts
      tags:
        - Accounts
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Create an account (only available for tenant admins at this time)
      operationId: account-creation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/iam_create-account'
        description: Parameters for account creation
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Account Creation Failure Response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_response_single_account'
          description: Account Creation Success Response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create an account
      tags:
        - Accounts
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: false
        free: false
        pro: false
  /accounts/{account_id}:
    delete:
      description: Delete a specific account (only available for tenant admins at this time). This is a permanent operation that will delete any zones or other resources under the account
      operationId: account-deletion
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            description: The account ID of the account to be deleted
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Account Deletion Failure Response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-single-id'
          description: Account Deletion Success Response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a specific account
      tags:
        - Accounts
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: false
        free: false
        pro: false
    get:
      description: Get information about a specific account that you are a member of.
      operationId: accounts-account-details
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Account Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_response_single_account'
          description: Account Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Account Details
      tags:
        - Accounts
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Update an existing account.
      operationId: accounts-update-account
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/iam_components-schemas-account'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Update Account response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_response_single_account'
          description: Update Account response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Account
      tags:
        - Accounts
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/access/apps:
    get:
      description: Lists all Access applications in an account.
      operationId: access-applications-list-access-applications
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List Access applications response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_apps_components-schemas-response_collection'
          description: List Access applications response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Access applications
      tags:
        - Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Revoke'
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    post:
      description: Adds a new application to Access.
      operationId: access-applications-add-an-application
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_app_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Add an Access application response failure
        "201":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/access_apps_components-schemas-single_response'
                  - properties:
                      result:
                        $ref: '#/components/schemas/access_app_response'
          description: Add an Access application response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Add an Access application
      tags:
        - Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /accounts/{account_id}/access/apps/{app_id}:
    delete:
      description: Deletes an application from Access.
      operationId: access-applications-delete-an-access-application
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_app_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete an Access application response failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
          description: Delete an Access application response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an Access application
      tags:
        - Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Write'
    get:
      description: Fetches information about an Access application.
      operationId: access-applications-get-an-access-application
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_app_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get an Access application response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_apps_components-schemas-single_response'
          description: Get an Access application response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an Access application
      tags:
        - Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    put:
      description: Updates an Access application.
      operationId: access-applications-update-an-access-application
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_app_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_app_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update an Access application response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/access_apps_components-schemas-single_response'
                  - properties:
                      result:
                        $ref: '#/components/schemas/access_app_response'
          description: Update an Access application response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an Access application
      tags:
        - Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /accounts/{account_id}/access/apps/{app_id}/ca:
    delete:
      description: Deletes a short-lived certificate CA.
      operationId: access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete a short-lived certificate CA response failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_schemas-id_response'
          description: Delete a short-lived certificate CA response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a short-lived certificate CA
      tags:
        - Access Short-Lived Certificate CAs
      x-api-token-group:
        - 'Access: Apps and Policies Write'
    get:
      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:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get a short-lived certificate CA response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_ca_components-schemas-single_response'
          description: Get a short-lived certificate CA response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a short-lived certificate CA
      tags:
        - Access Short-Lived Certificate CAs
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    post:
      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:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create a short-lived certificate CA response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_ca_components-schemas-single_response'
          description: Create a short-lived certificate CA response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a short-lived certificate CA
      tags:
        - Access Short-Lived Certificate CAs
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /accounts/{account_id}/access/apps/{app_id}/policies:
    get:
      description: Lists Access policies configured for an application. Returns both exclusively scoped and reusable policies used by the application.
      operationId: access-policies-list-access-app-policies
      parameters:
        - description: The application ID.
          in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List Access application policies response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_app-policies_components-schemas-response_collection'
          description: List Access application policies response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Access application policies
      tags:
        - Access Application-Scoped Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    post:
      description: Creates a policy applying exclusive to a single application that defines the users or groups who can reach it. We recommend creating a reusable policy instead and subsequently referencing its ID in the application's 'policies' array.
      operationId: access-policies-create-an-access-policy
      parameters:
        - description: The application ID.
          in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_app_policy_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create an Access application policy response failure.
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_app-policies_components-schemas-single_response'
          description: Create an Access application policy response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create an Access application policy
      tags:
        - Access Application-Scoped Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /accounts/{account_id}/access/apps/{app_id}/policies/{policy_id}:
    delete:
      description: Deletes an Access policy specific to an application. To delete a reusable policy, use the /accounts/{account_id}/policies/{uid} endpoint.
      operationId: access-policies-delete-an-access-policy
      parameters:
        - description: The application ID.
          in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - description: The policy ID.
          in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete an Access application policy response failure.
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
          description: Delete an Access application policy response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an Access application policy
      tags:
        - Access Application-Scoped Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
    get:
      description: Fetches a single Access policy configured for an application. Returns both exclusively owned and reusable policies used by the application.
      operationId: access-policies-get-an-access-policy
      parameters:
        - description: The application ID.
          in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - description: The policy ID.
          in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get an Access policy response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_app-policies_components-schemas-single_response'
          description: Get an Access policy response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an Access application policy
      tags:
        - Access Application-Scoped Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    put:
      description: Updates an Access policy specific to an application. To update a reusable policy, use the /accounts/{account_id}/policies/{uid} endpoint.
      operationId: access-policies-update-an-access-policy
      parameters:
        - description: The application ID.
          in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - description: The policy ID.
          in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_app_policy_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update an Access application policy response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_app-policies_components-schemas-single_response'
          description: Update an Access application policy response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an Access application policy
      tags:
        - Access Application-Scoped Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /accounts/{account_id}/access/apps/{app_id}/revoke_tokens:
    post:
      description: Revokes all tokens issued for an application.
      operationId: access-applications-revoke-service-tokens
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_app_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Revoke application tokens response failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_schemas-empty_response'
          description: Revoke application tokens response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Revoke application tokens
      tags:
        - Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Revoke'
        - 'Access: Apps and Policies Write'
  /accounts/{account_id}/access/apps/{app_id}/user_policy_checks:
    get:
      description: Tests if a specific user has permission to access an application.
      operationId: access-applications-test-access-policies
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_app_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Test Access policies response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_policy_check_response'
          description: Test Access policies response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Test Access policies
      tags:
        - Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
  /accounts/{account_id}/access/apps/ca:
    get:
      description: Lists short-lived certificate CAs and their public keys.
      operationId: access-short-lived-certificate-c-as-list-short-lived-certificate-c-as
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List short-lived certificate CAs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_ca_components-schemas-response_collection'
          description: List short-lived certificate CAs response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List short-lived certificate CAs
      tags:
        - Access Short-Lived Certificate CAs
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
  /accounts/{account_id}/access/bookmarks:
    get:
      deprecated: true
      description: Lists Bookmark applications.
      operationId: access-bookmark-applications-(-deprecated)-list-bookmark-applications
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List Bookmark applications response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_bookmarks_components-schemas-response_collection'
          description: List Bookmark applications response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Bookmark applications
      tags:
        - Access Bookmark Applications (Deprecated)
      x-api-token-group:
        - 'Access: Apps and Policies Revoke'
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of using a specialized Access Application App Type.
        display: true
        eol: "2023-03-19"
        id: bookmarks_deprecation
  /accounts/{account_id}/access/bookmarks/{bookmark_id}:
    delete:
      deprecated: true
      description: Deletes a Bookmark application.
      operationId: access-bookmark-applications-(-deprecated)-delete-a-bookmark-application
      parameters:
        - in: path
          name: bookmark_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_components-schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete a Bookmark application response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
          description: Delete a Bookmark application response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a Bookmark application
      tags:
        - Access Bookmark Applications (Deprecated)
      x-api-token-group:
        - 'Access: Apps and Policies Write'
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of using a specialized Access Application App Type.
        display: true
        eol: "2023-03-19"
        id: bookmarks_deprecation
    get:
      deprecated: true
      description: Fetches a single Bookmark application.
      operationId: access-bookmark-applications-(-deprecated)-get-a-bookmark-application
      parameters:
        - in: path
          name: bookmark_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get a Bookmark application response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_bookmarks_components-schemas-single_response'
          description: Get a Bookmark application response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a Bookmark application
      tags:
        - Access Bookmark Applications (Deprecated)
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of using a specialized Access Application App Type.
        display: true
        eol: "2023-03-19"
        id: bookmarks_deprecation
    post:
      deprecated: true
      description: Create a new Bookmark application.
      operationId: access-bookmark-applications-(-deprecated)-create-a-bookmark-application
      parameters:
        - in: path
          name: bookmark_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_components-schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create a Bookmark application response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_bookmarks_components-schemas-single_response'
          description: Create a Bookmark application response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a Bookmark application
      tags:
        - Access Bookmark Applications (Deprecated)
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of using a specialized Access Application App Type.
        display: true
        eol: "2023-03-19"
        id: bookmarks_deprecation
    put:
      deprecated: true
      description: Updates a configured Bookmark application.
      operationId: access-bookmark-applications-(-deprecated)-update-a-bookmark-application
      parameters:
        - in: path
          name: bookmark_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_components-schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update a Bookmark application response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_bookmarks_components-schemas-single_response'
          description: Update a Bookmark application response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a Bookmark application
      tags:
        - Access Bookmark Applications (Deprecated)
      x-api-token-group:
        - 'Access: Apps and Policies Write'
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of using a specialized Access Application App Type.
        display: true
        eol: "2023-03-19"
        id: bookmarks_deprecation
  /accounts/{account_id}/access/certificates:
    get:
      description: Lists all mTLS root certificates.
      operationId: access-mtls-authentication-list-mtls-certificates
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List mTLS certificates response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-response_collection'
          description: List mTLS certificates response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List mTLS certificates
      tags:
        - Access mTLS Authentication
      x-api-token-group:
        - 'Access: Certificates Write'
        - 'Access: Certificates Read'
    post:
      description: Adds a new mTLS root certificate to Access.
      operationId: access-mtls-authentication-add-an-mtls-certificate
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                associated_hostnames:
                  $ref: '#/components/schemas/access_associated_hostnames'
                certificate:
                  description: The certificate content.
                  example: |-
                    -----BEGIN CERTIFICATE-----
                    MIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10
                    DrUtmu/B
                    -----END CERTIFICATE-----
                  type: string
                name:
                  $ref: '#/components/schemas/access_certificates_components-schemas-name'
              required:
                - name
                - certificate
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Add an mTLS certificate response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-single_response'
          description: Add an mTLS certificate response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Add an mTLS certificate
      tags:
        - Access mTLS Authentication
      x-api-token-group:
        - 'Access: Certificates Write'
  /accounts/{account_id}/access/certificates/{certificate_id}:
    delete:
      description: Deletes an mTLS certificate.
      operationId: access-mtls-authentication-delete-an-mtls-certificate
      parameters:
        - in: path
          name: certificate_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete an mTLS certificate response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_components-schemas-id_response'
          description: Delete an mTLS certificate response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an mTLS certificate
      tags:
        - Access mTLS Authentication
      x-api-token-group:
        - 'Access: Certificates Write'
    get:
      description: Fetches a single mTLS certificate.
      operationId: access-mtls-authentication-get-an-mtls-certificate
      parameters:
        - in: path
          name: certificate_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get an mTLS certificate response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-single_response'
          description: Get an mTLS certificate response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an mTLS certificate
      tags:
        - Access mTLS Authentication
      x-api-token-group:
        - 'Access: Certificates Write'
        - 'Access: Certificates Read'
    put:
      description: Updates a configured mTLS certificate.
      operationId: access-mtls-authentication-update-an-mtls-certificate
      parameters:
        - in: path
          name: certificate_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                associated_hostnames:
                  $ref: '#/components/schemas/access_associated_hostnames'
                name:
                  $ref: '#/components/schemas/access_certificates_components-schemas-name'
              required:
                - associated_hostnames
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update an mTLS certificate response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-single_response'
          description: Update an mTLS certificate response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an mTLS certificate
      tags:
        - Access mTLS Authentication
      x-api-token-group:
        - 'Access: Certificates Write'
  /accounts/{account_id}/access/certificates/settings:
    get:
      description: List all mTLS hostname settings for this account.
      operationId: access-mtls-authentication-list-mtls-certificates-hostname-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List mTLS hostname settings response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_response_collection_hostnames'
          description: List mTLS hostname settings response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List all mTLS hostname settings
      tags:
        - Access mTLS Authentication
      x-api-token-group:
        - 'Access: Certificates Write'
        - 'Access: Certificates Read'
    put:
      description: Updates an mTLS certificate's hostname settings.
      operationId: access-mtls-authentication-update-an-mtls-certificate-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                settings:
                  items:
                    $ref: '#/components/schemas/access_settings'
                  type: array
              required:
                - settings
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update an mTLS certificates hostname settings failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_response_collection_hostnames'
          description: Update an mTLS certificates hostname settings response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an mTLS certificate's hostname settings
      tags:
        - Access mTLS Authentication
      x-api-token-group:
        - 'Access: Certificates Write'
  /accounts/{account_id}/access/custom_pages:
    get:
      description: List custom pages
      operationId: access-custom-pages-list-custom-pages
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List custom pages response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_custom-pages_components-schemas-response_collection'
          description: List custom pages response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List custom pages
      tags:
        - Access Custom Pages
      x-api-token-group:
        - 'Access: Custom Page Write'
        - 'Access: Custom Page Read'
    post:
      description: Create a custom page
      operationId: access-custom-pages-create-a-custom-page
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_custom_page'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create a custom page response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_single_response_without_html'
          description: Create a custom page response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a custom page
      tags:
        - Access Custom Pages
      x-api-token-group:
        - 'Access: Custom Page Write'
  /accounts/{account_id}/access/custom_pages/{custom_page_id}:
    delete:
      description: Delete a custom page
      operationId: access-custom-pages-delete-a-custom-page
      parameters:
        - in: path
          name: custom_page_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete a custom page response failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_components-schemas-id_response'
          description: Delete a custom page response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a custom page
      tags:
        - Access Custom Pages
      x-api-token-group:
        - 'Access: Custom Page Write'
    get:
      description: Fetches a custom page and also returns its HTML.
      operationId: access-custom-pages-get-a-custom-page
      parameters:
        - in: path
          name: custom_page_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get a custom page response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_custom-pages_components-schemas-single_response'
          description: Get a custom page response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a custom page
      tags:
        - Access Custom Pages
      x-api-token-group:
        - 'Access: Custom Page Write'
        - 'Access: Custom Page Read'
    put:
      description: Update a custom page
      operationId: access-custom-pages-update-a-custom-page
      parameters:
        - in: path
          name: custom_page_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_custom_page'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update a custom page response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_single_response_without_html'
          description: Update a custom page response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a custom page
      tags:
        - Access Custom Pages
      x-api-token-group:
        - 'Access: Custom Page Write'
  /accounts/{account_id}/access/groups:
    get:
      description: Lists all Access groups.
      operationId: access-groups-list-access-groups
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List Access groups response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_schemas-response_collection'
          description: List Access groups response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Access groups
      tags:
        - Access Groups
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
        - 'Access: Organizations, Identity Providers, and Groups Read'
    post:
      description: Creates a new Access group.
      operationId: access-groups-create-an-access-group
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                exclude:
                  $ref: '#/components/schemas/access_exclude'
                include:
                  $ref: '#/components/schemas/access_include'
                is_default:
                  $ref: '#/components/schemas/access_is_default'
                name:
                  $ref: '#/components/schemas/access_groups_components-schemas-name'
                require:
                  $ref: '#/components/schemas/access_require'
              required:
                - name
                - include
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create an Access group response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_groups_components-schemas-single_response'
          description: Create an Access group response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create an Access group
      tags:
        - Access Groups
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
  /accounts/{account_id}/access/groups/{group_id}:
    delete:
      description: Deletes an Access group.
      operationId: access-groups-delete-an-access-group
      parameters:
        - in: path
          name: group_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete an Access group response failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
          description: Delete an Access group response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an Access group
      tags:
        - Access Groups
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
    get:
      description: Fetches a single Access group.
      operationId: access-groups-get-an-access-group
      parameters:
        - in: path
          name: group_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get an Access group response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_groups_components-schemas-single_response'
          description: Get an Access group response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an Access group
      tags:
        - Access Groups
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
        - 'Access: Organizations, Identity Providers, and Groups Read'
    put:
      description: Updates a configured Access group.
      operationId: access-groups-update-an-access-group
      parameters:
        - in: path
          name: group_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                exclude:
                  $ref: '#/components/schemas/access_exclude'
                include:
                  $ref: '#/components/schemas/access_include'
                is_default:
                  $ref: '#/components/schemas/access_is_default'
                name:
                  $ref: '#/components/schemas/access_groups_components-schemas-name'
                require:
                  $ref: '#/components/schemas/access_require'
              required:
                - name
                - include
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update an Access group response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_groups_components-schemas-single_response'
          description: Update an Access group response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an Access group
      tags:
        - Access Groups
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
  /accounts/{account_id}/access/identity_providers:
    get:
      description: Lists all configured identity providers.
      operationId: access-identity-providers-list-access-identity-providers
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List Access identity providers response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_response_collection'
          description: List Access identity providers response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Access identity providers
      tags:
        - Access Identity Providers
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
        - 'Access: Organizations, Identity Providers, and Groups Read'
    post:
      description: Adds a new identity provider to Access.
      operationId: access-identity-providers-add-an-access-identity-provider
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_identity-providers'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Add an Access identity provider response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_components-schemas-single_response'
          description: Add an Access identity provider response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Add an Access identity provider
      tags:
        - Access Identity Providers
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
  /accounts/{account_id}/access/identity_providers/{identity_provider_id}:
    delete:
      description: Deletes an identity provider from Access.
      operationId: access-identity-providers-delete-an-access-identity-provider
      parameters:
        - in: path
          name: identity_provider_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete an Access identity provider response failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
          description: Delete an Access identity provider response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an Access identity provider
      tags:
        - Access Identity Providers
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
    get:
      description: Fetches a configured identity provider.
      operationId: access-identity-providers-get-an-access-identity-provider
      parameters:
        - in: path
          name: identity_provider_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get an Access identity provider response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_components-schemas-single_response'
          description: Get an Access identity provider response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an Access identity provider
      tags:
        - Access Identity Providers
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
        - 'Access: Organizations, Identity Providers, and Groups Read'
    put:
      description: Updates a configured identity provider.
      operationId: access-identity-providers-update-an-access-identity-provider
      parameters:
        - in: path
          name: identity_provider_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_identity-providers'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update an Access identity provider response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_components-schemas-single_response'
          description: Update an Access identity provider response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an Access identity provider
      tags:
        - Access Identity Providers
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
  /accounts/{account_id}/access/keys:
    get:
      description: Gets the Access key rotation settings for an account.
      operationId: access-key-configuration-get-the-access-key-configuration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get the Access key configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_keys_components-schemas-single_response'
          description: Get the Access key configuration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get the Access key configuration
      tags:
        - Access Key Configuration
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
        - 'Access: Organizations, Identity Providers, and Groups Read'
    put:
      description: Updates the Access key rotation settings for an account.
      operationId: access-key-configuration-update-the-access-key-configuration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                key_rotation_interval_days:
                  $ref: '#/components/schemas/access_key_rotation_interval_days'
              required:
                - key_rotation_interval_days
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update the Access key configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_keys_components-schemas-single_response'
          description: Update the Access key configuration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update the Access key configuration
      tags:
        - Access Key Configuration
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
  /accounts/{account_id}/access/keys/rotate:
    post:
      description: Perfoms a key rotation for an account.
      operationId: access-key-configuration-rotate-access-keys
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Rotate Access keys response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_keys_components-schemas-single_response'
          description: Rotate Access keys response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Rotate Access keys
      tags:
        - Access Key Configuration
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
  /accounts/{account_id}/access/logs/access_requests:
    get:
      description: Gets a list of Access authentication audit logs for an account.
      operationId: access-authentication-logs-get-access-authentication-logs
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
        - description: The maximum number of log entries to retrieve.
          example: 25
          in: query
          name: limit
          schema:
            default: 25
            type: integer
        - description: The chronological sorting order for the logs.
          example: desc
          in: query
          name: direction
          schema:
            default: desc
            enum:
              - desc
              - asc
        - description: The earliest event timestamp to query.
          in: query
          name: since
          schema:
            example: "2020-07-01T05:20:00Z"
            format: date-time
            type: string
        - description: The latest event timestamp to query.
          in: query
          name: until
          schema:
            example: "2020-10-01T05:20:00Z"
            format: date-time
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get Access authentication logs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_access-requests_components-schemas-response_collection'
          description: Get Access authentication logs response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Access authentication logs
      tags:
        - Access Authentication Logs
      x-api-token-group:
        - 'Access: Audit Logs Read'
  /accounts/{account_id}/access/organizations:
    get:
      description: Returns the configuration for your Zero Trust organization.
      operationId: zero-trust-organization-get-your-zero-trust-organization
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get your Zero Trust organization response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_single_response'
          description: Get your Zero Trust organization response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get your Zero Trust organization
      tags:
        - Zero Trust Organization
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Revoke'
        - 'Access: Organizations, Identity Providers, and Groups Write'
        - 'Access: Organizations, Identity Providers, and Groups Read'
    post:
      description: Sets up a Zero Trust organization for your account.
      operationId: zero-trust-organization-create-your-zero-trust-organization
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                allow_authenticate_via_warp:
                  $ref: '#/components/schemas/access_allow_authenticate_via_warp'
                auth_domain:
                  $ref: '#/components/schemas/access_auth_domain'
                auto_redirect_to_identity:
                  $ref: '#/components/schemas/access_auto_redirect_to_identity'
                is_ui_read_only:
                  $ref: '#/components/schemas/access_is_ui_read_only'
                login_design:
                  $ref: '#/components/schemas/access_login_design'
                name:
                  $ref: '#/components/schemas/access_name'
                session_duration:
                  $ref: '#/components/schemas/access_session_duration'
                ui_read_only_toggle_reason:
                  $ref: '#/components/schemas/access_ui_read_only_toggle_reason'
                user_seat_expiration_inactive_time:
                  $ref: '#/components/schemas/access_user_seat_expiration_inactive_time'
                warp_auth_session_duration:
                  $ref: '#/components/schemas/access_warp_auth_session_duration'
              required:
                - name
                - auth_domain
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create your Zero Trust organization response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_single_response'
          description: Create your Zero Trust organization response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create your Zero Trust organization
      tags:
        - Zero Trust Organization
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
    put:
      description: Updates the configuration for your Zero Trust organization.
      operationId: zero-trust-organization-update-your-zero-trust-organization
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                allow_authenticate_via_warp:
                  $ref: '#/components/schemas/access_allow_authenticate_via_warp'
                auth_domain:
                  $ref: '#/components/schemas/access_auth_domain'
                auto_redirect_to_identity:
                  $ref: '#/components/schemas/access_auto_redirect_to_identity'
                custom_pages:
                  $ref: '#/components/schemas/access_custom_pages'
                is_ui_read_only:
                  $ref: '#/components/schemas/access_is_ui_read_only'
                login_design:
                  $ref: '#/components/schemas/access_login_design'
                name:
                  $ref: '#/components/schemas/access_name'
                session_duration:
                  $ref: '#/components/schemas/access_session_duration'
                ui_read_only_toggle_reason:
                  $ref: '#/components/schemas/access_ui_read_only_toggle_reason'
                user_seat_expiration_inactive_time:
                  $ref: '#/components/schemas/access_user_seat_expiration_inactive_time'
                warp_auth_session_duration:
                  $ref: '#/components/schemas/access_warp_auth_session_duration'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update your Zero Trust organization response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_single_response'
          description: Update your Zero Trust organization response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update your Zero Trust organization
      tags:
        - Zero Trust Organization
      x-api-token-group:
        - 'Access: Organizations, Identity Providers, and Groups Write'
  /accounts/{account_id}/access/organizations/doh:
    get:
      description: Returns the DoH settings for your Zero Trust organization.
      operationId: zero-trust-organization-get-your-zero-trust-organization-doh-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get your Zero Trust organization DoH settings response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/access_schemas-single_response'
                  - properties:
                      result:
                        properties:
                          jwt_duration:
                            description: 'The duration the DoH JWT is valid for. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.  Note that the maximum duration for this setting is the same as the key rotation period on the account.'
                            example: 800h
                            type: string
          description: Get your Zero Trust organization DoH settings response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get your Zero Trust organization DoH settings
      tags:
        - Zero Trust Organization
    put:
      description: Updates the DoH settings for your Zero Trust organization.
      operationId: zero-trust-organization-update-your-zero-trust-organization-doh-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                jwt_duration:
                  $ref: '#/components/schemas/access_doh_jwt_duration'
                service_token_id:
                  description: The uuid of the service token you want to use for DoH authentication
                  example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
                  type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update your Zero Trust organization DoH settings response failure
        "201":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/access_schemas-single_response'
                  - properties:
                      result:
                        properties:
                          jwt_duration:
                            $ref: '#/components/schemas/access_doh_jwt_duration'
          description: Update your Zero Trust organization DoH settings response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update your Zero Trust organization DoH settings
      tags:
        - Zero Trust Organization
  /accounts/{account_id}/access/organizations/revoke_user:
    post:
      description: Revokes a user's access across all applications.
      operationId: zero-trust-organization-revoke-all-access-tokens-for-a-user
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                email:
                  description: The email of the user to revoke.
                  example: test@example.com
                  type: string
              required:
                - email
        required: true
      responses:
        4xx:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Revoke all Access tokens for a user response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_empty_response'
          description: Revoke all Access tokens for a user response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Revoke all Access tokens for a user
      tags:
        - Zero Trust Organization
  /accounts/{account_id}/access/policies:
    get:
      description: Lists Access reusable policies.
      operationId: access-policies-list-access-reusable-policies
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List Access reusable policies response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_reusable-policies_components-schemas-response_collection'
          description: List Access reusable policies response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Access reusable policies
      tags:
        - Access Reusable Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    post:
      description: Creates a new Access reusable policy.
      operationId: access-policies-create-an-access-reusable-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_policy_req'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create an Access reusable policy response failure.
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_reusable-policies_components-schemas-single_response'
          description: Create an Access reusable policy response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create an Access reusable policy
      tags:
        - Access Reusable Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /accounts/{account_id}/access/policies/{policy_id}:
    delete:
      description: Deletes an Access reusable policy.
      operationId: access-policies-delete-an-access-reusable-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/access_schemas-uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete an Access reusable policy response failure.
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_reusable-policies_components-schemas-id_response'
          description: Delete an Access reusable policy response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an Access reusable policy
      tags:
        - Access Reusable Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
    get:
      description: Fetches a single Access reusable policy.
      operationId: access-policies-get-an-access-reusable-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/access_schemas-uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get an Access reusable policy response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_reusable-policies_components-schemas-single_response'
          description: Get an Access reusable policy response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an Access reusable policy
      tags:
        - Access Reusable Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    put:
      description: Updates a Access reusable policy.
      operationId: access-policies-update-an-access-reusable-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/access_schemas-uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_policy_req'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update an Access reusable policy response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_reusable-policies_components-schemas-single_response'
          description: Update an Access reusable policy response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an Access reusable policy
      tags:
        - Access Reusable Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /accounts/{account_id}/access/policy-tests:
    post:
      description: Starts an Access policy test.
      operationId: access-policy-tests
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_policy_resp'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_policy_init_resp'
          description: Start Access policy test response.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Start Access policy test response failure.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Start Access policy test
      tags:
        - Access Policy Tester
  /accounts/{account_id}/access/policy-tests/{policy_test_id}:
    get:
      description: Fetches the current status of a given Access policy test.
      operationId: access-policy-tests-get-an-update
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
        - in: path
          name: policy_test_id
          required: true
          schema:
            $ref: '#/components/schemas/access_policy_test_id'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_policy_update_resp'
          description: Get an Access policy test update response.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get an Access policy test update response failure.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get the current status of a given Access policy test
      tags:
        - Access Policy Tester
  /accounts/{account_id}/access/policy-tests/{policy_test_id}/users:
    get:
      description: Fetches a single page of user results from an Access policy test.
      operationId: access-policy-tests-get-a-user-page
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
        - in: path
          name: policy_test_id
          required: true
          schema:
            $ref: '#/components/schemas/access_policy_test_id'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_policy_users_resp'
          description: Get an Access policy tester users page response.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get an Access policy tester users page response failure.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an Access policy test users page
      tags:
        - Access Policy Tester
  /accounts/{account_id}/access/seats:
    patch:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_seats_definition'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update a user seat response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_seats_components-schemas-response_collection'
          description: Update a user seat response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a user seat
      tags:
        - Zero Trust Seats
      x-api-token-group:
        - 'Zero Trust: Seats Write'
  /accounts/{account_id}/access/service_tokens:
    get:
      description: Lists all service tokens.
      operationId: access-service-tokens-list-service-tokens
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List service tokens response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_components-schemas-response_collection'
          description: List service tokens response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List service tokens
      tags:
        - Access Service Tokens
      x-api-token-group:
        - 'Access: Service Tokens Write'
        - 'Access: Service Tokens Read'
    post:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                duration:
                  $ref: '#/components/schemas/access_duration'
                name:
                  $ref: '#/components/schemas/access_schemas-name'
              required:
                - name
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create a service token response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_create_response'
          description: Create a service token response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a service token
      tags:
        - Access Service Tokens
      x-api-token-group:
        - 'Access: Service Tokens Write'
  /accounts/{account_id}/access/service_tokens/{service_token_id}:
    delete:
      description: Deletes a service token.
      operationId: access-service-tokens-delete-a-service-token
      parameters:
        - in: path
          name: service_token_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete a service token response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_schemas-single_response'
          description: Delete a service token response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a service token
      tags:
        - Access Service Tokens
      x-api-token-group:
        - 'Access: Service Tokens Write'
    get:
      description: Fetches a single service token.
      operationId: access-service-tokens-get-a-service-token
      parameters:
        - in: path
          name: service_token_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get a service token response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_schemas-single_response'
          description: Get a service token response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a service token
      tags:
        - Access Service Tokens
      x-api-token-group:
        - 'Access: Service Tokens Write'
        - 'Access: Service Tokens Read'
    put:
      description: Updates a configured service token.
      operationId: access-service-tokens-update-a-service-token
      parameters:
        - in: path
          name: service_token_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                duration:
                  $ref: '#/components/schemas/access_duration'
                name:
                  $ref: '#/components/schemas/access_schemas-name'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update a service token response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_schemas-single_response'
          description: Update a service token response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a service token
      tags:
        - Access Service Tokens
      x-api-token-group:
        - 'Access: Service Tokens Write'
  /accounts/{account_id}/access/service_tokens/{service_token_id}/refresh:
    post:
      description: Refreshes the expiration of a service token.
      operationId: access-service-tokens-refresh-a-service-token
      parameters:
        - in: path
          name: service_token_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Refresh a service token response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_schemas-single_response'
          description: Refresh a service token response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Refresh a service token
      tags:
        - Access Service Tokens
      x-api-token-group:
        - 'Access: Service Tokens Write'
  /accounts/{account_id}/access/service_tokens/{service_token_id}/rotate:
    post:
      description: Generates a new Client Secret for a service token and revokes the old one.
      operationId: access-service-tokens-rotate-a-service-token
      parameters:
        - in: path
          name: service_token_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Rotate a service token response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_create_response'
          description: Rotate a service token response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Rotate a service token
      tags:
        - Access Service Tokens
  /accounts/{account_id}/access/tags:
    get:
      description: List tags
      operationId: access-tags-list-tags
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List tags response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_tags_components-schemas-response_collection'
          description: List tags response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List tags
      tags:
        - Access Tags
      x-api-token-group:
        - 'Access: Apps and Policies Revoke'
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    post:
      description: Create a tag
      operationId: access-tags-create-tag
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_tags_components-schemas-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create a tag response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_tags_components-schemas-single_response'
          description: Create a tag response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a tag
      tags:
        - Access Tags
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /accounts/{account_id}/access/tags/{tag_name}:
    delete:
      description: Delete a tag
      operationId: access-tags-delete-a-tag
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
        - in: path
          name: tag_name
          required: true
          schema:
            $ref: '#/components/schemas/access_tags_components-schemas-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete a tag response failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_name_response'
          description: Delete a tag response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a tag
      tags:
        - Access Tags
      x-api-token-group:
        - 'Access: Apps and Policies Write'
    get:
      description: Get a tag
      operationId: access-tags-get-a-tag
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
        - in: path
          name: tag_name
          required: true
          schema:
            $ref: '#/components/schemas/access_tags_components-schemas-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get a tag response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_tags_components-schemas-single_response'
          description: Get a tag response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a tag
      tags:
        - Access Tags
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    put:
      description: Update a tag
      operationId: access-tags-update-a-tag
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
        - in: path
          name: tag_name
          required: true
          schema:
            $ref: '#/components/schemas/access_tags_components-schemas-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_tag_without_app_count'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update a tag response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_tags_components-schemas-single_response'
          description: Update a tag response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a tag
      tags:
        - Access Tags
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /accounts/{account_id}/access/users:
    get:
      description: Gets a list of users for an account.
      operationId: zero-trust-users-get-users
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get users response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_users_components-schemas-response_collection'
          description: Get users response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get users
      tags:
        - Zero Trust Users
      x-api-token-group:
        - 'Access: Audit Logs Read'
  /accounts/{account_id}/access/users/{user_id}/active_sessions:
    get:
      description: Get active sessions for a single user.
      operationId: zero-trust-users-get-active-sessions
      parameters:
        - in: path
          name: user_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get active sessions response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_active_sessions_response'
          description: Get active sessions response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get active sessions
      tags:
        - Zero Trust Users
  /accounts/{account_id}/access/users/{user_id}/active_sessions/{nonce}:
    get:
      description: Get an active session for a single user.
      operationId: zero-trust-users-get-active-session
      parameters:
        - in: path
          name: user_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
        - in: path
          name: nonce
          required: true
          schema:
            $ref: '#/components/schemas/access_nonce'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get active session response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_active_session_response'
          description: Get active session response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get single active session
      tags:
        - Zero Trust Users
  /accounts/{account_id}/access/users/{user_id}/failed_logins:
    get:
      description: Get all failed login attempts for a single user.
      operationId: zero-trust-users-get-failed-logins
      parameters:
        - in: path
          name: user_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get failed logins response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_failed_login_response'
          description: Get failed logins response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get failed logins
      tags:
        - Zero Trust Users
      x-api-token-group:
        - 'Access: Audit Logs Read'
  /accounts/{account_id}/access/users/{user_id}/last_seen_identity:
    get:
      description: Get last seen identity for a single user.
      operationId: zero-trust-users-get-last-seen-identity
      parameters:
        - in: path
          name: user_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get active session response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_last_seen_identity_response'
          description: Get active session response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get last seen identity
      tags:
        - Zero Trust Users
  /accounts/{account_id}/addressing/address_maps:
    get:
      description: List all address maps owned by the account.
      operationId: ip-address-management-address-maps-list-address-maps
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_components-schemas-response_collection'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: List Address Maps response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_components-schemas-response_collection'
          description: List Address Maps response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Address Maps
      tags:
        - IP Address Management Address Maps
      x-api-token-group:
        - Address Maps Write
        - Address Maps Read
    post:
      description: Create a new address map under the account.
      operationId: ip-address-management-address-maps-create-address-map
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                description:
                  $ref: '#/components/schemas/addressing_schemas-description'
                enabled:
                  $ref: '#/components/schemas/addressing_enabled'
                ips:
                  items:
                    $ref: '#/components/schemas/addressing_ip_address'
                  type: array
                memberships:
                  $ref: '#/components/schemas/addressing_memberships'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_full_response'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Create Address Map response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_full_response'
          description: Create Address Map response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Address Map
      tags:
        - IP Address Management Address Maps
      x-api-token-group:
        - Address Maps Write
  /accounts/{account_id}/addressing/address_maps/{address_map_id}:
    delete:
      description: Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted.
      operationId: ip-address-management-address-maps-delete-address-map
      parameters:
        - in: path
          name: address_map_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-collection'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Delete Address Map response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Delete Address Map response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Address Map
      tags:
        - IP Address Management Address Maps
      x-api-token-group:
        - Address Maps Write
    get:
      description: Show a particular address map owned by the account.
      operationId: ip-address-management-address-maps-address-map-details
      parameters:
        - in: path
          name: address_map_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_full_response'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Address Map Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_full_response'
          description: Address Map Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Address Map Details
      tags:
        - IP Address Management Address Maps
      x-api-token-group:
        - Address Maps Write
        - Address Maps Read
    patch:
      description: Modify properties of an address map owned by the account.
      operationId: ip-address-management-address-maps-update-address-map
      parameters:
        - in: path
          name: address_map_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                default_sni:
                  $ref: '#/components/schemas/addressing_default_sni'
                description:
                  $ref: '#/components/schemas/addressing_schemas-description'
                enabled:
                  $ref: '#/components/schemas/addressing_enabled'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_components-schemas-single_response'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Update Address Map response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_components-schemas-single_response'
          description: Update Address Map response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Address Map
      tags:
        - IP Address Management Address Maps
      x-api-token-group:
        - Address Maps Write
  /accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}:
    delete:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: address_map_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-collection'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Remove an account membership from an Address Map response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Remove an account membership from an Address Map response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Remove an account membership from an Address Map
      tags:
        - IP Address Management Address Maps
    put:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: address_map_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-collection'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Add an account membership to an Address Map response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Add an account membership to an Address Map response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Add an account membership to an Address Map
      tags:
        - IP Address Management Address Maps
  /accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}:
    delete:
      description: Remove an IP from a particular address map.
      operationId: ip-address-management-address-maps-remove-an-ip-from-an-address-map
      parameters:
        - in: path
          name: ip_address
          required: true
          schema:
            $ref: '#/components/schemas/addressing_ip_address'
        - in: path
          name: address_map_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-collection'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Remove an IP from an Address Map response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Remove an IP from an Address Map response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Remove an IP from an Address Map
      tags:
        - IP Address Management Address Maps
      x-api-token-group:
        - Address Maps Write
    put:
      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:
        - in: path
          name: ip_address
          required: true
          schema:
            $ref: '#/components/schemas/addressing_ip_address'
        - in: path
          name: address_map_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-collection'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Add an IP to an Address Map response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Add an IP to an Address Map response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Add an IP to an Address Map
      tags:
        - IP Address Management Address Maps
      x-api-token-group:
        - Address Maps Write
  /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}:
    delete:
      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:
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: address_map_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-collection'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Remove a zone membership from an Address Map response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Remove a zone membership from an Address Map response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Remove a zone membership from an Address Map
      tags:
        - IP Address Management Address Maps
    put:
      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:
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: address_map_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-collection'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Add a zone membership to an Address Map response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Add a zone membership to an Address Map response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Add a zone membership to an Address Map
      tags:
        - IP Address Management Address Maps
  /accounts/{account_id}/addressing/loa_documents:
    post:
      description: Submit LOA document (pdf format) under the account.
      operationId: ip-address-management-prefixes-upload-loa-document
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                loa_document:
                  description: LOA document to upload.
                  example: '@document.pdf'
                  type: string
              required:
                - loa_document
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_loa_upload_response'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Upload LOA Document response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_loa_upload_response'
          description: Upload LOA Document response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Upload LOA Document
      tags:
        - IP Address Management Prefixes
      x-api-token-group:
        - Magic Transit Prefix Write
  /accounts/{account_id}/addressing/loa_documents/{loa_document_id}/download:
    get:
      description: Download specified LOA document under the account.
      operationId: ip-address-management-prefixes-download-loa-document
      parameters:
        - in: path
          name: loa_document_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_loa_document_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - {}
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Download LOA Document response failure
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          description: Download LOA Document response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Download LOA Document
      tags:
        - IP Address Management Prefixes
      x-api-token-group:
        - Magic Transit Prefix Read
        - Magic Transit Prefix Write
  /accounts/{account_id}/addressing/prefixes:
    get:
      description: List all prefixes owned by the account.
      operationId: ip-address-management-prefixes-list-prefixes
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_response_collection'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: List Prefixes response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_response_collection'
          description: List Prefixes response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Prefixes
      tags:
        - IP Address Management Prefixes
      x-api-token-group:
        - Magic Transit Prefix Read
        - Magic Transit Prefix Write
        - 'IP Prefixes: Write'
        - 'IP Prefixes: Read'
        - 'IP Prefixes: BGP On Demand Write'
        - 'IP Prefixes: BGP On Demand Read'
    post:
      description: Add a new prefix under the account.
      operationId: ip-address-management-prefixes-add-prefix
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                asn:
                  $ref: '#/components/schemas/addressing_asn'
                cidr:
                  $ref: '#/components/schemas/addressing_cidr'
                loa_document_id:
                  $ref: '#/components/schemas/addressing_loa_document_identifier'
              required:
                - cidr
                - loa_document_id
                - asn
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_single_response'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Add Prefix response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_single_response'
          description: Add Prefix response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Add Prefix
      tags:
        - IP Address Management Prefixes
  /accounts/{account_id}/addressing/prefixes/{prefix_id}:
    delete:
      description: Delete an unapproved prefix owned by the account.
      operationId: ip-address-management-prefixes-delete-prefix
      parameters:
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-collection'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Delete Prefix response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-collection'
          description: Delete Prefix response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Prefix
      tags:
        - IP Address Management Prefixes
      x-api-token-group:
        - Magic Transit Prefix Write
    get:
      description: List a particular prefix owned by the account.
      operationId: ip-address-management-prefixes-prefix-details
      parameters:
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_single_response'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Prefix Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_single_response'
          description: Prefix Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Prefix Details
      tags:
        - IP Address Management Prefixes
      x-api-token-group:
        - Magic Transit Prefix Read
        - Magic Transit Prefix Write
        - 'IP Prefixes: Write'
        - 'IP Prefixes: Read'
        - 'IP Prefixes: BGP On Demand Write'
        - 'IP Prefixes: BGP On Demand Read'
    patch:
      description: Modify the description for a prefix owned by the account.
      operationId: ip-address-management-prefixes-update-prefix-description
      parameters:
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                description:
                  $ref: '#/components/schemas/addressing_description'
              required:
                - description
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_single_response'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Update Prefix Description response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_single_response'
          description: Update Prefix Description response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Prefix Description
      tags:
        - IP Address Management Prefixes
      x-api-token-group:
        - Magic Transit Prefix Write
        - 'IP Prefixes: Write'
  /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes:
    get:
      description: List all BGP Prefixes within the specified IP Prefix. BGP Prefixes are used to control which specific subnets are advertised to the Internet. It is possible to advertise subnets more specific than an IP Prefix by creating more specific BGP Prefixes.
      operationId: ip-address-management-prefixes-list-bgp-prefixes
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_response_collection_bgp'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: List BGP Prefixes response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_response_collection_bgp'
          description: List BGP Prefixes response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List BGP Prefixes
      tags:
        - IP Address Management BGP Prefixes
      x-api-token-group:
        - Magic Transit Prefix Read
        - Magic Transit Prefix Write
        - 'IP Prefixes: Write'
        - 'IP Prefixes: Read'
        - 'IP Prefixes: BGP On Demand Write'
        - 'IP Prefixes: BGP On Demand Read'
  /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}:
    get:
      description: Retrieve a single BGP Prefix according to its identifier
      operationId: ip-address-management-prefixes-fetch-bgp-prefix
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: bgp_prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_single_response_bgp'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Fetch BGP Prefix response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_single_response_bgp'
          description: Fetch BGP Prefix response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Fetch BGP Prefix
      tags:
        - IP Address Management BGP Prefixes
      x-api-token-group:
        - Magic Transit Prefix Read
        - Magic Transit Prefix Write
        - 'IP Prefixes: Write'
        - 'IP Prefixes: Read'
        - 'IP Prefixes: BGP On Demand Write'
        - 'IP Prefixes: BGP On Demand Read'
    patch:
      description: Update the properties of a BGP Prefix, such as the on demand advertisement status (advertised or withdrawn).
      operationId: ip-address-management-prefixes-update-bgp-prefix
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: bgp_prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/addressing_bgp_prefix_update_advertisement'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_single_response_bgp'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Update BGP Prefix response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_single_response_bgp'
          description: Update BGP Prefix response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update BGP Prefix
      tags:
        - IP Address Management BGP Prefixes
      x-api-token-group:
        - Magic Transit Prefix Write
        - 'IP Prefixes: Write'
        - 'IP Prefixes: BGP On Demand Write'
  /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status:
    get:
      description: List the current advertisement state for a prefix.
      operationId: ip-address-management-dynamic-advertisement-get-advertisement-status
      parameters:
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_advertised_response'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Get Advertisement Status response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_advertised_response'
          description: Get Advertisement Status response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Advertisement Status
      tags:
        - IP Address Management Dynamic Advertisement
      x-api-token-group:
        - Magic Transit Prefix Read
        - Magic Transit Prefix Write
        - 'IP Prefixes: Write'
        - 'IP Prefixes: Read'
        - 'IP Prefixes: BGP On Demand Write'
        - 'IP Prefixes: BGP On Demand Read'
    patch:
      description: Advertise or withdraw BGP route for a prefix.
      operationId: ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status
      parameters:
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                advertised:
                  $ref: '#/components/schemas/addressing_schemas-advertised'
              required:
                - advertised
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_advertised_response'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Update Prefix Dynamic Advertisement Status response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_advertised_response'
          description: Update Prefix Dynamic Advertisement Status response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Prefix Dynamic Advertisement Status
      tags:
        - IP Address Management Dynamic Advertisement
      x-api-token-group:
        - Magic Transit Prefix Write
        - 'IP Prefixes: Write'
        - 'IP Prefixes: BGP On Demand Write'
  /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings:
    get:
      description: |
        List the Cloudflare services this prefix is currently bound to. Traffic sent to an address within an IP prefix will be routed to the Cloudflare service of the most-specific Service Binding matching the address.
        **Example:** binding `192.0.2.0/24` to Cloudflare Magic Transit and `192.0.2.1/32` to the Cloudflare CDN would route traffic for `192.0.2.1` to the CDN, and traffic for all other IPs in the prefix to Cloudflare Magic Transit.
      operationId: ip-address-management-service-bindings-list-service-bindings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: List Service Bindings response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/addressing_service_binding'
                        type: array
          description: Service Bindings attached to the Prefix
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Service Bindings
      tags:
        - IP Address Management Service Bindings
      x-api-token-group:
        - 'IP Prefixes: Write'
        - 'IP Prefixes: Read'
    post:
      description: |
        Creates a new Service Binding, routing traffic to IPs within the given CIDR to a service running on Cloudflare's network.
        **Note:** This API may only be used on prefixes currently configured with a Magic Transit service binding, and only allows creating service bindings for the Cloudflare CDN or Cloudflare Spectrum.
      operationId: ip-address-management-service-bindings-create-service-binding
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/addressing_create_binding_request'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Create Service Binding response failure
        "201":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/addressing_service_binding'
          description: The created Service Binding
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Service Binding
      tags:
        - IP Address Management Service Bindings
      x-api-token-group:
        - 'IP Prefixes: Write'
  /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings/{binding_id}:
    delete:
      description: Delete a Service Binding
      operationId: ip-address-management-service-bindings-delete-service-binding
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: binding_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Delete Service Binding response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-common'
          description: Service Binding deleted
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Service Binding
      tags:
        - IP Address Management Service Bindings
      x-api-token-group:
        - 'IP Prefixes: Write'
    get:
      description: Fetch a single Service Binding
      operationId: ip-address-management-service-bindings-get-service-binding
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: binding_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Get Service Binding response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/addressing_service_binding'
          description: The Service Binding with the requested ID
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Service Binding
      tags:
        - IP Address Management Service Bindings
      x-api-token-group:
        - 'IP Prefixes: Write'
        - 'IP Prefixes: Read'
  /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations:
    get:
      description: List all delegations for a given account IP prefix.
      operationId: ip-address-management-prefix-delegation-list-prefix-delegations
      parameters:
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_schemas-response_collection'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: List Prefix Delegations response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_schemas-response_collection'
          description: List Prefix Delegations response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Prefix Delegations
      tags:
        - IP Address Management Prefix Delegation
    post:
      description: Create a new account delegation for a given IP prefix.
      operationId: ip-address-management-prefix-delegation-create-prefix-delegation
      parameters:
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                cidr:
                  $ref: '#/components/schemas/addressing_cidr'
                delegated_account_id:
                  $ref: '#/components/schemas/addressing_delegated_account_identifier'
              required:
                - cidr
                - delegated_account_id
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_schemas-single_response'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Create Prefix Delegation response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_schemas-single_response'
          description: Create Prefix Delegation response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Prefix Delegation
      tags:
        - IP Address Management Prefix Delegation
      x-api-token-group:
        - 'IP Prefixes: Write'
  /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations/{delegation_id}:
    delete:
      description: Delete an account delegation for a given IP prefix.
      operationId: ip-address-management-prefix-delegation-delete-prefix-delegation
      parameters:
        - in: path
          name: delegation_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_delegation_identifier'
        - in: path
          name: prefix_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_id_response'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Delete Prefix Delegation response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_id_response'
          description: Delete Prefix Delegation response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Prefix Delegation
      tags:
        - IP Address Management Prefix Delegation
      x-api-token-group:
        - 'IP Prefixes: Write'
  /accounts/{account_id}/addressing/regional_hostnames/regions:
    get:
      description: List all Regional Services regions available for use by this account.
      operationId: dls-account-regional-hostnames-account-list-regions
      parameters:
        - $ref: '#/components/parameters/dls_account_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dls_api-response-common-failure'
          description: Failure to list regions
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dls_api-response-collection'
                  - properties:
                      result:
                        items:
                          properties:
                            key:
                              $ref: '#/components/schemas/dls_region_key'
                            label:
                              description: Human-readable text label for the region
                              example: Canada
                              type: string
                          type: object
                        type: array
          description: List regions response
      security:
        - api_email: []
          api_key: []
        - api_token: []
      summary: APIs.io Engineering Platform List Regions
      tags:
        - DLS Regional Services
      x-api-token-group:
        - DNS Read
  /accounts/{account_id}/addressing/services:
    get:
      description: |
        Bring-Your-Own IP (BYOIP) prefixes onboarded to Cloudflare must be bound to a service running on the Cloudflare network to enable a Cloudflare product on the IP addresses. This endpoint can be used as a reference of available services on the Cloudflare network, and their service IDs.
      operationId: ip-address-management-service-bindings-list-services
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: List Services response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-common'
                  - properties:
                      result:
                        items:
                          properties:
                            id:
                              $ref: '#/components/schemas/addressing_service_identifier'
                            name:
                              $ref: '#/components/schemas/addressing_service_name'
                        type: array
          description: Service names and IDs
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Services
      tags:
        - IP Address Management Service Bindings
      x-api-token-group:
        - 'IP Prefixes: Write'
        - 'IP Prefixes: Read'
  /accounts/{account_id}/ai-gateway/gateways:
    get:
      operationId: aig-config-list-gateway
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 3ebbcb006d4d46d7bb6a8c7f14676cb0
            type: string
        - in: query
          name: page
          schema:
            default: 1
            minimum: 1
            type: integer
        - in: query
          name: per_page
          schema:
            default: 20
            maximum: 100
            minimum: 5
            type: integer
        - description: Order By Column Name
          in: query
          name: order_by
          schema:
            description: Order By Column Name
            type: string
        - description: Order By Direction
          in: query
          name: order_by_direction
          schema:
            default: asc
            description: Order By Direction
            enum:
              - asc
              - desc
            type: string
        - in: query
          name: id
          schema:
            description: gateway id
            example: my-gateway
            maxLength: 64
            minLength: 1
            pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    items:
                      properties:
                        cache_invalidate_on_update:
                          type: boolean
                        cache_ttl:
                          minimum: 0
                          nullable: true
                          type: integer
                        collect_logs:
                          type: boolean
                        created_at:
                          format: date-time
                          type: string
                        id:
                          description: gateway id
                          example: my-gateway
                          maxLength: 64
                          minLength: 1
                          pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$
                          type: string
                        modified_at:
                          format: date-time
                          type: string
                        rate_limiting_interval:
                          minimum: 0
                          nullable: true
                          type: integer
                        rate_limiting_limit:
                          minimum: 0
                          nullable: true
                          type: integer
                        rate_limiting_technique:
                          enum:
                            - fixed
                            - sliding
                          type: string
                      required:
                        - id
                        - rate_limiting_interval
                        - rate_limiting_limit
                        - rate_limiting_technique
                        - collect_logs
                        - cache_ttl
                        - cache_invalidate_on_update
                        - created_at
                        - modified_at
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                  - success
                  - result
                type: object
          description: Returns a list of Gateways
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Gateways
      tags:
        - AI Gateway
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.aig
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      operationId: aig-config-create-gateway
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 3ebbcb006d4d46d7bb6a8c7f14676cb0
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                cache_invalidate_on_update:
                  type: boolean
                cache_ttl:
                  minimum: 0
                  nullable: true
                  type: integer
                collect_logs:
                  type: boolean
                id:
                  description: gateway id
                  example: my-gateway
                  maxLength: 64
                  minLength: 1
                  pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$
                  type: string
                rate_limiting_interval:
                  minimum: 0
                  nullable: true
                  type: integer
                rate_limiting_limit:
                  minimum: 0
                  nullable: true
                  type: integer
                rate_limiting_technique:
                  enum:
                    - fixed
                    - sliding
                  type: string
              required:
                - id
                - rate_limiting_interval
                - rate_limiting_limit
                - rate_limiting_technique
                - collect_logs
                - cache_ttl
                - cache_invalidate_on_update
              type: object
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      cache_invalidate_on_update:
                        type: boolean
                      cache_ttl:
                        minimum: 0
                        nullable: true
                        type: integer
                      collect_logs:
                        type: boolean
                      created_at:
                        format: date-time
                        type: string
                      id:
                        description: gateway id
                        example: my-gateway
                        maxLength: 64
                        minLength: 1
                        pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$
                        type: string
                      modified_at:
                        format: date-time
                        type: string
                      rate_limiting_interval:
                        minimum: 0
                        nullable: true
                        type: integer
                      rate_limiting_limit:
                        minimum: 0
                        nullable: true
                        type: integer
                      rate_limiting_technique:
                        enum:
                          - fixed
                          - sliding
                        type: string
                    required:
                      - id
                      - rate_limiting_interval
                      - rate_limiting_limit
                      - rate_limiting_technique
                      - collect_logs
                      - cache_ttl
                      - cache_invalidate_on_update
                      - created_at
                      - modified_at
                    type: object
                  success:
                    type: boolean
                required:
                  - success
                  - result
                type: object
          description: Returns the created Gateway
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          example: 7001
                          type: number
                        message:
                          example: Input Validation Error
                          type: string
                        path:
                          items:
                            example: body
                            type: string
                          type: array
                      required:
                        - code
                        - message
                        - path
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                  - success
                  - errors
                type: object
          description: Input Validation Error
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a new Gateway
      tags:
        - AI Gateway
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.aig
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs:
    get:
      operationId: aig-config-list-gateway-logs
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 0d37909e38d3e99c29fa2cd343ac421a
            type: string
        - in: path
          name: gateway_id
          required: true
          schema:
            description: gateway id
            example: my-gateway
            maxLength: 64
            minLength: 1
            pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$
            type: string
        - in: query
          name: search
          schema:
            type: string
        - in: query
          name: page
          schema:
            default: 1
            minimum: 1
            type: integer
        - in: query
          name: per_page
          schema:
            default: 20
            maximum: 50
            minimum: 5
            type: integer
        - in: query
          name: order_by
          schema:
            default: created_at
            enum:
              - created_at
              - provider
              - model
              - model_type
              - success
              - cached
            type: string
        - in: query
          name: direction
          schema:
            enum:
              - asc
              - desc
            type: string
        - in: query
          name: order_by_direction
          schema:
            default: asc
            enum:
              - asc
              - desc
            type: string
        - in: query
          name: start_date
          schema:
            format: date-time
            type: string
        - in: query
          name: end_date
          schema:
            format: date-time
            type: string
        - in: query
          name: min_cost
          schema:
            type: number
        - in: query
          name: max_cost
          schema:
            type: number
        - in: query
          name: min_tokens_in
          schema:
            type: number
        - in: query
          name: max_tokens_in
          schema:
            type: number
        - in: query
          name: min_tokens_out
          schema:
            type: number
        - in: query
          name: max_tokens_out
          schema:
            type: number
        - in: query
          name: min_total_tokens
          schema:
            type: number
        - in: query
          name: max_total_tokens
          schema:
            type: number
        - in: query
          name: min_duration
          schema:
            type: number
        - in: query
          name: max_duration
          schema:
            type: number
        - in: query
          name: feedback
          schema:
            anyOf:
              - enum:
                  - -1
                type: number
              - enum:
                  - 0
                type: number
              - enum:
                  - 1
                type: number
        - in: query
          name: success
          schema:
            type: boolean
        - in: query
          name: cached
          schema:
            type: boolean
        - in: query
          name: model
          schema:
            type: string
        - in: query
          name: model_type
          schema:
            type: string
        - in: query
          name: provider
          schema:
            type: string
        - in: query
          name: request_content_type
          schema:
            type: string
        - in: query
          name: response_content_type
          schema:
            type: string
        - in: query
          name: meta_info
          schema:
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    items:
                      properties:
                        cached:
                          type: boolean
                        cost:
                          type: number
                        created_at:
                          format: date-time
                          type: string
                        custom_cost:
                          type: boolean
                        duration:
                          type: integer
                        id:
                          type: string
                        metadata:
                          type: string
                        model:
                          type: string
                        model_type:
                          type: string
                        path:
                          type: string
                        provider:
                          type: string
                        request:
                          type: string
                        request_content_type:
                          type: string
                        request_type:
                          type: string
                        response:
                          type: string
                        response_content_type:
                          type: string
                        status_code:
                          type: integer
                        step:
                          type: integer
                        success:
                          type: boolean
                        tokens_in:
                          nullable: true
                          type: integer
                        tokens_out:
                          nullable: true
                          type: integer
                      required:
                        - id
                        - created_at
                        - provider
                        - model
                        - path
                        - duration
                        - request
                        - response
                        - success
                        - cached
                        - tokens_in
                        - tokens_out
                      type: object
                    type: array
                  result_info:
                    properties:
                      count:
                        type: number
                      max_cost:
                        type: number
                      max_duration:
                        type: number
                      max_tokens_in:
                        type: number
                      max_tokens_out:
                        type: number
                      max_total_tokens:
                        type: number
                      min_cost:
                        type: number
                      min_duration:
                        type: number
                      min_tokens_in:
                        type: number
                      min_tokens_out:
                        type: number
                      min_total_tokens:
                        type: number
                      page:
                        type: number
                      per_page:
                        type: number
                      total_count:
                        type: number
                    type: object
                  success:
                    type: boolean
                required:
                  - success
                  - result
                  - result_info
                type: object
          description: Returns a list of Gateway Logs
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Gateway Logs
      tags:
        - AI Gateway
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.aig
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai-gateway/gateways/{id}:
    delete:
      operationId: aig-config-delete-gateway
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 3ebbcb006d4d46d7bb6a8c7f14676cb0
            type: string
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      cache_invalidate_on_update:
                        type: boolean
                      cache_ttl:
                        minimum: 0
                        nullable: true
                        type: integer
                      collect_logs:
                        type: boolean
                      created_at:
                        format: date-time
                        type: string
                      id:
                        description: gateway id
                        example: my-gateway
                        maxLength: 64
                        minLength: 1
                        pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$
                        type: string
                      modified_at:
                        format: date-time
                        type: string
                      rate_limiting_interval:
                        minimum: 0
                        nullable: true
                        type: integer
                      rate_limiting_limit:
                        minimum: 0
                        nullable: true
                        type: integer
                      rate_limiting_technique:
                        enum:
                          - fixed
                          - sliding
                        type: string
                    required:
                      - id
                      - rate_limiting_interval
                      - rate_limiting_limit
                      - rate_limiting_technique
                      - collect_logs
                      - cache_ttl
                      - cache_invalidate_on_update
                      - created_at
                      - modified_at
                    type: object
                  success:
                    type: boolean
                required:
                  - success
                  - result
                type: object
          description: Returns if the Gateway was deleted successfully
        "404":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          example: 7002
                          type: number
                        message:
                          example: Not Found
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                  - success
                  - errors
                type: object
          description: Not Found
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a Gateway
      tags:
        - AI Gateway
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.aig
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      operationId: aig-config-fetch-gateway
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 3ebbcb006d4d46d7bb6a8c7f14676cb0
            type: string
        - in: path
          name: id
          required: true
          schema:
            description: gateway id
            example: my-gateway
            maxLength: 64
            minLength: 1
            pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      cache_invalidate_on_update:
                        type: boolean
                      cache_ttl:
                        minimum: 0
                        nullable: true
                        type: integer
                      collect_logs:
                        type: boolean
                      created_at:
                        format: date-time
                        type: string
                      id:
                        description: gateway id
                        example: my-gateway
                        maxLength: 64
                        minLength: 1
                        pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$
                        type: string
                      modified_at:
                        format: date-time
                        type: string
                      rate_limiting_interval:
                        minimum: 0
                        nullable: true
                        type: integer
                      rate_limiting_limit:
                        minimum: 0
                        nullable: true
                        type: integer
                      rate_limiting_technique:
                        enum:
                          - fixed
                          - sliding
                        type: string
                    required:
                      - id
                      - rate_limiting_interval
                      - rate_limiting_limit
                      - rate_limiting_technique
                      - collect_logs
                      - cache_ttl
                      - cache_invalidate_on_update
                      - created_at
                      - modified_at
                    type: object
                  success:
                    type: boolean
                required:
                  - success
                  - result
                type: object
          description: Returns a single Gateway if found
        "404":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          example: 7002
                          type: number
                        message:
                          example: Not Found
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                  - success
                  - errors
                type: object
          description: Not Found
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Fetch a Gateway
      tags:
        - AI Gateway
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.aig
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      operationId: aig-config-update-gateway
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 3ebbcb006d4d46d7bb6a8c7f14676cb0
            type: string
        - in: path
          name: id
          required: true
          schema:
            description: gateway id
            example: my-gateway
            maxLength: 64
            minLength: 1
            pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                cache_invalidate_on_update:
                  type: boolean
                cache_ttl:
                  minimum: 0
                  nullable: true
                  type: integer
                collect_logs:
                  type: boolean
                rate_limiting_interval:
                  minimum: 0
                  nullable: true
                  type: integer
                rate_limiting_limit:
                  minimum: 0
                  nullable: true
                  type: integer
                rate_limiting_technique:
                  enum:
                    - fixed
                    - sliding
                  type: string
              required:
                - rate_limiting_interval
                - rate_limiting_limit
                - rate_limiting_technique
                - collect_logs
                - cache_ttl
                - cache_invalidate_on_update
              type: object
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      cache_invalidate_on_update:
                        type: boolean
                      cache_ttl:
                        minimum: 0
                        nullable: true
                        type: integer
                      collect_logs:
                        type: boolean
                      created_at:
                        format: date-time
                        type: string
                      id:
                        description: gateway id
                        example: my-gateway
                        maxLength: 64
                        minLength: 1
                        pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$
                        type: string
                      modified_at:
                        format: date-time
                        type: string
                      rate_limiting_interval:
                        minimum: 0
                        nullable: true
                        type: integer
                      rate_limiting_limit:
                        minimum: 0
                        nullable: true
                        type: integer
                      rate_limiting_technique:
                        enum:
                          - fixed
                          - sliding
                        type: string
                    required:
                      - id
                      - rate_limiting_interval
                      - rate_limiting_limit
                      - rate_limiting_technique
                      - collect_logs
                      - cache_ttl
                      - cache_invalidate_on_update
                      - created_at
                      - modified_at
                    type: object
                  success:
                    type: boolean
                required:
                  - success
                  - result
                type: object
          description: Returns the updated Gateway
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          example: 7001
                          type: number
                        message:
                          example: Input Validation Error
                          type: string
                        path:
                          items:
                            example: body
                            type: string
                          type: array
                      required:
                        - code
                        - message
                        - path
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                  - success
                  - errors
                type: object
          description: Input Validation Error
        "404":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          example: 7002
                          type: number
                        message:
                          example: Not Found
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                  - success
                  - errors
                type: object
          description: Not Found
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a Gateway
      tags:
        - AI Gateway
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.aig
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/authors/search:
    get:
      operationId: workers-ai-search-author
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      type: object
                    type: array
                  messages:
                    items:
                      type: object
                    type: array
                  result:
                    items:
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                  - success
                  - result
                  - errors
                  - messages
                type: object
          description: Returns a list of authors
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    type: string
                  success:
                    type: boolean
                required:
                  - success
                  - error
                type: object
          description: Object not found
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Author Search
      tags:
        - Workers AI
      x-api-token-group:
        - Workers AI Write
        - Workers AI Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/finetunes:
    get:
      operationId: workers-ai-list-finetunes
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      created_at:
                        format: date-time
                        type: string
                      description:
                        type: string
                      id:
                        format: uuid
                        type: string
                      model:
                        type: string
                      modified_at:
                        format: date-time
                        type: string
                      name:
                        type: string
                    required:
                      - id
                      - model
                      - name
                      - created_at
                      - modified_at
                    type: object
                  success:
                    type: boolean
                required:
                  - success
                  - result
                type: object
          description: Returns all finetunes
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Finetunes
      tags:
        - Workers AI Finetune
      x-api-token-group:
        - Workers AI Write
        - Workers AI Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      operationId: workers-ai-create-finetune
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                description:
                  type: string
                model:
                  type: string
                name:
                  type: string
                public:
                  type: boolean
              required:
                - model
                - name
              type: object
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      created_at:
                        format: date-time
                        type: string
                      description:
                        type: string
                      id:
                        format: uuid
                        type: string
                      model:
                        type: string
                      modified_at:
                        format: date-time
                        type: string
                      name:
                        type: string
                      public:
                        type: boolean
                    required:
                      - id
                      - created_at
                      - modified_at
                      - public
                      - name
                      - model
                    type: object
                  success:
                    type: boolean
                required:
                  - success
                  - result
                type: object
          description: Returns the created finetune
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: string
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                type: object
          description: Finetune creation failed
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a new Finetune
      tags:
        - Workers AI Finetune
      x-api-token-group:
        - Workers AI Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/finetunes/{finetune_id}/finetune-assets:
    post:
      operationId: workers-ai-upload-finetune-asset
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
        - in: path
          name: finetune_id
          required: true
          schema:
            example: bc451aef-f723-4b26-a6b2-901afd2e7a8a
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  format: binary
                  type: string
                file_name:
                  type: string
              type: object
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      bucket_name:
                        type: string
                      created_at:
                        format: date-time
                        type: string
                      file_name:
                        type: string
                      finetune_id:
                        example: bc451aef-f723-4b26-a6b2-901afd2e7a8a
                        type: string
                      id:
                        format: uuid
                        type: string
                      modified_at:
                        format: date-time
                        type: string
                    required:
                      - id
                      - finetune_id
                      - file_name
                      - bucket_name
                      - created_at
                      - modified_at
                    type: object
                  success:
                    type: boolean
                required:
                  - success
                  - result
                type: object
          description: Returns the created finetune asset
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: string
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                type: object
          description: Finetune creation failed
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Upload a Finetune Asset
      tags:
        - Workers AI Finetune
      x-api-token-group:
        - Workers AI Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/finetunes/public:
    get:
      operationId: workers-ai-list-public-finetunes
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
        - description: Pagination Limit
          in: query
          name: limit
          schema:
            description: Pagination Limit
            type: number
        - description: Pagination Offset
          in: query
          name: offset
          schema:
            description: Pagination Offset
            type: number
        - description: Order By Column Name
          in: query
          name: orderBy
          schema:
            description: Order By Column Name
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    items:
                      properties:
                        created_at:
                          format: date-time
                          type: string
                        description:
                          type: string
                        id:
                          format: uuid
                          type: string
                        model:
                          type: string
                        modified_at:
                          format: date-time
                          type: string
                        name:
                          type: string
                        public:
                          type: boolean
                      required:
                        - id
                        - model
                        - name
                        - public
                        - created_at
                        - modified_at
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                  - success
                  - result
                type: object
          description: Returns all public finetunes
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Public Finetunes
      tags:
        - Workers AI Finetune
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/models/schema:
    get:
      operationId: workers-ai-get-model-schema
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
        - description: Model Name
          in: query
          name: model
          required: true
          schema:
            description: Model Name
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - success
                  - result
                type: object
          description: Model Schema
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Model Schema
      tags:
        - Workers AI
      x-api-token-group:
        - Workers AI Write
        - Workers AI Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/models/search:
    get:
      operationId: workers-ai-search-model
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
        - in: query
          name: per_page
          schema:
            type: integer
        - in: query
          name: page
          schema:
            type: integer
        - description: Filter by Task Name
          in: query
          name: task
          schema:
            description: Filter by Task Name
            example: Text Generation
            type: string
        - description: Filter by Author
          in: query
          name: author
          schema:
            description: Filter by Author
            type: string
        - description: Filter by Source Id
          in: query
          name: source
          schema:
            description: Filter by Source Id
            type: number
        - description: Filter to hide experimental models
          in: query
          name: hide_experimental
          schema:
            description: Filter to hide experimental models
            type: boolean
        - description: Search
          in: query
          name: search
          schema:
            description: Search
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      type: object
                    type: array
                  messages:
                    items:
                      type: object
                    type: array
                  result:
                    items:
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                  - success
                  - result
                  - errors
                  - messages
                type: object
          description: Returns a list of models
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    type: string
                  success:
                    type: boolean
                required:
                  - success
                  - error
                type: object
          description: Object not found
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Model Search
      tags:
        - Workers AI
      x-api-token-group:
        - Workers AI Write
        - Workers AI Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/baai/bge-base-en-v1.5:
    post:
      operationId: workers-ai-post-run-cf-baai-bge-base-en-v1-5
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                text:
                  oneOf:
                    - minLength: 1
                      type: string
                    - items:
                        minLength: 1
                        type: string
                      maxItems: 100
                      type: array
              required:
                - text
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/baai/bge-base-en-v1.5 model.
      tags:
        - Workers AI Text Embeddings
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/baai/bge-large-en-v1.5:
    post:
      operationId: workers-ai-post-run-cf-baai-bge-large-en-v1-5
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                text:
                  oneOf:
                    - minLength: 1
                      type: string
                    - items:
                        minLength: 1
                        type: string
                      maxItems: 100
                      type: array
              required:
                - text
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/baai/bge-large-en-v1.5 model.
      tags:
        - Workers AI Text Embeddings
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/baai/bge-small-en-v1.5:
    post:
      operationId: workers-ai-post-run-cf-baai-bge-small-en-v1-5
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                text:
                  oneOf:
                    - minLength: 1
                      type: string
                    - items:
                        minLength: 1
                        type: string
                      maxItems: 100
                      type: array
              required:
                - text
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/baai/bge-small-en-v1.5 model.
      tags:
        - Workers AI Text Embeddings
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/bytedance/stable-diffusion-xl-lightning:
    post:
      operationId: workers-ai-post-run-cf-bytedance-stable-diffusion-xl-lightning
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                guidance:
                  default: 7.5
                  type: number
                height:
                  maximum: 2048
                  minimum: 256
                  type: integer
                image:
                  items:
                    type: number
                  type: array
                image_b64:
                  type: string
                mask:
                  items:
                    type: number
                  type: array
                negative_prompt:
                  type: string
                num_steps:
                  default: 20
                  maximum: 20
                  type: integer
                prompt:
                  minLength: 1
                  type: string
                seed:
                  type: integer
                strength:
                  default: 1
                  type: number
                width:
                  maximum: 2048
                  minimum: 256
                  type: integer
              required:
                - prompt
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/bytedance/stable-diffusion-xl-lightning model.
      tags:
        - Workers AI Text to Image
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/deepseek-ai/deepseek-math-7b-instruct:
    post:
      operationId: workers-ai-post-run-cf-deepseek-ai-deepseek-math-7b-instruct
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/deepseek-ai/deepseek-math-7b-instruct model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/defog/sqlcoder-7b-2:
    post:
      operationId: workers-ai-post-run-cf-defog-sqlcoder-7b-2
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/defog/sqlcoder-7b-2 model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/facebook/bart-large-cnn:
    post:
      operationId: workers-ai-post-run-cf-facebook-bart-large-cnn
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                input_text:
                  minLength: 1
                  type: string
                max_length:
                  default: 1024
                  type: integer
              required:
                - input_text
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/facebook/bart-large-cnn model.
      tags:
        - Workers AI Summarization
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/facebook/detr-resnet-50:
    post:
      operationId: workers-ai-post-run-cf-facebook-detr-resnet-50
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/octet-stream:
            schema:
              format: binary
              type: string
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/facebook/detr-resnet-50 model.
      tags:
        - Workers AI Object Detection
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/fblgit/una-cybertron-7b-v2-bf16:
    post:
      operationId: workers-ai-post-run-cf-fblgit-una-cybertron-7b-v2-bf16
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/fblgit/una-cybertron-7b-v2-bf16 model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/google/gemma-2b-it-lora:
    post:
      operationId: workers-ai-post-run-cf-google-gemma-2b-it-lora
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/google/gemma-2b-it-lora model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/google/gemma-7b-it-lora:
    post:
      operationId: workers-ai-post-run-cf-google-gemma-7b-it-lora
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/google/gemma-7b-it-lora model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/huggingface/distilbert-sst-2-int8:
    post:
      operationId: workers-ai-post-run-cf-huggingface-distilbert-sst-2-int8
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                text:
                  minLength: 1
                  type: string
              required:
                - text
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/huggingface/distilbert-sst-2-int8 model.
      tags:
        - Workers AI Text Classification
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/lykon/dreamshaper-8-lcm:
    post:
      operationId: workers-ai-post-run-cf-lykon-dreamshaper-8-lcm
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                guidance:
                  default: 7.5
                  type: number
                height:
                  maximum: 2048
                  minimum: 256
                  type: integer
                image:
                  items:
                    type: number
                  type: array
                image_b64:
                  type: string
                mask:
                  items:
                    type: number
                  type: array
                negative_prompt:
                  type: string
                num_steps:
                  default: 20
                  maximum: 20
                  type: integer
                prompt:
                  minLength: 1
                  type: string
                seed:
                  type: integer
                strength:
                  default: 1
                  type: number
                width:
                  maximum: 2048
                  minimum: 256
                  type: integer
              required:
                - prompt
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/lykon/dreamshaper-8-lcm model.
      tags:
        - Workers AI Text to Image
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/meta-llama/llama-2-7b-chat-hf-lora:
    post:
      operationId: workers-ai-post-run-cf-meta-llama-llama-2-7b-chat-hf-lora
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/meta-llama/llama-2-7b-chat-hf-lora model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/meta/llama-2-7b-chat-fp16:
    post:
      operationId: workers-ai-post-run-cf-meta-llama-2-7b-chat-fp16
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/meta/llama-2-7b-chat-fp16 model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/meta/llama-3-8b-instruct:
    post:
      operationId: workers-ai-post-run-cf-meta-llama-3-8b-instruct
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/meta/llama-3-8b-instruct model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/meta/llama-3-8b-instruct-awq:
    post:
      operationId: workers-ai-post-run-cf-meta-llama-3-8b-instruct-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/meta/llama-3-8b-instruct-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/meta/llama-3.1-8b-instruct:
    post:
      operationId: workers-ai-post-run-cf-meta-llama-3-1-8b-instruct
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/meta/llama-3.1-8b-instruct model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/meta/llama-3.1-8b-instruct-awq:
    post:
      operationId: workers-ai-post-run-cf-meta-llama-3-1-8b-instruct-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/meta/llama-3.1-8b-instruct-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/meta/llama-3.1-8b-instruct-fp8:
    post:
      operationId: workers-ai-post-run-cf-meta-llama-3-1-8b-instruct-fp8
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/meta/llama-3.1-8b-instruct-fp8 model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/meta/m2m100-1.2b:
    post:
      operationId: workers-ai-post-run-cf-meta-m2m100-1-2b
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                source_lang:
                  default: en
                  type: string
                target_lang:
                  type: string
                text:
                  minLength: 1
                  type: string
              required:
                - text
                - target_lang
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/meta/m2m100-1.2b model.
      tags:
        - Workers AI Translation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/microsoft/phi-2:
    post:
      operationId: workers-ai-post-run-cf-microsoft-phi-2
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/microsoft/phi-2 model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/microsoft/resnet-50:
    post:
      operationId: workers-ai-post-run-cf-microsoft-resnet-50
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/octet-stream:
            schema:
              format: binary
              type: string
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/microsoft/resnet-50 model.
      tags:
        - Workers AI Image Classification
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.2-lora:
    post:
      operationId: workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-2-lora
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/mistral/mistral-7b-instruct-v0.2-lora model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/openai/whisper:
    post:
      operationId: workers-ai-post-run-cf-openai-whisper
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/octet-stream:
            schema:
              format: binary
              type: string
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/openai/whisper model.
      tags:
        - Workers AI Automatic Speech Recognition
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/openai/whisper-tiny-en:
    post:
      operationId: workers-ai-post-run-cf-openai-whisper-tiny-en
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/octet-stream:
            schema:
              format: binary
              type: string
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/openai/whisper-tiny-en model.
      tags:
        - Workers AI Automatic Speech Recognition
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/openchat/openchat-3.5-0106:
    post:
      operationId: workers-ai-post-run-cf-openchat-openchat-3-5-0106
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/openchat/openchat-3.5-0106 model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-0.5b-chat:
    post:
      operationId: workers-ai-post-run-cf-qwen-qwen1-5-0-5b-chat
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/qwen/qwen1.5-0.5b-chat model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-1.8b-chat:
    post:
      operationId: workers-ai-post-run-cf-qwen-qwen1-5-1-8b-chat
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/qwen/qwen1.5-1.8b-chat model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-7b-chat-awq:
    post:
      operationId: workers-ai-post-run-cf-qwen-qwen1-5-7b-chat-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/qwen/qwen1.5-7b-chat-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-14b-chat-awq:
    post:
      operationId: workers-ai-post-run-cf-qwen-qwen1-5-14b-chat-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/qwen/qwen1.5-14b-chat-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/runwayml/stable-diffusion-v1-5-img2img:
    post:
      operationId: workers-ai-post-run-cf-runwayml-stable-diffusion-v1-5-img2img
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                guidance:
                  default: 7.5
                  type: number
                height:
                  maximum: 2048
                  minimum: 256
                  type: integer
                image:
                  items:
                    type: number
                  type: array
                image_b64:
                  type: string
                mask:
                  items:
                    type: number
                  type: array
                negative_prompt:
                  type: string
                num_steps:
                  default: 20
                  maximum: 20
                  type: integer
                prompt:
                  minLength: 1
                  type: string
                seed:
                  type: integer
                strength:
                  default: 1
                  type: number
                width:
                  maximum: 2048
                  minimum: 256
                  type: integer
              required:
                - prompt
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/runwayml/stable-diffusion-v1-5-img2img model.
      tags:
        - Workers AI Text to Image
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/runwayml/stable-diffusion-v1-5-inpainting:
    post:
      operationId: workers-ai-post-run-cf-runwayml-stable-diffusion-v1-5-inpainting
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                guidance:
                  default: 7.5
                  type: number
                height:
                  maximum: 2048
                  minimum: 256
                  type: integer
                image:
                  items:
                    type: number
                  type: array
                image_b64:
                  type: string
                mask:
                  items:
                    type: number
                  type: array
                negative_prompt:
                  type: string
                num_steps:
                  default: 20
                  maximum: 20
                  type: integer
                prompt:
                  minLength: 1
                  type: string
                seed:
                  type: integer
                strength:
                  default: 1
                  type: number
                width:
                  maximum: 2048
                  minimum: 256
                  type: integer
              required:
                - prompt
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/runwayml/stable-diffusion-v1-5-inpainting model.
      tags:
        - Workers AI Text to Image
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/stabilityai/stable-diffusion-xl-base-1.0:
    post:
      operationId: workers-ai-post-run-cf-stabilityai-stable-diffusion-xl-base-1-0
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                guidance:
                  default: 7.5
                  type: number
                height:
                  maximum: 2048
                  minimum: 256
                  type: integer
                image:
                  items:
                    type: number
                  type: array
                image_b64:
                  type: string
                mask:
                  items:
                    type: number
                  type: array
                negative_prompt:
                  type: string
                num_steps:
                  default: 20
                  maximum: 20
                  type: integer
                prompt:
                  minLength: 1
                  type: string
                seed:
                  type: integer
                strength:
                  default: 1
                  type: number
                width:
                  maximum: 2048
                  minimum: 256
                  type: integer
              required:
                - prompt
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/stabilityai/stable-diffusion-xl-base-1.0 model.
      tags:
        - Workers AI Text to Image
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/thebloke/discolm-german-7b-v1-awq:
    post:
      operationId: workers-ai-post-run-cf-thebloke-discolm-german-7b-v1-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/thebloke/discolm-german-7b-v1-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/tiiuae/falcon-7b-instruct:
    post:
      operationId: workers-ai-post-run-cf-tiiuae-falcon-7b-instruct
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/tiiuae/falcon-7b-instruct model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@cf/tinyllama/tinyllama-1.1b-chat-v1.0:
    post:
      operationId: workers-ai-post-run-cf-tinyllama-tinyllama-1-1b-chat-v1-0
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @cf/tinyllama/tinyllama-1.1b-chat-v1.0 model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@hf/meta-llama/meta-llama-3-8b-instruct:
    post:
      operationId: workers-ai-post-run-hf-meta-llama-meta-llama-3-8b-instruct
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @hf/meta-llama/meta-llama-3-8b-instruct model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@hf/mistral/mistral-7b-instruct-v0.2:
    post:
      operationId: workers-ai-post-run-hf-mistral-mistral-7b-instruct-v0-2
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @hf/mistral/mistral-7b-instruct-v0.2 model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@hf/nexusflow/starling-lm-7b-beta:
    post:
      operationId: workers-ai-post-run-hf-nexusflow-starling-lm-7b-beta
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @hf/nexusflow/starling-lm-7b-beta model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@hf/nousresearch/hermes-2-pro-mistral-7b:
    post:
      operationId: workers-ai-post-run-hf-nousresearch-hermes-2-pro-mistral-7b
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @hf/nousresearch/hermes-2-pro-mistral-7b model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@hf/thebloke/deepseek-coder-6.7b-base-awq:
    post:
      operationId: workers-ai-post-run-hf-thebloke-deepseek-coder-6-7b-base-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @hf/thebloke/deepseek-coder-6.7b-base-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@hf/thebloke/deepseek-coder-6.7b-instruct-awq:
    post:
      operationId: workers-ai-post-run-hf-thebloke-deepseek-coder-6-7b-instruct-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @hf/thebloke/deepseek-coder-6.7b-instruct-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@hf/thebloke/llama-2-13b-chat-awq:
    post:
      operationId: workers-ai-post-run-hf-thebloke-llama-2-13b-chat-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @hf/thebloke/llama-2-13b-chat-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@hf/thebloke/llamaguard-7b-awq:
    post:
      operationId: workers-ai-post-run-hf-thebloke-llamaguard-7b-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @hf/thebloke/llamaguard-7b-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@hf/thebloke/mistral-7b-instruct-v0.1-awq:
    post:
      operationId: workers-ai-post-run-hf-thebloke-mistral-7b-instruct-v0-1-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @hf/thebloke/mistral-7b-instruct-v0.1-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@hf/thebloke/neural-chat-7b-v3-1-awq:
    post:
      operationId: workers-ai-post-run-hf-thebloke-neural-chat-7b-v3-1-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @hf/thebloke/neural-chat-7b-v3-1-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@hf/thebloke/openhermes-2.5-mistral-7b-awq:
    post:
      operationId: workers-ai-post-run-hf-thebloke-openhermes-2-5-mistral-7b-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @hf/thebloke/openhermes-2.5-mistral-7b-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/@hf/thebloke/zephyr-7b-beta-awq:
    post:
      operationId: workers-ai-post-run-hf-thebloke-zephyr-7b-beta-awq
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    lora:
                      type: string
                    max_tokens:
                      default: 256
                      type: integer
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    prompt:
                      maxLength: 131072
                      minLength: 1
                      type: string
                    raw:
                      default: false
                      type: boolean
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - prompt
                - properties:
                    frequency_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    functions:
                      items:
                        properties:
                          code:
                            type: string
                          name:
                            type: string
                        required:
                          - name
                          - code
                        type: object
                      type: array
                    max_tokens:
                      default: 256
                      type: integer
                    messages:
                      items:
                        properties:
                          content:
                            maxLength: 131072
                            type: string
                          role:
                            type: string
                        required:
                          - role
                          - content
                        type: object
                      type: array
                    presence_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    repetition_penalty:
                      maximum: 2
                      minimum: 0
                      type: number
                    seed:
                      maximum: 9.999999999e+09
                      minimum: 1
                      type: integer
                    stream:
                      default: false
                      type: boolean
                    temperature:
                      default: 0.6
                      maximum: 5
                      minimum: 0
                      type: number
                    tools:
                      items:
                        oneOf:
                          - properties:
                              description:
                                type: string
                              name:
                                type: string
                              parameters:
                                properties:
                                  properties:
                                    additionalProperties:
                                      properties:
                                        description:
                                          type: string
                                        type:
                                          type: string
                                      required:
                                        - type
                                        - description
                                      type: object
                                    type: object
                                  required:
                                    items:
                                      type: string
                                    type: array
                                  type:
                                    type: string
                                required:
                                  - type
                                  - properties
                                type: object
                            required:
                              - name
                              - description
                              - parameters
                          - properties:
                              function:
                                properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                                type: object
                              type:
                                type: string
                            required:
                              - type
                              - function
                        type: object
                      type: array
                    top_k:
                      maximum: 50
                      minimum: 1
                      type: integer
                    top_p:
                      maximum: 2
                      minimum: 0
                      type: number
                  required:
                    - messages
              type: object
      responses:
        "200":
          content:
            image/png:
              schema:
                properties:
                  result:
                    format: binary
                    type: string
                  success:
                    default: "true"
                    type: boolean
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    type: boolean
                required:
                  - errors
                  - success
                  - result
                type: object
          description: Bad request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute @hf/thebloke/zephyr-7b-beta-awq model.
      tags:
        - Workers AI Text Generation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/run/{model_name}:
    post:
      description: |-
        This endpoint provides users with the capability to run specific AI models on-demand.

        By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI
        model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases.

        Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).
      operationId: workers-ai-post-run-model
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
        - in: path
          name: model_name
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    text:
                      minLength: 1
                      type: string
                  required:
                    - text
                  title: Text Classification
                  type: object
                - properties:
                    guidance:
                      default: 7.5
                      type: number
                    height:
                      maximum: 2048
                      minimum: 256
                      type: integer
                    image:
                      items:
                        type: number
                      type: array
                    image_b64:
                      type: string
                    mask:
                      items:
                        type: number
                      type: array
                    negative_prompt:
                      type: string
                    num_steps:
                      default: 20
                      maximum: 20
                      type: integer
                    prompt:
                      minLength: 1
                      type: string
                    seed:
                      type: integer
                    strength:
                      default: 1
                      type: number
                    width:
                      maximum: 2048
                      minimum: 256
                      type: integer
                  required:
                    - prompt
                  title: Text To Image
                  type: object
                - properties:
                    text:
                      oneOf:
                        - minLength: 1
                          type: string
                        - items:
                            minLength: 1
                            type: string
                          maxItems: 100
                          type: array
                  required:
                    - text
                  title: Text Embeddings
                  type: object
                - oneOf:
                    - format: binary
                      type: string
                    - properties:
                        audio:
                          items:
                            type: number
                          type: array
                        source_lang:
                          type: string
                        target_lang:
                          type: string
                      required:
                        - audio
                      type: object
                  title: Automatic Speech Recognition
                  type: object
                - oneOf:
                    - format: binary
                      type: string
                    - properties:
                        image:
                          items:
                            type: number
                          type: array
                      required:
                        - image
                      type: object
                  title: Image Classification
                  type: object
                - oneOf:
                    - format: binary
                      type: string
                    - properties:
                        image:
                          items:
                            type: number
                          type: array
                      type: object
                  title: Object Detection
                  type: object
                - oneOf:
                    - properties:
                        frequency_penalty:
                          maximum: 2
                          minimum: 0
                          type: number
                        lora:
                          type: string
                        max_tokens:
                          default: 256
                          type: integer
                        presence_penalty:
                          maximum: 2
                          minimum: 0
                          type: number
                        prompt:
                          maxLength: 131072
                          minLength: 1
                          type: string
                        raw:
                          default: false
                          type: boolean
                        repetition_penalty:
                          maximum: 2
                          minimum: 0
                          type: number
                        seed:
                          maximum: 9.999999999e+09
                          minimum: 1
                          type: integer
                        stream:
                          default: false
                          type: boolean
                        temperature:
                          default: 0.6
                          maximum: 5
                          minimum: 0
                          type: number
                        top_k:
                          maximum: 50
                          minimum: 1
                          type: integer
                        top_p:
                          maximum: 2
                          minimum: 0
                          type: number
                      required:
                        - prompt
                    - properties:
                        frequency_penalty:
                          maximum: 2
                          minimum: 0
                          type: number
                        functions:
                          items:
                            properties:
                              code:
                                type: string
                              name:
                                type: string
                            required:
                              - name
                              - code
                            type: object
                          type: array
                        max_tokens:
                          default: 256
                          type: integer
                        messages:
                          items:
                            properties:
                              content:
                                maxLength: 131072
                                type: string
                              role:
                                type: string
                            required:
                              - role
                              - content
                            type: object
                          type: array
                        presence_penalty:
                          maximum: 2
                          minimum: 0
                          type: number
                        repetition_penalty:
                          maximum: 2
                          minimum: 0
                          type: number
                        seed:
                          maximum: 9.999999999e+09
                          minimum: 1
                          type: integer
                        stream:
                          default: false
                          type: boolean
                        temperature:
                          default: 0.6
                          maximum: 5
                          minimum: 0
                          type: number
                        tools:
                          items:
                            oneOf:
                              - properties:
                                  description:
                                    type: string
                                  name:
                                    type: string
                                  parameters:
                                    properties:
                                      properties:
                                        additionalProperties:
                                          properties:
                                            description:
                                              type: string
                                            type:
                                              type: string
                                          required:
                                            - type
                                            - description
                                          type: object
                                        type: object
                                      required:
                                        items:
                                          type: string
                                        type: array
                                      type:
                                        type: string
                                    required:
                                      - type
                                      - properties
                                    type: object
                                required:
                                  - name
                                  - description
                                  - parameters
                              - properties:
                                  function:
                                    properties:
                                      description:
                                        type: string
                                      name:
                                        type: string
                                      parameters:
                                        properties:
                                          properties:
                                            additionalProperties:
                                              properties:
                                                description:
                                                  type: string
                                                type:
                                                  type: string
                                              required:
                                                - type
                                                - description
                                              type: object
                                            type: object
                                          required:
                                            items:
                                              type: string
                                            type: array
                                          type:
                                            type: string
                                        required:
                                          - type
                                          - properties
                                        type: object
                                    required:
                                      - name
                                      - description
                                      - parameters
                                    type: object
                                  type:
                                    type: string
                                required:
                                  - type
                                  - function
                            type: object
                          type: array
                        top_k:
                          maximum: 50
                          minimum: 1
                          type: integer
                        top_p:
                          maximum: 2
                          minimum: 0
                          type: number
                      required:
                        - messages
                  title: Text Generation
                  type: object
                - properties:
                    source_lang:
                      default: en
                      type: string
                    target_lang:
                      type: string
                    text:
                      minLength: 1
                      type: string
                  required:
                    - text
                    - target_lang
                  title: Translation
                  type: object
                - properties:
                    input_text:
                      minLength: 1
                      type: string
                    max_length:
                      default: 1024
                      type: integer
                  required:
                    - input_text
                  title: Summarization
                  type: object
                - oneOf:
                    - format: binary
                      type: string
                    - not:
                        required:
                          - prompt
                          - messages
                      properties:
                        image:
                          oneOf:
                            - items:
                                type: number
                              type: array
                            - format: binary
                              type: string
                        max_tokens:
                          default: 512
                          type: integer
                        messages:
                          items:
                            properties:
                              content:
                                maxLength: 6144
                                type: string
                              role:
                                type: string
                            required:
                              - role
                              - content
                            type: object
                          type: array
                        prompt:
                          type: string
                        raw:
                          default: false
                          type: boolean
                        temperature:
                          type: number
                      required:
                        - image
                      type: object
                  title: Image To Text
                  type: object
              type: object
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    oneOf:
                      - items:
                          properties:
                            label:
                              type: string
                            score:
                              type: number
                          type: object
                        title: Text Classification
                        type: array
                      - format: binary
                        title: Text To Image
                        type: string
                      - properties:
                          data:
                            items:
                              items:
                                type: number
                              type: array
                            type: array
                          shape:
                            items:
                              type: number
                            type: array
                        title: Text Embeddings
                        type: object
                      - properties:
                          text:
                            type: string
                          vtt:
                            type: string
                          word_count:
                            type: number
                          words:
                            items:
                              properties:
                                end:
                                  type: number
                                start:
                                  type: number
                                word:
                                  type: string
                              type: object
                            type: array
                        required:
                          - text
                        title: Automatic Speech Recognition
                        type: object
                      - items:
                          properties:
                            label:
                              type: string
                            score:
                              type: number
                          type: object
                        title: Image Classification
                        type: array
                      - items:
                          properties:
                            box:
                              properties:
                                xmax:
                                  type: number
                                xmin:
                                  type: number
                                ymax:
                                  type: number
                                ymin:
                                  type: number
                              type: object
                            label:
                              type: string
                            score:
                              type: number
                          type: object
                        title: Object Detection
                        type: array
                      - oneOf:
                          - properties:
                              response:
                                type: string
                              tool_calls:
                                items:
                                  properties:
                                    arguments:
                                      type: object
                                    name:
                                      type: string
                                  type: object
                                type: array
                            type: object
                          - format: binary
                            type: string
                        title: Text Generation
                        type: object
                      - properties:
                          translated_text:
                            type: string
                        title: Translation
                        type: object
                      - properties:
                          summary:
                            type: string
                        title: Summarization
                        type: object
                      - properties:
                          description:
                            type: string
                        title: Image To Text
                        type: object
                    type: object
                type: object
          description: Model response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Execute AI model
      tags:
        - Workers AI
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/ai/tasks/search:
    get:
      operationId: workers-ai-search-task
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            example: 023e105f4ecef8ad9ca31a8372d0c353
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      type: object
                    type: array
                  messages:
                    items:
                      type: object
                    type: array
                  result:
                    items:
                      type: object
                    type: array
                  success:
                    type: boolean
                required:
                  - success
                  - result
                  - errors
                  - messages
                type: object
          description: Returns a list of tasks
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    type: string
                  success:
                    type: boolean
                required:
                  - success
                  - error
                type: object
          description: Object not found
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Task Search
      tags:
        - Workers AI
      x-api-token-group:
        - Workers AI Write
        - Workers AI Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.ai
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/alerting/v3/available_alerts:
    get:
      description: Gets a list of all alert types for which an account is eligible.
      operationId: notification-alert-types-get-alert-types
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_response_collection'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Get Alert Types response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_response_collection'
          description: Get Alert Types response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Alert Types
      tags:
        - Notification Alert Types
      x-api-token-group:
        - Cloudflare Zero Trust PII Read
        - Notifications Write
        - Notifications Read
        - Account Settings Write
        - Account Settings Read
  /accounts/{account_id}/alerting/v3/destinations/eligible:
    get:
      description: Get a list of all delivery mechanism types for which an account is eligible.
      operationId: notification-mechanism-eligibility-get-delivery-mechanism-eligibility
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_schemas-response_collection'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Get delivery mechanism eligibility response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_schemas-response_collection'
          description: Get delivery mechanism eligibility response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get delivery mechanism eligibility
      tags:
        - Notification Mechanism Eligibility
  /accounts/{account_id}/alerting/v3/destinations/pagerduty:
    delete:
      description: Deletes all the PagerDuty Services connected to the account.
      operationId: notification-destinations-with-pager-duty-delete-pager-duty-services
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_api-response-collection'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Delete PagerDuty Services response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_api-response-collection'
          description: Delete PagerDuty Services response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete PagerDuty Services
      tags:
        - Notification Destinations with PagerDuty
      x-api-token-group:
        - Notifications Write
        - Account Settings Write
    get:
      description: Get a list of all configured PagerDuty services.
      operationId: notification-destinations-with-pager-duty-list-pager-duty-services
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_components-schemas-response_collection'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: List PagerDuty services response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_components-schemas-response_collection'
          description: List PagerDuty services response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List PagerDuty services
      tags:
        - Notification Destinations with PagerDuty
      x-api-token-group:
        - Cloudflare Zero Trust PII Read
        - Notifications Write
        - Notifications Read
        - Account Settings Write
        - Account Settings Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect:
    post:
      description: Creates a new token for integrating with PagerDuty.
      operationId: notification-destinations-with-pager-duty-connect-pager-duty
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_id_response'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Create a token for PagerDuty integration failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_sensitive_id_response'
          description: Token for PagerDuty integration
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create PagerDuty integration token
      tags:
        - Notification Destinations with PagerDuty
      x-api-token-group:
        - Notifications Write
        - Account Settings Write
  /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect/{token_id}:
    get:
      description: Links PagerDuty with the account using the integration token.
      operationId: notification-destinations-with-pager-duty-connect-pager-duty-token
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
        - in: path
          name: token_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_integration-token'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_id_response'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Create a Notification policy response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_id_response'
          description: Create a Notification policy response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Connect PagerDuty
      tags:
        - Notification Destinations with PagerDuty
      x-api-token-group:
        - Notifications Write
        - Account Settings Write
  /accounts/{account_id}/alerting/v3/destinations/webhooks:
    get:
      description: Gets a list of all configured webhook destinations.
      operationId: notification-webhooks-list-webhooks
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_webhooks_components-schemas-response_collection'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: List webhooks response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_webhooks_components-schemas-response_collection'
          description: List webhooks response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List webhooks
      tags:
        - Notification Webhooks
      x-api-token-group:
        - Cloudflare Zero Trust PII Read
        - Notifications Write
        - Notifications Read
        - Account Settings Write
        - Account Settings Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
    post:
      description: Creates a new webhook destination.
      operationId: notification-webhooks-create-a-webhook
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/aaa_components-schemas-name'
                secret:
                  $ref: '#/components/schemas/aaa_secret'
                url:
                  $ref: '#/components/schemas/aaa_url'
              required:
                - name
                - url
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_id_response'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Create a webhook response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_id_response'
          description: Create a webhook response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a webhook
      tags:
        - Notification Webhooks
      x-api-token-group:
        - Notifications Write
        - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
  /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}:
    delete:
      description: Delete a configured webhook destination.
      operationId: notification-webhooks-delete-a-webhook
      parameters:
        - in: path
          name: webhook_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_webhook-id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_api-response-collection'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Delete a webhook response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_api-response-collection'
          description: Delete a webhook response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a webhook
      tags:
        - Notification Webhooks
      x-api-token-group:
        - Notifications Write
        - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
    get:
      description: Get details for a single webhooks destination.
      operationId: notification-webhooks-get-a-webhook
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
        - in: path
          name: webhook_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_webhook-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_schemas-single_response'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Get a webhook response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_schemas-single_response'
          description: Get a webhook response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a webhook
      tags:
        - Notification Webhooks
      x-api-token-group:
        - Cloudflare Zero Trust PII Read
        - Notifications Write
        - Notifications Read
        - Account Settings Write
        - Account Settings Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
    put:
      description: Update a webhook destination.
      operationId: notification-webhooks-update-a-webhook
      parameters:
        - in: path
          name: webhook_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_webhook-id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/aaa_components-schemas-name'
                secret:
                  $ref: '#/components/schemas/aaa_secret'
                url:
                  $ref: '#/components/schemas/aaa_url'
              required:
                - name
                - url
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_id_response'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Update a webhook response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_id_response'
          description: Update a webhook response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a webhook
      tags:
        - Notification Webhooks
      x-api-token-group:
        - Notifications Write
        - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
  /accounts/{account_id}/alerting/v3/history:
    get:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
        - in: query
          name: per_page
          schema:
            $ref: '#/components/schemas/aaa_per_page'
        - in: query
          name: before
          schema:
            $ref: '#/components/schemas/aaa_before'
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: since
          schema:
            description: Limit the returned results to history records newer than the specified date. This must be a timestamp that conforms to RFC3339.
            example: "2022-05-19T20:29:58.679897Z"
            format: date-time
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_history_components-schemas-response_collection'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: List History response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_history_components-schemas-response_collection'
          description: List History response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List History
      tags:
        - Notification History
      x-api-token-group:
        - Cloudflare Zero Trust PII Read
        - Notifications Write
        - Notifications Read
        - Account Settings Write
        - Account Settings Read
  /accounts/{account_id}/alerting/v3/policies:
    get:
      description: Get a list of all Notification policies.
      operationId: notification-policies-list-notification-policies
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_policies_components-schemas-response_collection'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: List Notification policies response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_policies_components-schemas-response_collection'
          description: List Notification policies response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Notification policies
      tags:
        - Notification Policies
      x-api-token-group:
        - Cloudflare Zero Trust PII Read
        - Notifications Write
        - Notifications Read
        - Account Settings Write
        - Account Settings Read
    post:
      description: Creates a new Notification policy.
      operationId: notification-policies-create-a-notification-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                alert_interval:
                  $ref: '#/components/schemas/aaa_alert_interval'
                alert_type:
                  $ref: '#/components/schemas/aaa_alert_type'
                description:
                  $ref: '#/components/schemas/aaa_schemas-description'
                enabled:
                  $ref: '#/components/schemas/aaa_enabled'
                filters:
                  $ref: '#/components/schemas/aaa_filters'
                mechanisms:
                  $ref: '#/components/schemas/aaa_mechanisms'
                name:
                  $ref: '#/components/schemas/aaa_schemas-name'
              required:
                - name
                - alert_type
                - enabled
                - mechanisms
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_id_response'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Create a Notification policy response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_id_response'
          description: Create a Notification policy response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a Notification policy
      tags:
        - Notification Policies
      x-api-token-group:
        - Notifications Write
        - Account Settings Write
  /accounts/{account_id}/alerting/v3/policies/{policy_id}:
    delete:
      description: Delete a Notification policy.
      operationId: notification-policies-delete-a-notification-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_policy-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_api-response-collection'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Delete a Notification policy response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_api-response-collection'
          description: Delete a Notification policy response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a Notification policy
      tags:
        - Notification Policies
      x-api-token-group:
        - Notifications Write
        - Account Settings Write
    get:
      description: Get details for a single policy.
      operationId: notification-policies-get-a-notification-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_policy-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_single_response'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Get a Notification policy response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_single_response'
          description: Get a Notification policy response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a Notification policy
      tags:
        - Notification Policies
      x-api-token-group:
        - Cloudflare Zero Trust PII Read
        - Notifications Write
        - Notifications Read
        - Account Settings Write
        - Account Settings Read
    put:
      description: Update a Notification policy.
      operationId: notification-policies-update-a-notification-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_account-id'
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_policy-id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                alert_interval:
                  $ref: '#/components/schemas/aaa_alert_interval'
                alert_type:
                  $ref: '#/components/schemas/aaa_alert_type'
                description:
                  $ref: '#/components/schemas/aaa_schemas-description'
                enabled:
                  $ref: '#/components/schemas/aaa_enabled'
                filters:
                  $ref: '#/components/schemas/aaa_filters'
                mechanisms:
                  $ref: '#/components/schemas/aaa_mechanisms'
                name:
                  $ref: '#/components/schemas/aaa_schemas-name'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_id_response'
                  - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Update a Notification policy response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_id_response'
          description: Update a Notification policy response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a Notification policy
      tags:
        - Notification Policies
      x-api-token-group:
        - Notifications Write
        - Account Settings Write
  /accounts/{account_id}/audit_logs:
    get:
      description: Gets a list of audit logs for an account. Can be filtered by who made the change, on which zone, and the timeframe of the change.
      operationId: audit-logs-get-account-audit-logs
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_identifier'
        - in: query
          name: id
          schema:
            description: Finds a specific log by its ID.
            example: f174be97-19b1-40d6-954d-70cd5fbd52db
            type: string
        - in: query
          name: export
          schema:
            description: Indicates that this request is an export of logs in CSV format.
            example: true
            type: boolean
        - in: query
          name: action.type
          schema:
            description: Filters by the action type.
            example: add
            type: string
        - in: query
          name: actor.ip
          schema:
            description: Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.
            example: 17.168.228.63
            type: string
        - in: query
          name: actor.email
          schema:
            description: Filters by the email address of the actor that made the change.
            example: alice@example.com
            format: email
            type: string
        - in: query
          name: since
          schema:
            oneOf:
              - description: Limits the returned results to logs newer than the specified date. A `full-date` that conforms to RFC3339.
                example: "2019-04-30"
                format: date
                type: string
              - description: Limits the returned results to logs newer than the specified date. A `date-time` that conforms to RFC3339.
                example: "2019-04-30T01:12:20Z"
                format: date-time
                type: string
        - in: query
          name: before
          schema:
            oneOf:
              - description: Limits the returned results to logs older than the specified date. A `full-date` that conforms to RFC3339.
                example: "2019-04-30"
                format: date
                type: string
              - description: Limits the returned results to logs older than the specified date. A `date-time` that conforms to RFC3339.
                example: "2019-04-30T01:12:20Z"
                format: date-time
                type: string
        - in: query
          name: zone.name
          schema:
            description: Filters by the name of the zone associated to the change.
            example: example.com
            type: string
        - in: query
          name: direction
          schema:
            default: desc
            description: Changes the direction of the chronological sorting.
            enum:
              - desc
              - asc
            example: desc
            type: string
        - in: query
          name: per_page
          schema:
            default: 100
            description: Sets the number of results to return per page.
            example: 25
            maximum: 1000
            minimum: 1
            type: number
        - in: query
          name: page
          schema:
            default: 1
            description: Defines which page of results to return.
            example: 50
            minimum: 1
            type: number
        - in: query
          name: hide_user_logs
          schema:
            default: false
            description: Indicates whether or not to hide user level audit logs.
            type: boolean
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_audit_logs_response_collection'
                  - $ref: '#/components/schemas/aaa_api-response-common-failure'
          description: Get account audit logs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_audit_logs_response_collection'
          description: Get account audit logs response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get account audit logs
      tags:
        - Audit Logs
      x-api-token-group:
        - Account Settings Write
        - Account Settings Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/billing/profile:
    get:
      deprecated: true
      description: Gets the current billing profile for the account.
      operationId: account-billing-profile-(-deprecated)-billing-profile-details
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/bill-subs-api_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/bill-subs-api_billing_response_single'
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Billing Profile Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_billing_response_single'
          description: Billing Profile Details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Billing Profile Details
      tags:
        - Account Billing Profile
      x-api-token-group:
        - Billing Write
        - Billing Read
      x-cfPermissionsRequired:
        enum:
          - '#billing:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/botnet_feed/asn/{asn_id}/day_report:
    get:
      description: Gets all the data the botnet tracking database has for a given ASN registered to user account for given date. If no date is given, it will return results for the previous day.
      operationId: botnet-threat-feed-get-day-report
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dos_identifier'
        - in: path
          name: asn_id
          required: true
          schema:
            $ref: '#/components/schemas/dos_asn'
        - in: query
          name: date
          schema:
            $ref: '#/components/schemas/dos_timestamp'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dos_api-response-common-failure'
          description: Get botnet feed report for day response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dos_api-response-common'
                  - properties:
                      result:
                        properties:
                          cidr:
                            example: 1.1.1.1/32
                            type: string
                          date:
                            example: "2014-01-01T05:20:00.12345Z"
                            format: date-time
                            type: string
                          offense_count:
                            example: 1000
                            type: integer
                        type: object
                    type: object
                type: object
          description: Get botnet feed report for day
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get daily report
      tags:
        - Botnet Threat Feed
      x-api-token-group:
        - DDoS Botnet Feed Write
        - DDoS Botnet Feed Read
  /accounts/{account_id}/botnet_feed/asn/{asn_id}/full_report:
    get:
      description: Gets all the data the botnet threat feed tracking database has for a given ASN registered to user account.
      operationId: botnet-threat-feed-get-full-report
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dos_identifier'
        - in: path
          name: asn_id
          required: true
          schema:
            $ref: '#/components/schemas/dos_asn'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dos_api-response-common-failure'
          description: Get full botnet feed report response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dos_api-response-common'
                  - properties:
                      result:
                        properties:
                          cidr:
                            example: 1.1.1.1/32
                            type: string
                          date:
                            example: "2014-01-01T05:20:00.12345Z"
                            format: date-time
                            type: string
                          offense_count:
                            example: 1000
                            type: integer
                        type: object
                    type: object
                type: object
          description: Get full botnet feed report
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get full report
      tags:
        - Botnet Threat Feed
      x-api-token-group:
        - DDoS Botnet Feed Write
        - DDoS Botnet Feed Read
  /accounts/{account_id}/botnet_feed/configs/asn:
    get:
      description: Gets a list of all ASNs registered for a user for the DDoS Botnet Feed API.
      operationId: botnet-threat-feed-list-asn
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dos_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dos_api-response-common-failure'
          description: Get list of ASNs response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dos_api-response-common'
                  - properties:
                      result:
                        properties:
                          asn:
                            example: 13335
                            type: integer
                        type: object
                    type: object
                type: object
          description: Get list of ASNs response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get list of ASNs
      tags:
        - Botnet Threat Feed
      x-api-token-group:
        - DDoS Botnet Feed Write
        - DDoS Botnet Feed Read
  /accounts/{account_id}/botnet_feed/configs/asn/{asn_id}:
    delete:
      description: Delete an ASN from botnet threat feed for a given user.
      operationId: botnet-threat-feed-delete-asn
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dos_identifier'
        - in: path
          name: asn_id
          required: true
          schema:
            $ref: '#/components/schemas/dos_asn'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dos_api-response-common-failure'
          description: Delete ASN response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dos_api-response-common'
                  - properties:
                      result:
                        properties:
                          asn:
                            example: 13335
                            type: integer
                        type: object
                    type: object
                type: object
          description: Delete ASN response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete an ASN
      tags:
        - Botnet Threat Feed
      x-api-token-group:
        - DDoS Botnet Feed Write
  /accounts/{account_id}/brand-protection/submit:
    post:
      operationId: phishing-url-scanner-submit-suspicious-url-for-scanning
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/intel_identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/intel_url_param'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/intel_phishing-url-submit_components-schemas-single_response'
                  - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Submit suspicious URL for scanning response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_phishing-url-submit_components-schemas-single_response'
          description: Submit suspicious URL for scanning response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Submit suspicious URL for scanning
      tags:
        - Phishing URL Scanner
  /accounts/{account_id}/brand-protection/url-info:
    get:
      operationId: phishing-url-information-get-results-for-a-url-scan
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/intel_identifier'
        - description: Submission ID(s) to filter submission results by.
          example:
            - 100
            - 200
          explode: true
          in: query
          name: url_id
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Submission URL(s) to filter submission results by.
          example:
            - https://foo.com
            - https://bar.com
          explode: true
          in: query
          name: url
          schema:
            items:
              type: string
            type: array
          style: form
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/intel_phishing-url-info_components-schemas-single_response'
                  - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Get results for a URL scan response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_phishing-url-info_components-schemas-single_response'
          description: Get results for a URL scan response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get results for a URL scan
      tags:
        - Phishing URL Information
  /accounts/{account_id}/calls/apps:
    get:
      description: Lists all apps in the Cloudflare account
      operationId: calls-apps-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_api-response-common-failure'
          description: List apps response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_app_response_collection'
          description: List apps response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform List apps
      tags:
        - Calls Apps
      x-api-token-group:
        - Calls Write
        - Calls Read
    post:
      description: Creates a new Cloudflare calls app. An app is an unique enviroment where each Session can access all Tracks within the app.
      operationId: calls-apps-create-a-new-app
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/calls_app_editable_fields'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_app_response_single_with_secret'
          description: Created a new app
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Create a new app
      tags:
        - Calls Apps
      x-api-token-group:
        - Calls Write
  /accounts/{account_id}/calls/apps/{app_id}:
    delete:
      description: Deletes an app from Cloudflare Calls
      operationId: calls-apps-delete-app
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_account_identifier'
      responses:
        4XX:
          content:
            application/json: {}
          description: Delete app response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_app_response_single'
          description: Delete app response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Delete app
      tags:
        - Calls Apps
      x-api-token-group:
        - Calls Write
    get:
      description: Fetches details for a single Calls app.
      operationId: calls-apps-retrieve-app-details
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_api-response-common-failure'
          description: Retrieve app details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_app_response_single'
          description: Retrieve app details response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Retrieve app details
      tags:
        - Calls Apps
      x-api-token-group:
        - Calls Write
        - Calls Read
    put:
      description: Edit details for a single app.
      operationId: calls-apps-update-app-details
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/calls_app_editable_fields'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_api-response-common-failure'
          description: Edit app details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_app_response_single'
          description: Edit app details response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Edit app details
      tags:
        - Calls Apps
      x-api-token-group:
        - Calls Write
  /accounts/{account_id}/calls/turn_keys:
    get:
      description: Lists all TURN keys in the Cloudflare account
      operationId: calls-turn-key-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_api-response-common-failure'
          description: List TURN key response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_turn_key_collection'
          description: List TURN key response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform List TURN Keys
      tags:
        - Calls TURN Keys
      x-api-token-group:
        - Calls Write
        - Calls Read
    post:
      description: Creates a new Cloudflare Calls TURN key.
      operationId: calls-turn-key-create
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/calls_turn_key_editable_fields'
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_turn_key_with_key'
          description: Created a new TURN key
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Create a new TURN key
      tags:
        - Calls TURN Keys
      x-api-token-group:
        - Calls Write
  /accounts/{account_id}/calls/turn_keys/{key_id}:
    delete:
      description: Deletes a TURN key from Cloudflare Calls
      operationId: calls-delete-turn-key
      parameters:
        - in: path
          name: key_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_account_identifier'
      responses:
        4XX:
          content:
            application/json: {}
          description: Delete TURN key response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_turn_key_response_single'
          description: Delete TURN key response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Delete TURN key
      tags:
        - Calls TURN Keys
      x-api-token-group:
        - Calls Write
    get:
      description: Fetches details for a single TURN key.
      operationId: calls-retrieve-turn-key-details
      parameters:
        - in: path
          name: key_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_api-response-common-failure'
          description: Retrieve TURN key details failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_turn_key_response_single'
          description: Retrieve TURN key details response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Retrieve TURN key details
      tags:
        - Calls TURN Keys
      x-api-token-group:
        - Calls Write
        - Calls Read
    put:
      description: Edit details for a single TURN key.
      operationId: calls-update-turn-key
      parameters:
        - in: path
          name: key_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/calls_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/calls_turn_key_editable_fields'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_api-response-common-failure'
          description: Edit TURN key details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_turn_key_response_single'
          description: Edit TURN key details response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Edit TURN key details
      tags:
        - Calls TURN Keys
      x-api-token-group:
        - Calls Write
  /accounts/{account_id}/cfd_tunnel:
    get:
      description: Lists and filters Cloudflare Tunnels in an account.
      operationId: cloudflare-tunnel-list-cloudflare-tunnels
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: query
          name: name
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_name'
        - in: query
          name: is_deleted
          schema:
            description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.
            example: true
            type: boolean
        - in: query
          name: existed_at
          schema:
            $ref: '#/components/schemas/tunnel_existed_at'
        - in: query
          name: uuid
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
        - in: query
          name: was_active_at
          schema:
            example: "2009-11-10T23:00:00Z"
            format: date-time
            type: string
        - in: query
          name: was_inactive_at
          schema:
            example: "2009-11-10T23:00:00Z"
            format: date-time
            type: string
        - in: query
          name: include_prefix
          schema:
            example: vpc1-
            type: string
        - in: query
          name: exclude_prefix
          schema:
            example: vpc1-
            type: string
        - in: query
          name: status
          schema:
            $ref: '#/components/schemas/tunnel_status'
        - in: query
          name: per_page
          schema:
            $ref: '#/components/schemas/tunnel_per_page'
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel-response-collection'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: List Cloudflare Tunnels response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-collection'
          description: List Cloudflare Tunnels response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform List Cloudflare Tunnels
      tags:
        - Cloudflare Tunnel
      x-api-token-group:
        - Cloudflare One Connectors Write
        - Cloudflare One Connectors Read
        - Cloudflare One cloudflared Connectors Write
        - Cloudflare One cloudflared Connectors Read
        - Argo Tunnel Write
        - Argo Tunnel Read
    post:
      description: Creates a new Cloudflare Tunnel in an account.
      operationId: cloudflare-tunnel-create-a-cloudflare-tunnel
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config_src:
                  $ref: '#/components/schemas/tunnel_config_src'
                name:
                  $ref: '#/components/schemas/tunnel_tunnel_name'
                tunnel_secret:
                  $ref: '#/components/schemas/tunnel_tunnel_secret'
              required:
                - name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Create a Cloudflare Tunnel response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Create a Cloudflare Tunnel response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Create a Cloudflare Tunnel
      tags:
        - Cloudflare Tunnel
      x-api-token-group:
        - Cloudflare One Connectors Write
        - Cloudflare One cloudflared Connectors Write
        - Argo Tunnel Write
  /accounts/{account_id}/cfd_tunnel/{tunnel_id}:
    delete:
      description: Deletes a Cloudflare Tunnel from an account.
      operationId: cloudflare-tunnel-delete-a-cloudflare-tunnel
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Delete a Cloudflare Tunnel response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Delete a Cloudflare Tunnel response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Delete a Cloudflare Tunnel
      tags:
        - Cloudflare Tunnel
      x-api-token-group:
        - Cloudflare One Connectors Write
        - Cloudflare One cloudflared Connectors Write
        - Argo Tunnel Write
    get:
      description: Fetches a single Cloudflare Tunnel.
      operationId: cloudflare-tunnel-get-a-cloudflare-tunnel
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get a Cloudflare Tunnel response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Get a Cloudflare Tunnel response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get a Cloudflare Tunnel
      tags:
        - Cloudflare Tunnel
      x-api-token-group:
        - Cloudflare One Connectors Write
        - Cloudflare One Connectors Read
        - Cloudflare One cloudflared Connectors Write
        - Cloudflare One cloudflared Connectors Read
        - Argo Tunnel Write
        - Argo Tunnel Read
    patch:
      description: Updates an existing Cloudflare Tunnel.
      operationId: cloudflare-tunnel-update-a-cloudflare-tunnel
      parameters:
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/tunnel_tunnel_name'
                tunnel_secret:
                  $ref: '#/components/schemas/tunnel_tunnel_secret'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Update a Cloudflare Tunnel response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Update a Cloudflare Tunnel response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Update a Cloudflare Tunnel
      tags:
        - Cloudflare Tunnel
      x-api-token-group:
        - Cloudflare One Connectors Write
        - Cloudflare One cloudflared Connectors Write
        - Argo Tunnel Write
  /accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations:
    get:
      description: Gets the configuration for a remotely-managed tunnel
      operationId: cloudflare-tunnel-configuration-get-configuration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_identifier'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_configuration_response'
          description: Get configuration response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get configuration
      tags:
        - Cloudflare Tunnel Configuration
    put:
      description: Adds or updates the configuration for a remotely-managed tunnel.
      operationId: cloudflare-tunnel-configuration-put-configuration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_identifier'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config:
                  $ref: '#/components/schemas/tunnel_config'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Put configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_configuration_response'
          description: Put configuration response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Put configuration
      tags:
        - Cloudflare Tunnel Configuration
  /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections:
    delete:
      description: Removes a connection (aka Cloudflare Tunnel Connector) from a Cloudflare Tunnel independently of its current state. If no connector id (client_id) is provided all connectors will be removed. We recommend running this command after rotating tokens.
      operationId: cloudflare-tunnel-clean-up-cloudflare-tunnel-connections
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
        - in: query
          name: client_id
          schema:
            $ref: '#/components/schemas/tunnel_client_id'
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_empty_response'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Clean up Cloudflare Tunnel connections response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_empty_response'
          description: Clean up Cloudflare Tunnel connections response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Clean up Cloudflare Tunnel connections
      tags:
        - Cloudflare Tunnel
    get:
      description: Fetches connection details for a Cloudflare Tunnel.
      operationId: cloudflare-tunnel-list-cloudflare-tunnel-connections
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel_connections_response'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: List Cloudflare Tunnel connections response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel_connections_response'
          description: List Cloudflare Tunnel connections response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform List Cloudflare Tunnel connections
      tags:
        - Cloudflare Tunnel
  /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectors/{connector_id}:
    get:
      description: Fetches connector and connection details for a Cloudflare Tunnel.
      operationId: cloudflare-tunnel-get-cloudflare-tunnel-connector
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
        - in: path
          name: connector_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_client_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel_client_response'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get Cloudflare Tunnel connector response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel_client_response'
          description: Get Cloudflare Tunnel connector response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get Cloudflare Tunnel connector
      tags:
        - Cloudflare Tunnel
  /accounts/{account_id}/cfd_tunnel/{tunnel_id}/management:
    post:
      description: Gets a management token used to access the management resources (i.e. Streaming Logs) of a tunnel.
      operationId: cloudflare-tunnel-get-a-cloudflare-tunnel-management-token
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                resources:
                  items:
                    $ref: '#/components/schemas/tunnel_management-resources'
                  type: array
              required:
                - resources
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel_response_token'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Cloudflare API response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel_response_token'
          description: Get a Cloudflare Tunnel management token response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get a Cloudflare Tunnel management token
      tags:
        - Cloudflare Tunnel
  /accounts/{account_id}/cfd_tunnel/{tunnel_id}/token:
    get:
      description: Gets the token used to associate cloudflared with a specific tunnel.
      operationId: cloudflare-tunnel-get-a-cloudflare-tunnel-token
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel_response_token'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get a Cloudflare Tunnel token response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel_response_token'
          description: Get a Cloudflare Tunnel token response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get a Cloudflare Tunnel token
      tags:
        - Cloudflare Tunnel
  /accounts/{account_id}/challenges/widgets:
    get:
      description: Lists all turnstile widgets of an account.
      operationId: accounts-turnstile-widgets-list
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/turnstile_api-response-common-failure'
          description: List Turnstile Widgets Error
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/turnstile_api-response-common'
                  - properties:
                      result_info:
                        $ref: '#/components/schemas/turnstile_result_info'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/turnstile_widget_list'
                        type: array
          description: List Turnstile Widgets
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Turnstile Widgets
      tags:
        - Turnstile
      x-api-token-group:
        - Turnstile Sites Read
        - Account Settings Read
    parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/turnstile_identifier'
      - in: query
        name: page
        schema:
          default: 1
          description: Page number of paginated results.
          minimum: 1
          type: number
      - in: query
        name: per_page
        schema:
          default: 25
          description: Number of items per page.
          maximum: 1000
          minimum: 5
          type: number
      - in: query
        name: order
        schema:
          description: Field to order widgets by.
          enum:
            - id
            - sitekey
            - name
            - created_on
            - modified_on
          example: id
      - in: query
        name: direction
        schema:
          description: Direction to order widgets.
          enum:
            - asc
            - desc
          example: asc
    post:
      description: Lists challenge widgets.
      operationId: accounts-turnstile-widget-create
      requestBody:
        content:
          application/json:
            schema:
              properties:
                bot_fight_mode:
                  $ref: '#/components/schemas/turnstile_bot_fight_mode'
                clearance_level:
                  $ref: '#/components/schemas/turnstile_clearance_level'
                domains:
                  $ref: '#/components/schemas/turnstile_domains'
                mode:
                  $ref: '#/components/schemas/turnstile_mode'
                name:
                  $ref: '#/components/schemas/turnstile_name'
                offlabel:
                  $ref: '#/components/schemas/turnstile_offlabel'
                region:
                  $ref: '#/components/schemas/turnstile_region'
              required:
                - name
                - mode
                - domains
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/turnstile_api-response-common-failure'
          description: Create Turnstile Widget Response Error
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/turnstile_api-response-common'
                  - properties:
                      result_info:
                        $ref: '#/components/schemas/turnstile_result_info'
                  - properties:
                      result:
                        $ref: '#/components/schemas/turnstile_widget_detail'
          description: Create Turnstile Widget Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a Turnstile Widget
      tags:
        - Turnstile
  /accounts/{account_id}/challenges/widgets/{sitekey}:
    delete:
      description: Destroy a Turnstile Widget.
      operationId: accounts-turnstile-widget-delete
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/turnstile_api-response-common-failure'
          description: Delete Turnstile Widget Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/turnstile_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/turnstile_widget_detail'
          description: Delete Turnstile Widget Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a Turnstile Widget
      tags:
        - Turnstile
    get:
      description: Show a single challenge widget configuration.
      operationId: accounts-turnstile-widget-get
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/turnstile_api-response-common-failure'
          description: Turnstile Widget Details Response Error
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/turnstile_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/turnstile_widget_detail'
          description: Turnstile Widget Details Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Turnstile Widget Details
      tags:
        - Turnstile
      x-api-token-group:
        - Turnstile Sites Read
        - Account Settings Read
    parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/turnstile_identifier'
      - in: path
        name: sitekey
        required: true
        schema:
          $ref: '#/components/schemas/turnstile_sitekey'
    put:
      description: Update the configuration of a widget.
      operationId: accounts-turnstile-widget-update
      requestBody:
        content:
          application/json:
            schema:
              properties:
                bot_fight_mode:
                  $ref: '#/components/schemas/turnstile_bot_fight_mode'
                clearance_level:
                  $ref: '#/components/schemas/turnstile_clearance_level'
                domains:
                  $ref: '#/components/schemas/turnstile_domains'
                mode:
                  $ref: '#/components/schemas/turnstile_mode'
                name:
                  $ref: '#/components/schemas/turnstile_name'
                offlabel:
                  $ref: '#/components/schemas/turnstile_offlabel'
              required:
                - name
                - mode
                - domains
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/turnstile_api-response-common-failure'
          description: Update Turnstile Widget Response Error
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/turnstile_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/turnstile_widget_detail'
          description: Update Turnstile Widget Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a Turnstile Widget
      tags:
        - Turnstile
  /accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret:
    parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/turnstile_identifier'
      - in: path
        name: sitekey
        required: true
        schema:
          $ref: '#/components/schemas/turnstile_sitekey'
    post:
      description: |
        Generate a new secret key for this widget. If `invalidate_immediately`
        is set to `false`, the previous secret remains valid for 2 hours.

        Note that secrets cannot be rotated again during the grace period.
      operationId: accounts-turnstile-widget-rotate-secret
      requestBody:
        content:
          application/json:
            schema:
              properties:
                invalidate_immediately:
                  $ref: '#/components/schemas/turnstile_invalidate_immediately'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/turnstile_api-response-common-failure'
          description: Rotate Secret Response Error
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/turnstile_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/turnstile_widget_detail'
          description: Rotate Secret Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Rotate Secret for a Turnstile Widget
      tags:
        - Turnstile
  /accounts/{account_id}/custom_ns:
    get:
      description: List an account's custom nameservers.
      operationId: account-level-custom-nameservers-list-account-custom-nameservers
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-custom-nameservers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-custom-nameservers_acns_response_collection'
                  - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure'
          description: List Account Custom Nameservers response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-custom-nameservers_acns_response_collection'
          description: List Account Custom Nameservers response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Account Custom Nameservers
      tags:
        - Account-Level Custom Nameservers
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: false
    post:
      operationId: account-level-custom-nameservers-add-account-custom-nameserver
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-custom-nameservers_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-custom-nameservers_CustomNSInput'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-custom-nameservers_acns_response_single'
                  - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure'
          description: Add Account Custom Nameserver response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-custom-nameservers_acns_response_single'
          description: Add Account Custom Nameserver response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Add Account Custom Nameserver
      tags:
        - Account-Level Custom Nameservers
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/custom_ns/{custom_ns_id}:
    delete:
      operationId: account-level-custom-nameservers-delete-account-custom-nameserver
      parameters:
        - in: path
          name: custom_ns_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-custom-nameservers_ns_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-custom-nameservers_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-custom-nameservers_empty_response'
                  - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure'
          description: Delete Account Custom Nameserver response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-custom-nameservers_empty_response'
          description: Delete Account Custom Nameserver response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Account Custom Nameserver
      tags:
        - Account-Level Custom Nameservers
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/custom_ns/availability:
    get:
      operationId: account-level-custom-nameservers-get-eligible-zones-for-account-custom-nameservers
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-custom-nameservers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-custom-nameservers_availability_response'
                  - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure'
          description: Get Eligible Zones for Account Custom Nameservers response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-custom-nameservers_availability_response'
          description: Get Eligible Zones for Account Custom Nameservers response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Eligible Zones for Account Custom Nameservers
      tags:
        - Account-Level Custom Nameservers
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/d1/database:
    get:
      description: Returns a list of D1 databases.
      operationId: cloudflare-d1-list-databases
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_account-identifier'
        - in: query
          name: name
          schema:
            description: a database name to search for.
            type: string
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 1000
            description: Number of items per page.
            maximum: 10000
            minimum: 10
            type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
          description: List D1 databases response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/d1_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/d1_database-response'
                        type: array
                      result_info:
                        properties:
                          count:
                            description: Total number of results for the requested service
                            example: 1
                            type: number
                          page:
                            description: Current page within paginated list of results
                            example: 1
                            type: number
                          per_page:
                            description: Number of results per page of results
                            example: 20
                            type: number
                          total_count:
                            description: Total results available without any search parameters
                            example: 2000
                            type: number
                        type: object
          description: List D1 databases response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List D1 Databases
      tags:
        - D1
      x-api-token-group:
        - D1 Read
        - D1 Write
    post:
      description: Returns the created D1 database.
      operationId: cloudflare-d1-create-database
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_account-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/d1_database-name'
                primary_location_hint:
                  $ref: '#/components/schemas/d1_primary-location-hint'
              required:
                - name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
          description: Database details response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/d1_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/d1_database-details-response'
          description: Returns the created D1 database's metadata
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create D1 Database
      tags:
        - D1
      x-api-token-group:
        - D1 Write
  /accounts/{account_id}/d1/database/{database_id}:
    delete:
      description: Deletes the specified D1 database.
      operationId: cloudflare-d1-delete-database
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_account-identifier'
        - in: path
          name: database_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_database-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
          description: Delete D1 database response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/d1_api-response-common'
                  - properties:
                      result:
                        enum:
                          - 
                        nullable: true
                        type: object
          description: Delete D1 database response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete D1 Database
      tags:
        - D1
      x-api-token-group:
        - D1 Write
    get:
      description: Returns the specified D1 database.
      operationId: cloudflare-d1-get-database
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_account-identifier'
        - in: path
          name: database_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_database-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
          description: Database details response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/d1_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/d1_database-details-response'
          description: Database details response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get D1 Database
      tags:
        - D1
      x-api-token-group:
        - D1 Read
        - D1 Write
  /accounts/{account_id}/d1/database/{database_id}/export:
    post:
      description: |
        Returns a URL where the SQL contents of your D1 can be downloaded. Note: this process may take
        some time for larger DBs, during which your D1 will be unavailable to serve queries. To avoid
        blocking your DB unnecessarily, an in-progress export must be continually polled or will automatically cancel.
      operationId: cloudflare-d1-export-database
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_account-identifier'
        - in: path
          name: database_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_database-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                current_bookmark:
                  description: To poll an in-progress export, provide the current bookmark (returned by your first polling response)
                  type: string
                dump_options:
                  properties:
                    no_data:
                      description: Export only the table definitions, not their contents
                      type: boolean
                    no_schema:
                      description: Export only each table's contents, not its definition
                      type: boolean
                    tables:
                      description: 'Filter the export to just one or more tables. Passing an empty array is the same as not passing anything and means: export all tables.'
                      items:
                        type: string
                      type: array
                  type: object
                output_format:
                  description: Specifies that you will poll this endpoint until the export completes
                  enum:
                    - polling
                  type: string
              required:
                - output_format
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
          description: Poll failed (API error)
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/d1_api-response-common'
                  - properties:
                      result:
                        properties:
                          at_bookmark:
                            description: The current time-travel bookmark for your D1, used to poll for updates. Will not change for the duration of the export task.
                            type: string
                          error:
                            description: Only present when status = 'error'. Contains the error message.
                            type: string
                          messages:
                            description: Logs since the last time you polled
                            items:
                              type: string
                            type: array
                          result:
                            description: Only present when status = 'complete'
                            properties:
                              filename:
                                description: The generated SQL filename.
                                type: string
                              signed_url:
                                description: The URL to download the exported SQL. Available for one hour.
                                type: string
                            type: object
                          status:
                            enum:
                              - complete
                              - error
                            type: string
                          success:
                            type: boolean
                          type:
                            enum:
                              - export
                            type: string
                        type: object
          description: Polled successfully, task no longer running (errored or complete)
        "202":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/d1_api-response-common'
                  - properties:
                      result:
                        properties:
                          at_bookmark:
                            description: The current time-travel bookmark for your D1, used to poll for updates. Will not change for the duration of the export task.
                            type: string
                          messages:
                            description: Logs since the last time you polled
                            items:
                              type: string
                            type: array
                          status:
                            enum:
                              - active
                            type: string
                          success:
                            type: boolean
                          type:
                            enum:
                              - export
                            type: string
                        type: object
          description: Polled successfully, task is currently running
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Export D1 Database as SQL
      tags:
        - D1
  /accounts/{account_id}/d1/database/{database_id}/import:
    post:
      description: |
        Generates a temporary URL for uploading an SQL file to, then instructing the D1 to import it
        and polling it for status updates. Imports block the D1 for their duration.
      operationId: cloudflare-d1-import-database
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_account-identifier'
        - in: path
          name: database_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_database-identifier'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - properties:
                    action:
                      description: Indicates you have a new SQL file to upload.
                      enum:
                        - init
                      type: string
                    etag:
                      description: Required when action is 'init' or 'ingest'. An md5 hash of the file you're uploading. Used to check if it already exists, and validate its contents before ingesting.
                      type: string
                  required:
                    - action
                    - etag
                  type: object
                - properties:
                    action:
                      description: Indicates you've finished uploading to tell the D1 to start consuming it
                      enum:
                        - ingest
                      type: string
                    etag:
                      description: An md5 hash of the file you're uploading. Used to check if it already exists, and validate its contents before ingesting.
                      type: string
                    filename:
                      description: The filename you have successfully uploaded.
                      type: string
                  required:
                    - action
                    - etag
                    - filename
                  type: object
                - properties:
                    action:
                      description: Indicates you've finished uploading to tell the D1 to start consuming it
                      enum:
                        - poll
                      type: string
                    current_bookmark:
                      description: This identifies the currently-running import, checking its status.
                      type: string
                  required:
                    - action
                    - current_bookmark
                  type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
          description: Poll failed (API error)
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/d1_api-response-common'
                  - properties:
                      result:
                        properties:
                          at_bookmark:
                            description: The current time-travel bookmark for your D1, used to poll for updates. Will not change for the duration of the import. Only returned if an import process is currently running or recently finished.
                            type: string
                          error:
                            description: Only present when status = 'error'. Contains the error message that prevented the import from succeeding.
                            type: string
                          filename:
                            description: Derived from the database ID and etag, to use in avoiding repeated uploads. Only returned when for the 'init' action.
                            type: string
                          messages:
                            description: Logs since the last time you polled
                            items:
                              type: string
                            type: array
                          result:
                            description: Only present when status = 'complete'
                            properties:
                              final_bookmark:
                                description: The time-travel bookmark if you need restore your D1 to directly after the import succeeded.
                                type: string
                              meta:
                                $ref: '#/components/schemas/d1_query-meta'
                              num_queries:
                                description: The total number of queries that were executed during the import.
                                type: number
                            type: object
                          status:
                            enum:
                              - complete
                              - error
                            type: string
                          success:
                            type: boolean
                          type:
                            enum:
                              - import
                            type: string
                          upload_url:
                            description: The R2 presigned URL to use for uploading. Only returned when for the 'init' action.
                            type: string
                        type: object
          description: Successful action. Import is either ready to start, under way, or finished (succeeded or failed).
        "202":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/d1_api-response-common'
                  - properties:
                      result:
                        properties:
                          at_bookmark:
                            description: The current time-travel bookmark for your D1, used to poll for updates. Will not change for the duration of the import.
                            type: string
                          messages:
                            description: Logs since the last time you polled
                            items:
                              type: string
                            type: array
                          status:
                            enum:
                              - active
                            type: string
                          success:
                            type: boolean
                          type:
                            enum:
                              - import
                            type: string
                        type: object
          description: Polled successfully, task is currently running
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Import SQL into your D1 Database
      tags:
        - D1
  /accounts/{account_id}/d1/database/{database_id}/query:
    post:
      description: Returns the query result as an object.
      operationId: cloudflare-d1-query-database
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_account-identifier'
        - in: path
          name: database_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_database-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                params:
                  $ref: '#/components/schemas/d1_params'
                sql:
                  $ref: '#/components/schemas/d1_sql'
              required:
                - sql
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
          description: Query response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/d1_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/d1_query-result-response'
                        type: array
          description: Query response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Query D1 Database
      tags:
        - D1
      x-api-token-group:
        - D1 Read
        - D1 Write
  /accounts/{account_id}/d1/database/{database_id}/raw:
    post:
      description: Returns the query result rows as arrays rather than objects. This is a performance-optimized version of the /query endpoint.
      operationId: cloudflare-d1-raw-database-query
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_account-identifier'
        - in: path
          name: database_id
          required: true
          schema:
            $ref: '#/components/schemas/d1_database-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                params:
                  $ref: '#/components/schemas/d1_params'
                sql:
                  $ref: '#/components/schemas/d1_sql'
              required:
                - sql
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
          description: Query response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/d1_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/d1_raw-result-response'
                        type: array
          description: Raw query response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Raw D1 Database query
      tags:
        - D1
  /accounts/{account_id}/devices:
    get:
      description: Fetches a list of enrolled devices.
      operationId: devices-list-devices
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_devices_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: List devices response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_devices_response'
          description: List devices response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List devices
      tags:
        - Devices
      x-api-token-group:
        - Teams Read
        - Teams Write
  /accounts/{account_id}/devices/{device_id}:
    get:
      description: Fetches details for a single device.
      operationId: devices-device-details
      parameters:
        - in: path
          name: device_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_device_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get device details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_device_response'
          description: Get device details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get device details
      tags:
        - Devices
      x-api-token-group:
        - Teams Read
        - Teams Write
  /accounts/{account_id}/devices/{device_id}/override_codes:
    get:
      description: Fetches a 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:
        - in: path
          name: device_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_override_codes_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get an admin override code for a device response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_override_codes_response'
          description: Get an admin override code for a device response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an admin override code for a device
      tags:
        - Devices
      x-api-token-group:
        - Teams Read
        - Teams Write
  /accounts/{account_id}/devices/dex_tests:
    get:
      description: Fetch all DEX tests.
      operationId: device-dex-test-details
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_dex-single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Device DEX test response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_dex-response_collection'
          description: Device DEX test details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Device DEX tests
      tags:
        - Device DEX Tests
      x-api-token-group:
        - Cloudflare DEX Write
        - Cloudflare DEX Read
        - Teams Report
        - Teams Read
    post:
      description: Create a DEX test.
      operationId: device-dex-test-create-device-dex-test
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_dex-single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update Dex test response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_dex-single_response'
          description: Update Dex test response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Device DEX test
      tags:
        - Device DEX Tests
      x-api-token-group:
        - Cloudflare DEX Write
  /accounts/{account_id}/devices/dex_tests/{dex_test_id}:
    delete:
      description: Delete a Device DEX test. Returns the remaining device dex tests for the account.
      operationId: device-dex-test-delete-device-dex-test
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
        - in: path
          name: dex_test_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_dex-response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Delete DEX test response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_dex-response_collection'
          description: Delete Device DEX test response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Device DEX test
      tags:
        - Device DEX Tests
      x-api-token-group:
        - Cloudflare DEX Write
    get:
      description: Fetch a single DEX test.
      operationId: device-dex-test-get-device-dex-test
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
        - in: path
          name: dex_test_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_dex-single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Device DEX test response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_dex-single_response'
          description: Device DEX test details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Device DEX test
      tags:
        - Device DEX Tests
      x-api-token-group:
        - Cloudflare DEX Write
        - Cloudflare DEX Read
        - Teams Report
        - Teams Read
    put:
      description: Update a DEX test.
      operationId: device-dex-test-update-device-dex-test
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
        - in: path
          name: dex_test_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_dex-single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update Dex test response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_dex-single_response'
          description: Update Dex test response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Device DEX test
      tags:
        - Device DEX Tests
      x-api-token-group:
        - Cloudflare DEX Write
  /accounts/{account_id}/devices/networks:
    get:
      description: Fetches a list of managed networks for an account.
      operationId: device-managed-networks-list-device-managed-networks
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_components-schemas-response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: List your device managed networks response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_components-schemas-response_collection'
          description: List your device managed networks response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List your device managed networks
      tags:
        - Device Managed Networks
      x-api-token-group:
        - Teams Read
        - Teams Write
    post:
      description: Creates a new device managed network.
      operationId: device-managed-networks-create-device-managed-network
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config:
                  $ref: '#/components/schemas/teams-devices_schemas-config_request'
                name:
                  $ref: '#/components/schemas/teams-devices_device-managed-networks_components-schemas-name'
                type:
                  $ref: '#/components/schemas/teams-devices_components-schemas-type'
              required:
                - name
                - type
                - config
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Create a device managed networks response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
          description: Create a device managed networks response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a device managed network
      tags:
        - Device Managed Networks
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/devices/networks/{network_id}:
    delete:
      description: Deletes a device managed network and fetches a list of the remaining device managed networks for an account.
      operationId: device-managed-networks-delete-device-managed-network
      parameters:
        - in: path
          name: network_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_components-schemas-response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Delete a device managed network response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_components-schemas-response_collection'
          description: Delete a device managed network response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a device managed network
      tags:
        - Device Managed Networks
      x-api-token-group:
        - Teams Write
    get:
      description: Fetches details for a single managed network.
      operationId: device-managed-networks-device-managed-network-details
      parameters:
        - in: path
          name: network_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get device managed network details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
          description: Get device managed network details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get device managed network details
      tags:
        - Device Managed Networks
      x-api-token-group:
        - Teams Read
        - Teams Write
    put:
      description: Updates a configured device managed network.
      operationId: device-managed-networks-update-device-managed-network
      parameters:
        - in: path
          name: network_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config:
                  $ref: '#/components/schemas/teams-devices_schemas-config_request'
                name:
                  $ref: '#/components/schemas/teams-devices_device-managed-networks_components-schemas-name'
                type:
                  $ref: '#/components/schemas/teams-devices_components-schemas-type'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update a device managed network response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
          description: Update a device managed network response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a device managed network
      tags:
        - Device Managed Networks
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/devices/policies:
    get:
      description: Fetches a list of the device settings profiles for an account.
      operationId: devices-list-device-settings-policies
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_device_settings_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: List device settings profiles response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_device_settings_response_collection'
          description: List device settings profiles response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List device settings profiles
      tags:
        - Devices
      x-api-token-group:
        - Teams Read
        - Teams Write
  /accounts/{account_id}/devices/policy:
    get:
      description: Fetches the default device settings profile for an account.
      operationId: devices-get-default-device-settings-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_default_device_settings_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get the default device settings profile response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_default_device_settings_response'
          description: Get the default device settings profile response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get the default device settings profile
      tags:
        - Devices
      x-api-token-group:
        - Teams Read
        - Teams Write
    patch:
      description: Updates the default device settings profile for an account.
      operationId: devices-update-default-device-settings-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                allow_mode_switch:
                  $ref: '#/components/schemas/teams-devices_allow_mode_switch'
                allow_updates:
                  $ref: '#/components/schemas/teams-devices_allow_updates'
                allowed_to_leave:
                  $ref: '#/components/schemas/teams-devices_allowed_to_leave'
                auto_connect:
                  $ref: '#/components/schemas/teams-devices_auto_connect'
                captive_portal:
                  $ref: '#/components/schemas/teams-devices_captive_portal'
                disable_auto_fallback:
                  $ref: '#/components/schemas/teams-devices_disable_auto_fallback'
                exclude_office_ips:
                  $ref: '#/components/schemas/teams-devices_exclude_office_ips'
                service_mode_v2:
                  $ref: '#/components/schemas/teams-devices_service_mode_v2'
                support_url:
                  $ref: '#/components/schemas/teams-devices_support_url'
                switch_locked:
                  $ref: '#/components/schemas/teams-devices_switch_locked'
                tunnel_protocol:
                  $ref: '#/components/schemas/teams-devices_tunnel_protocol'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_default_device_settings_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update the default device settings profile response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_default_device_settings_response'
          description: Update the default device settings profile response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update the default device settings profile
      tags:
        - Devices
      x-api-token-group:
        - Teams Write
    post:
      description: Creates a device settings profile to be applied to certain devices matching the criteria.
      operationId: devices-create-device-settings-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                allow_mode_switch:
                  $ref: '#/components/schemas/teams-devices_allow_mode_switch'
                allow_updates:
                  $ref: '#/components/schemas/teams-devices_allow_updates'
                allowed_to_leave:
                  $ref: '#/components/schemas/teams-devices_allowed_to_leave'
                auto_connect:
                  $ref: '#/components/schemas/teams-devices_auto_connect'
                captive_portal:
                  $ref: '#/components/schemas/teams-devices_captive_portal'
                description:
                  $ref: '#/components/schemas/teams-devices_schemas-description'
                disable_auto_fallback:
                  $ref: '#/components/schemas/teams-devices_disable_auto_fallback'
                enabled:
                  description: Whether the policy will be applied to matching devices.
                  example: true
                  type: boolean
                exclude_office_ips:
                  $ref: '#/components/schemas/teams-devices_exclude_office_ips'
                lan_allow_minutes:
                  $ref: '#/components/schemas/teams-devices_lan_allow_minutes'
                lan_allow_subnet_size:
                  $ref: '#/components/schemas/teams-devices_lan_allow_subnet_size'
                match:
                  $ref: '#/components/schemas/teams-devices_schemas-match'
                name:
                  description: The name of the device settings profile.
                  example: Allow Developers
                  maxLength: 100
                  type: string
                precedence:
                  $ref: '#/components/schemas/teams-devices_precedence'
                service_mode_v2:
                  $ref: '#/components/schemas/teams-devices_service_mode_v2'
                support_url:
                  $ref: '#/components/schemas/teams-devices_support_url'
                switch_locked:
                  $ref: '#/components/schemas/teams-devices_switch_locked'
                tunnel_protocol:
                  $ref: '#/components/schemas/teams-devices_tunnel_protocol'
              required:
                - name
                - precedence
                - match
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_device_settings_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Create a device settings profile response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_device_settings_response'
          description: Create a device settings profile response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a device settings profile
      tags:
        - Devices
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/devices/policy/{policy_id}:
    delete:
      description: Deletes a device settings profile and fetches a list of the remaining profiles for an account.
      operationId: devices-delete-device-settings-policy
      parameters:
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_device_settings_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Delete a device settings profile response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_device_settings_response_collection'
          description: Delete a device settings profile response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a device settings profile
      tags:
        - Devices
    get:
      description: Fetches a device settings profile by ID.
      operationId: devices-get-device-settings-policy-by-id
      parameters:
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_device_settings_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get device settings profile by ID response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_device_settings_response'
          description: Get device settings profile by ID response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get device settings profile by ID
      tags:
        - Devices
    patch:
      description: Updates a configured device settings profile.
      operationId: devices-update-device-settings-policy
      parameters:
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                allow_mode_switch:
                  $ref: '#/components/schemas/teams-devices_allow_mode_switch'
                allow_updates:
                  $ref: '#/components/schemas/teams-devices_allow_updates'
                allowed_to_leave:
                  $ref: '#/components/schemas/teams-devices_allowed_to_leave'
                auto_connect:
                  $ref: '#/components/schemas/teams-devices_auto_connect'
                captive_portal:
                  $ref: '#/components/schemas/teams-devices_captive_portal'
                description:
                  $ref: '#/components/schemas/teams-devices_schemas-description'
                disable_auto_fallback:
                  $ref: '#/components/schemas/teams-devices_disable_auto_fallback'
                enabled:
                  description: Whether the policy will be applied to matching devices.
                  example: true
                  type: boolean
                exclude_office_ips:
                  $ref: '#/components/schemas/teams-devices_exclude_office_ips'
                match:
                  $ref: '#/components/schemas/teams-devices_schemas-match'
                name:
                  description: The name of the device settings profile.
                  example: Allow Developers
                  maxLength: 100
                  type: string
                precedence:
                  $ref: '#/components/schemas/teams-devices_precedence'
                service_mode_v2:
                  $ref: '#/components/schemas/teams-devices_service_mode_v2'
                support_url:
                  $ref: '#/components/schemas/teams-devices_support_url'
                switch_locked:
                  $ref: '#/components/schemas/teams-devices_switch_locked'
                tunnel_protocol:
                  $ref: '#/components/schemas/teams-devices_tunnel_protocol'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_device_settings_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update a device settings profile Policy response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_device_settings_response'
          description: Update a device settings profile Policy response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a device settings profile
      tags:
        - Devices
  /accounts/{account_id}/devices/policy/{policy_id}/exclude:
    get:
      description: Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile.
      operationId: devices-get-split-tunnel-exclude-list-for-a-device-settings-policy
      parameters:
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get the Split Tunnel exclude list for a device settings profile response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
          description: Get the Split Tunnel exclude list for a device settings profile response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get the Split Tunnel exclude list for a device settings profile
      tags:
        - Devices
    put:
      description: Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile.
      operationId: devices-set-split-tunnel-exclude-list-for-a-device-settings-policy
      parameters:
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/teams-devices_split_tunnel'
              type: array
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Set the Split Tunnel exclude list for a device settings profile response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
          description: Set the Split Tunnel exclude list for a device settings profile response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Set the Split Tunnel exclude list for a device settings profile
      tags:
        - Devices
  /accounts/{account_id}/devices/policy/{policy_id}/fallback_domains:
    get:
      description: Fetches the list of domains to bypass Gateway DNS resolution from a specified device settings profile. These domains will use the specified local DNS resolver instead.
      operationId: devices-get-local-domain-fallback-list-for-a-device-settings-policy
      parameters:
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get the Local Domain Fallback list for a device settings profile response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
          description: Get the Local Domain Fallback list for a device settings profile response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get the Local Domain Fallback list for a device settings profile
      tags:
        - Devices
    put:
      description: Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. This will only apply to the specified device settings profile.
      operationId: devices-set-local-domain-fallback-list-for-a-device-settings-policy
      parameters:
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/teams-devices_fallback_domain'
              type: array
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Set the Local Domain Fallback list for a device settings profile response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
          description: Set the Local Domain Fallback list for a device settings profile response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Set the Local Domain Fallback list for a device settings profile
      tags:
        - Devices
  /accounts/{account_id}/devices/policy/{policy_id}/include:
    get:
      description: Fetches the list of routes included in the WARP client's tunnel for a specific device settings profile.
      operationId: devices-get-split-tunnel-include-list-for-a-device-settings-policy
      parameters:
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get the Split Tunnel include list for a device settings profile response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
          description: Get the Split Tunnel include list for a device settings profile response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get the Split Tunnel include list for a device settings profile
      tags:
        - Devices
    put:
      description: Sets the list of routes included in the WARP client's tunnel for a specific device settings profile.
      operationId: devices-set-split-tunnel-include-list-for-a-device-settings-policy
      parameters:
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/teams-devices_split_tunnel_include'
              type: array
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Set the Split Tunnel include list for a device settings profile response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
          description: Set the Split Tunnel include list for a device settings profile response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Set the Split Tunnel include list for a device settings profile
      tags:
        - Devices
  /accounts/{account_id}/devices/policy/exclude:
    get:
      description: Fetches the list of routes excluded from the WARP client's tunnel.
      operationId: devices-get-split-tunnel-exclude-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get the Split Tunnel exclude list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
          description: Get the Split Tunnel exclude list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get the Split Tunnel exclude list
      tags:
        - Devices
    put:
      description: Sets the list of routes excluded from the WARP client's tunnel.
      operationId: devices-set-split-tunnel-exclude-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/teams-devices_split_tunnel'
              type: array
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Set the Split Tunnel exclude list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
          description: Set the Split Tunnel exclude list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Set the Split Tunnel exclude list
      tags:
        - Devices
  /accounts/{account_id}/devices/policy/fallback_domains:
    get:
      description: Fetches a list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.
      operationId: devices-get-local-domain-fallback-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get your Local Domain Fallback list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
          description: Get your Local Domain Fallback list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get your Local Domain Fallback list
      tags:
        - Devices
    put:
      description: Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.
      operationId: devices-set-local-domain-fallback-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/teams-devices_fallback_domain'
              type: array
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Set your Local Domain Fallback list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
          description: Set your Local Domain Fallback list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Set your Local Domain Fallback list
      tags:
        - Devices
  /accounts/{account_id}/devices/policy/include:
    get:
      description: Fetches the list of routes included in the WARP client's tunnel.
      operationId: devices-get-split-tunnel-include-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get the Split Tunnel include list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
          description: Get the Split Tunnel include list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get the Split Tunnel include list
      tags:
        - Devices
    put:
      description: Sets the list of routes included in the WARP client's tunnel.
      operationId: devices-set-split-tunnel-include-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/teams-devices_split_tunnel_include'
              type: array
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Set the Split Tunnel include list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
          description: Set the Split Tunnel include list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Set the Split Tunnel include list
      tags:
        - Devices
  /accounts/{account_id}/devices/posture:
    get:
      description: Fetches device posture rules for a Zero Trust account.
      operationId: device-posture-rules-list-device-posture-rules
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: List device posture rules response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_response_collection'
          description: List device posture rules response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List device posture rules
      tags:
        - Device Posture Rules
      x-api-token-group:
        - Teams Read
        - Teams Write
    post:
      description: Creates a new device posture rule.
      operationId: device-posture-rules-create-device-posture-rule
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                description:
                  $ref: '#/components/schemas/teams-devices_description'
                expiration:
                  $ref: '#/components/schemas/teams-devices_expiration'
                input:
                  $ref: '#/components/schemas/teams-devices_input'
                match:
                  $ref: '#/components/schemas/teams-devices_match'
                name:
                  $ref: '#/components/schemas/teams-devices_name'
                schedule:
                  $ref: '#/components/schemas/teams-devices_schedule'
                type:
                  $ref: '#/components/schemas/teams-devices_type'
              required:
                - name
                - type
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Create device posture rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_single_response'
          description: Create device posture rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a device posture rule
      tags:
        - Device Posture Rules
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/devices/posture/{rule_id}:
    delete:
      description: Deletes a device posture rule.
      operationId: device-posture-rules-delete-device-posture-rule
      parameters:
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_id_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Delete a device posture rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_id_response'
          description: Delete a device posture rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a device posture rule
      tags:
        - Device Posture Rules
      x-api-token-group:
        - Teams Write
    get:
      description: Fetches a single device posture rule.
      operationId: device-posture-rules-device-posture-rules-details
      parameters:
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get device posture rule details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_single_response'
          description: Get device posture rule details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get device posture rule details
      tags:
        - Device Posture Rules
      x-api-token-group:
        - Teams Read
        - Teams Write
    put:
      description: Updates a device posture rule.
      operationId: device-posture-rules-update-device-posture-rule
      parameters:
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                description:
                  $ref: '#/components/schemas/teams-devices_description'
                expiration:
                  $ref: '#/components/schemas/teams-devices_expiration'
                input:
                  $ref: '#/components/schemas/teams-devices_input'
                match:
                  $ref: '#/components/schemas/teams-devices_match'
                name:
                  $ref: '#/components/schemas/teams-devices_name'
                schedule:
                  $ref: '#/components/schemas/teams-devices_schedule'
                type:
                  $ref: '#/components/schemas/teams-devices_type'
              required:
                - name
                - type
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update a device posture rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_single_response'
          description: Update a device posture rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a device posture rule
      tags:
        - Device Posture Rules
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/devices/posture/integration:
    get:
      description: Fetches the list of device posture integrations for an account.
      operationId: device-posture-integrations-list-device-posture-integrations
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_schemas-response_collection'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: List your device posture integrations response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_schemas-response_collection'
          description: List your device posture integrations response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List your device posture integrations
      tags:
        - Device Posture Integrations
      x-api-token-group:
        - Teams Read
        - Teams Write
    post:
      description: Create a new device posture integration.
      operationId: device-posture-integrations-create-device-posture-integration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config:
                  $ref: '#/components/schemas/teams-devices_config_request'
                interval:
                  $ref: '#/components/schemas/teams-devices_interval'
                name:
                  $ref: '#/components/schemas/teams-devices_components-schemas-name'
                type:
                  $ref: '#/components/schemas/teams-devices_schemas-type'
              required:
                - name
                - type
                - interval
                - config
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_schemas-single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Create a device posture integration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_schemas-single_response'
          description: Create a device posture integration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a device posture integration
      tags:
        - Device Posture Integrations
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/devices/posture/integration/{integration_id}:
    delete:
      description: Delete a configured device posture integration.
      operationId: device-posture-integrations-delete-device-posture-integration
      parameters:
        - in: path
          name: integration_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_schemas-id_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Delete a device posture integration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_schemas-id_response'
          description: Delete a device posture integration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a device posture integration
      tags:
        - Device Posture Integrations
      x-api-token-group:
        - Teams Write
    get:
      description: Fetches details for a single device posture integration.
      operationId: device-posture-integrations-device-posture-integration-details
      parameters:
        - in: path
          name: integration_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_schemas-single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get device posture integration details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_schemas-single_response'
          description: Get device posture integration details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get device posture integration details
      tags:
        - Device Posture Integrations
      x-api-token-group:
        - Teams Read
        - Teams Write
    patch:
      description: Updates a configured device posture integration.
      operationId: device-posture-integrations-update-device-posture-integration
      parameters:
        - in: path
          name: integration_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config:
                  $ref: '#/components/schemas/teams-devices_config_request'
                interval:
                  $ref: '#/components/schemas/teams-devices_interval'
                name:
                  $ref: '#/components/schemas/teams-devices_components-schemas-name'
                type:
                  $ref: '#/components/schemas/teams-devices_schemas-type'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_schemas-single_response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update a device posture integration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_schemas-single_response'
          description: Update a device posture integration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a device posture integration
      tags:
        - Device Posture Integrations
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/devices/revoke:
    post:
      description: Revokes a list of devices.
      operationId: devices-revoke-devices
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teams-devices_revoke_devices_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_api-response-single'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Revoke devices response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_api-response-single'
          description: Revoke devices response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Revoke devices
      tags:
        - Devices
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/devices/settings:
    get:
      description: Describes the current device settings for a Zero Trust account.
      operationId: zero-trust-accounts-get-device-settings-for-zero-trust-account
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get device settings for a Zero Trust account response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
          description: Get device settings for a Zero Trust account response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get device settings for a Zero Trust account
      tags:
        - Zero Trust Accounts
      x-api-token-group:
        - Teams Read
        - Teams Write
    patch:
      description: Patches the current device settings for a Zero Trust account.
      operationId: zero-trust-accounts-patch-device-settings-for-the-zero-trust-account
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Patch device settings for a Zero Trust account response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
          description: Patch device settings for a Zero Trust account response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch device settings for a Zero Trust account
      tags:
        - Zero Trust Accounts
      x-api-token-group:
        - Teams Write
    put:
      description: Updates the current device settings for a Zero Trust account.
      operationId: zero-trust-accounts-update-device-settings-for-the-zero-trust-account
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update device settings for a Zero Trust account response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
          description: Update device settings for a Zero Trust account response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update device settings for a Zero Trust account
      tags:
        - Zero Trust Accounts
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/devices/unrevoke:
    post:
      description: Unrevokes a list of devices.
      operationId: devices-unrevoke-devices
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teams-devices_unrevoke_devices_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/teams-devices_api-response-single'
                  - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Unrevoke devices response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_api-response-single'
          description: Unrevoke devices response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Unrevoke devices
      tags:
        - Devices
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/dex/colos:
    get:
      description: List Cloudflare colos that account's devices were connected to during a time period, sorted by usage starting from the most used colo. Colos without traffic are also returned and sorted alphabetically.
      operationId: dex-endpoints-list-colos
      parameters:
        - description: unique identifier linked to an account in the API request path.
          in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
        - description: Start time for connection period in RFC3339 (ISO 8601) format.
          in: query
          name: from
          required: true
          schema:
            example: "2023-08-20T20:45:00Z"
            type: string
        - description: End time for connection period in RFC3339 (ISO 8601) format.
          in: query
          name: to
          required: true
          schema:
            example: "2023-08-24T20:45:00Z"
            type: string
        - description: Type of usage that colos should be sorted by. If unspecified, returns all Cloudflare colos sorted alphabetically.
          in: query
          name: sortBy
          schema:
            enum:
              - fleet-status-usage
              - application-tests-usage
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
          description: List colos failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-collection'
                  - properties:
                      result:
                        $ref: '#/components/schemas/digital-experience-monitoring_colos_response'
          description: List colos response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform List Cloudflare colos
      tags:
        - DEX Synthetic Application Monitoring
      x-cfPermissionsRequired:
        enum:
          - '#dex:read'
          - '#teams:report'
  /accounts/{account_id}/dex/fleet-status/devices:
    get:
      description: List details for devices using WARP
      operationId: dex-fleet-status-devices
      parameters:
        - description: Unique identifier for account
          in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
        - description: Time range end in ISO format
          in: query
          name: to
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_timestamp'
        - description: Time range beginning in ISO format
          in: query
          name: from
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_timestamp'
        - description: Page number
          in: query
          name: page
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_page'
        - description: Number of results per page
          in: query
          name: per_page
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_per_page'
        - description: Dimension to sort results by
          in: query
          name: sort_by
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_sort_by'
        - description: Cloudflare colo
          in: query
          name: colo
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_colo'
        - description: Device-specific ID, given as UUID v4
          in: query
          name: device_id
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_device_id'
        - description: The mode under which the WARP client is run
          in: query
          name: mode
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_mode'
        - description: Network status
          in: query
          name: status
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_status'
        - description: Operating system
          in: query
          name: platform
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_platform'
        - description: WARP client version
          in: query
          name: version
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_version'
        - description: |
            Source:
              * `hourly` - device details aggregated hourly, up to 7 days prior
              * `last_seen` - device details, up to 24 hours prior
              * `raw` - device details, up to 7 days prior
          in: query
          name: source
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_source'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
          description: List devices response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/digital-experience-monitoring_fleet_status_devices_response'
          description: List devices response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform List fleet status devices
      tags:
        - DEX Synthetic Application Monitoring
      x-cfPermissionsRequired:
        enum:
          - '#dex:read'
          - '#teams:report'
  /accounts/{account_id}/dex/fleet-status/live:
    get:
      description: List details for live (up to 60 minutes) devices using WARP
      operationId: dex-fleet-status-live
      parameters:
        - description: Unique identifier for account
          in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
        - description: Number of minutes before current time
          in: query
          name: since_minutes
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_since_minutes'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
          description: List device details (live) response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/digital-experience-monitoring_fleet_status_live_response'
          description: List device details (live) response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform List fleet status details by dimension
      tags:
        - DEX Synthetic Application Monitoring
      x-cfPermissionsRequired:
        enum:
          - '#dex:read'
          - '#teams:report'
  /accounts/{account_id}/dex/fleet-status/over-time:
    get:
      description: List details for devices using WARP, up to 7 days
      operationId: dex-fleet-status-over-time
      parameters:
        - description: Unique identifier for account
          in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
        - description: Time range end in ISO format
          in: query
          name: to
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_timestamp'
        - description: Time range beginning in ISO format
          in: query
          name: from
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_timestamp'
        - description: Cloudflare colo
          in: query
          name: colo
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_colo'
        - description: Device-specific ID, given as UUID v4
          in: query
          name: device_id
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_device_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
          description: DEX HTTP test details failure response
        "200":
          description: List DEX devices response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform List fleet status aggregate details by dimension
      tags:
        - DEX Synthetic Application Monitoring
      x-cfPermissionsRequired:
        enum:
          - '#dex:read'
          - '#teams:report'
  /accounts/{account_id}/dex/http-tests/{test_id}:
    get:
      description: Get test details and aggregate performance metrics for an http test for a given time period between 1 hour and 7 days.
      operationId: dex-endpoints-http-test-details
      parameters:
        - description: unique identifier linked to an account in the API request path.
          in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
        - description: unique identifier for a specific test
          in: path
          name: test_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_uuid'
        - description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
          in: query
          name: deviceId
          schema:
            items:
              type: string
            type: array
        - description: Start time for aggregate metrics in ISO ms
          in: query
          name: from
          required: true
          schema:
            example: 1.689520412e+12
            type: string
        - description: End time for aggregate metrics in ISO ms
          in: query
          name: to
          required: true
          schema:
            example: 1.689606812e+12
            type: string
        - description: Time interval for aggregate time slots.
          in: query
          name: interval
          required: true
          schema:
            enum:
              - minute
              - hour
            type: string
        - description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.
          in: query
          name: colo
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
          description: DEX HTTP test details failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/digital-experience-monitoring_http_details_response'
          description: DEX HTTP test details response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get details and aggregate metrics for an http test
      tags:
        - DEX Synthetic Application Monitoring
      x-cfPermissionsRequired:
        enum:
          - '#dex:read'
          - '#teams:report'
  /accounts/{account_id}/dex/http-tests/{test_id}/percentiles:
    get:
      description: Get percentiles for an http test for a given time period between 1 hour and 7 days.
      operationId: dex-endpoints-http-test-percentiles
      parameters:
        - description: unique identifier linked to an account in the API request path.
          in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
        - description: unique identifier for a specific test
          in: path
          name: test_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_uuid'
        - description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
          in: query
          name: deviceId
          schema:
            items:
              type: string
            type: array
        - description: Start time for aggregate metrics in ISO format
          in: query
          name: from
          required: true
          schema:
            example: "2023-09-20T17:00:00Z"
            type: string
        - description: End time for aggregate metrics in ISO format
          in: query
          name: to
          required: true
          schema:
            example: "2023-09-20T17:00:00Z"
            type: string
        - description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.
          in: query
          name: colo
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
          description: DEX HTTP test percentiles failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/digital-experience-monitoring_http_details_percentiles_response'
          description: DEX HTTP test percentiles response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get percentiles for an http test
      tags:
        - DEX Synthetic Application Monitoring
      x-cfPermissionsRequired:
        enum:
          - '#dex:read'
          - '#teams:report'
  /accounts/{account_id}/dex/tests/overview:
    get:
      description: List DEX tests with overview metrics
      operationId: dex-endpoints-list-tests-overview
      parameters:
        - description: unique identifier linked to an account in the API request path.
          in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
        - description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.
          in: query
          name: colo
          schema:
            type: string
        - description: Optionally filter results by test name
          in: query
          name: testName
          schema:
            type: string
        - description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
          in: query
          name: deviceId
          schema:
            items:
              type: string
            type: array
        - description: Page number of paginated results
          in: query
          name: page
          schema:
            default: 1
            minimum: 1
            type: number
        - description: Number of items per page
          in: query
          name: per_page
          schema:
            default: 10
            maximum: 50
            minimum: 1
            type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
          description: failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/digital-experience-monitoring_tests_response'
                      result_info:
                        $ref: '#/components/schemas/digital-experience-monitoring_result_info'
          description: success response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform List DEX test analytics
      tags:
        - DEX Synthetic Application Monitoring
      x-cfPermissionsRequired:
        enum:
          - '#dex:read'
          - '#teams:report'
  /accounts/{account_id}/dex/tests/unique-devices:
    get:
      description: Returns unique count of devices that have run synthetic application monitoring tests in the past 7 days.
      operationId: dex-endpoints-tests-unique-devices
      parameters:
        - description: unique identifier linked to an account in the API request path.
          in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
        - description: Optionally filter results by test name
          in: query
          name: testName
          schema:
            type: string
        - description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
          in: query
          name: deviceId
          schema:
            items:
              type: string
            type: array
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
          description: DEX unique devices targeted failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/digital-experience-monitoring_unique_devices_response'
          description: DEX unique devices targeted response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get count of devices targeted
      tags:
        - DEX Synthetic Application Monitoring
      x-cfPermissionsRequired:
        enum:
          - '#dex:read'
          - '#teams:report'
  /accounts/{account_id}/dex/traceroute-test-results/{test_result_id}/network-path:
    get:
      description: Get a breakdown of hops and performance metrics for a specific traceroute test run
      operationId: dex-endpoints-traceroute-test-result-network-path
      parameters:
        - description: unique identifier linked to an account
          in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
        - description: unique identifier for a specific traceroute test
          in: path
          name: test_result_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
          description: DEX traceroute test result network path failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/digital-experience-monitoring_traceroute_test_result_network_path_response'
          description: DEX traceroute test result network path response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get details for a specific traceroute test run
      tags:
        - DEX Synthetic Application Monitoring
      x-cfPermissionsRequired:
        enum:
          - '#dex:read'
          - '#teams:report'
  /accounts/{account_id}/dex/traceroute-tests/{test_id}:
    get:
      description: Get test details and aggregate performance metrics for an traceroute test for a given time period between 1 hour and 7 days.
      operationId: dex-endpoints-traceroute-test-details
      parameters:
        - description: Unique identifier linked to an account
          in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
        - description: Unique identifier for a specific test
          in: path
          name: test_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_uuid'
        - description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
          in: query
          name: deviceId
          schema:
            items:
              type: string
            type: array
        - description: Start time for aggregate metrics in ISO ms
          in: query
          name: from
          required: true
          schema:
            example: 1.689520412e+12
            type: string
        - description: End time for aggregate metrics in ISO ms
          in: query
          name: to
          required: true
          schema:
            example: 1.689606812e+12
            type: string
        - description: Time interval for aggregate time slots.
          in: query
          name: interval
          required: true
          schema:
            enum:
              - minute
              - hour
            type: string
        - description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.
          in: query
          name: colo
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
          description: DEX traceroute test details response failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/digital-experience-monitoring_traceroute_details_response'
          description: DEX traceroute test details response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get details and aggregate metrics for a traceroute test
      tags:
        - DEX Synthetic Application Monitoring
      x-cfPermissionsRequired:
        enum:
          - '#dex:read'
          - '#teams:report'
  /accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path:
    get:
      description: Get a breakdown of metrics by hop for individual traceroute test runs
      operationId: dex-endpoints-traceroute-test-network-path
      parameters:
        - description: unique identifier linked to an account
          in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
        - description: unique identifier for a specific test
          in: path
          name: test_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_uuid'
        - description: Device to filter tracroute result runs to
          in: query
          name: deviceId
          required: true
          schema:
            type: string
        - description: Start time for aggregate metrics in ISO ms
          in: query
          name: from
          required: true
          schema:
            example: 1.689520412e+12
            type: string
        - description: End time for aggregate metrics in ISO ms
          in: query
          name: to
          required: true
          schema:
            example: 1.689606812e+12
            type: string
        - description: Time interval for aggregate time slots.
          in: query
          name: interval
          required: true
          schema:
            enum:
              - minute
              - hour
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
          description: DEX traceroute test network path failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/digital-experience-monitoring_traceroute_test_network_path_response'
          description: DEX traceroute test network path response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get network path breakdown for a traceroute test
      tags:
        - DEX Synthetic Application Monitoring
      x-cfPermissionsRequired:
        enum:
          - '#dex:read'
          - '#teams:report'
  /accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles:
    get:
      description: Get percentiles for a traceroute test for a given time period between 1 hour and 7 days.
      operationId: dex-endpoints-traceroute-test-percentiles
      parameters:
        - description: unique identifier linked to an account in the API request path.
          in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
        - description: unique identifier for a specific test
          in: path
          name: test_id
          required: true
          schema:
            $ref: '#/components/schemas/digital-experience-monitoring_uuid'
        - description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
          in: query
          name: deviceId
          schema:
            items:
              type: string
            type: array
        - description: Start time for aggregate metrics in ISO format
          in: query
          name: from
          required: true
          schema:
            example: "2023-09-20T17:00:00Z"
            type: string
        - description: End time for aggregate metrics in ISO format
          in: query
          name: to
          required: true
          schema:
            example: "2023-09-20T17:00:00Z"
            type: string
        - description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.
          in: query
          name: colo
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
          description: DEX Traceroute test percentiles failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/digital-experience-monitoring_traceroute_details_percentiles_response'
          description: DEX Traceroute test percentiles response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get percentiles for a traceroute test
      tags:
        - DEX Synthetic Application Monitoring
      x-cfPermissionsRequired:
        enum:
          - '#dex:read'
          - '#teams:report'
  /accounts/{account_id}/diagnostics/traceroute:
    post:
      description: Run traceroutes from Cloudflare colos.
      operationId: diagnostics-traceroute
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-transit_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                colos:
                  $ref: '#/components/schemas/magic-transit_colos'
                options:
                  $ref: '#/components/schemas/magic-transit_options'
                targets:
                  $ref: '#/components/schemas/magic-transit_targets'
              required:
                - targets
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-transit_traceroute_response_collection'
                  - $ref: '#/components/schemas/magic-transit_api-response-common-failure'
          description: Traceroute response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-transit_traceroute_response_collection'
          description: Traceroute response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Traceroute
      tags:
        - Diagnostics
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/dlp/datasets:
    get:
      operationId: dlp-datasets-read-all
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Datasets read failed
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_DatasetArray'
                    type: object
          description: Datasets read successfully
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Fetch all datasets
      tags:
        - DLP Datasets
    post:
      operationId: dlp-datasets-create
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_NewDataset'
        description: Dataset description
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Dataset creation failed
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_DatasetCreation'
                    type: object
          description: Dataset created successfully
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create a new dataset
      tags:
        - DLP Datasets
  /accounts/{account_id}/dlp/datasets/{dataset_id}:
    delete:
      description: This deletes all versions of the dataset.
      operationId: dlp-datasets-delete
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: dataset_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Dataset delete failed
        "200":
          description: Dataset deleted successfully
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete a dataset
      tags:
        - DLP Datasets
    get:
      operationId: dlp-datasets-read
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: dataset_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Dataset read failed
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Dataset'
                    type: object
          description: Dataset read successfully
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Fetch a specific dataset
      tags:
        - DLP Datasets
    put:
      operationId: dlp-datasets-update
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: dataset_id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_DatasetUpdate'
        description: Dataset description
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Dataset update failed
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Dataset'
                    type: object
          description: Dataset updated successfully
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update details about a dataset
      tags:
        - DLP Datasets
  /accounts/{account_id}/dlp/datasets/{dataset_id}/upload:
    post:
      operationId: dlp-datasets-create-version
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: dataset_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Dataset version creation failed
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_DatasetNewVersion'
                    type: object
          description: Dataset version created successfully
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Prepare to upload a new version of a dataset
      tags:
        - DLP Datasets
  /accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version}:
    post:
      description: |-
        This is used for single-column EDMv1 and Custom Word Lists. The EDM format
        can only be created in the Cloudflare dashboard. For other clients, this
        operation can only be used for non-secret Custom Word Lists. The body must
        be a UTF-8 encoded, newline (NL or CRNL) separated list of words to be matched.
      operationId: dlp-datasets-upload-version
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: dataset_id
          required: true
          schema:
            format: uuid
            type: string
        - in: path
          name: version
          required: true
          schema:
            format: int64
            type: integer
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
        description: Dataset. For custom wordlists this contains UTF-8 patterns separated by newline characters.
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Dataset version upload failed
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Dataset'
                    type: object
          description: Dataset version uploaded successfully
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Upload a new version of a dataset
      tags:
        - DLP Datasets
  /accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}:
    post:
      description: |-
        This is used for multi-column EDMv2 datasets. The EDMv2 format can only be
        created in the Cloudflare dashboard. The columns in the response appear in
        the same order as in the request.
      operationId: dlp-datasets-define-columns
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: dataset_id
          required: true
          schema:
            format: uuid
            type: string
        - in: path
          name: version
          required: true
          schema:
            format: int64
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/dlp_NewDatasetColumn'
              type: array
        description: array of new columns to create for this dataset version
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Failed to create dataset columns
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_DatasetColumnArray'
                    type: object
          description: Dataset columns created successfully
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Sets the column information for a multi-column upload
      tags:
        - DLP Datasets
  /accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}/entries/{entry_id}:
    post:
      description: |-
        This is used for multi-column EDMv2 datasets. The EDMv2 format can only be
        created in the Cloudflare dashboard.
      operationId: dlp-datasets-upload-dataset-column
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: dataset_id
          required: true
          schema:
            format: uuid
            type: string
        - in: path
          name: version
          required: true
          schema:
            format: int64
            type: integer
        - in: path
          name: entry_id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
        description: Dataset content
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Failed to upload dataset column
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_DatasetColumn'
                    type: object
          description: Dataset column uploaded successfully
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Upload a new version of a multi-column dataset
      tags:
        - DLP Datasets
  /accounts/{account_id}/dlp/limits:
    get:
      operationId: dlp-limits-get
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Limits get failed
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Limits'
                    type: object
          description: Limits retrieved successfully
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Fetch limits associated with DLP for account
      tags:
        - DLP Settings
  /accounts/{account_id}/dlp/patterns/validate:
    post:
      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. The regex will be rejected if it uses `*` or `+`. Bound the maximum
        number of characters that can be matched using a range, e.g. `{1,100}`.
      operationId: dlp-pattern-validate
      parameters:
        - description: Account ID
          in: path
          name: account_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_RegexValidationQuery'
        description: Validation query
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Failed to validate
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_RegexValidationResult'
                    type: object
          description: Validation response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Validate a DLP regex pattern
      tags:
        - DLP Settings
  /accounts/{account_id}/dlp/payload_log:
    get:
      operationId: dlp-payload-log-get
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Failed to get payload log settings
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_PayloadLogSetting'
                    type: object
          description: Payload log settings
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get payload log settings
      tags:
        - DLP Settings
    put:
      operationId: dlp-payload-log-put
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_PayloadLogSettingUpdate'
        description: New payload log settings
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Failed to set payload log settings
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_PayloadLogSetting'
                    type: object
          description: Payload log settings
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Set payload log settings
      tags:
        - DLP Settings
  /accounts/{account_id}/dlp/profiles:
    get:
      description: Lists all DLP profiles in an account.
      operationId: dlp-profiles-list-all-profiles
      parameters:
        - description: Return all profiles, including those that current account does not have access to.
          in: query
          name: all
          schema:
            type: boolean
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: List all profiles failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_ProfileArray'
                    type: object
          description: List all profiles response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List all profiles
      tags:
        - DLP Profiles
  /accounts/{account_id}/dlp/profiles/{profile_id}:
    get:
      description: Fetches a DLP profile by ID
      operationId: dlp-profiles-get-dlp-profile
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: profile_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Get profile failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Profile'
                    type: object
          description: Get profile response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get DLP Profile
      tags:
        - DLP Profiles
  /accounts/{account_id}/dlp/profiles/custom:
    post:
      description: Creates a set of DLP custom profiles.
      operationId: dlp-profiles-create-custom-profiles
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_NewCustomProfiles'
        description: A list of new profiles to create.
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: New custom profile failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_ProfileArray'
                    type: object
          description: New custom profile response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create custom profiles
      tags:
        - DLP Profiles
  /accounts/{account_id}/dlp/profiles/custom/{profile_id}:
    delete:
      description: Deletes a DLP custom profile.
      operationId: dlp-profiles-delete-custom-profile
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: profile_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Delete custom profile failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Empty'
                    type: object
          description: Delete custom profile response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete custom profile
      tags:
        - DLP Profiles
    get:
      description: Fetches a custom DLP profile by id.
      operationId: dlp-profiles-get-custom-profile
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: profile_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Custom profile failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Profile'
                    type: object
          description: Custom profile response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get custom profile
      tags:
        - DLP Profiles
    put:
      description: Updates a DLP custom profile.
      operationId: dlp-profiles-update-custom-profile
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: profile_id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_CustomProfileUpdate'
        description: The updated parameters for the profile.
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Update custom profile failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Profile'
                    type: object
          description: Update custom profile response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update custom profile
      tags:
        - DLP Profiles
  /accounts/{account_id}/dlp/profiles/predefined/{profile_id}:
    get:
      description: Fetches a predefined DLP profile by id.
      operationId: dlp-profiles-get-predefined-profile
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: profile_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Predefined profile failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Profile'
                    type: object
          description: Predefined profile response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get predefined profile
      tags:
        - DLP Profiles
    put:
      description: Updates a DLP predefined profile. Only supports enabling/disabling entries.
      operationId: dlp-profiles-update-predefined-profile
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: profile_id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_PredefinedProfileUpdate'
        description: The updated parameters for the predefined profile.
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Update predefined profile failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Profile'
                    type: object
          description: Update predefined profile response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update predefined profile
      tags:
        - DLP Profiles
  /accounts/{account_id}/dns_firewall:
    get:
      description: List DNS Firewall clusters for an account
      operationId: dns-firewall-list-dns-firewall-clusters
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-firewall_identifier'
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 20
            description: Number of clusters per page
            maximum: 100
            minimum: 1
            type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-firewall_dns_firewall_response_collection'
                  - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: List DNS Firewall Clusters response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-firewall_dns_firewall_response_collection'
          description: List DNS Firewall Clusters response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List DNS Firewall Clusters
      tags:
        - DNS Firewall
      x-api-token-group:
        - DNS Firewall Write
        - DNS Firewall Read
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Create a DNS Firewall cluster
      operationId: dns-firewall-create-dns-firewall-cluster
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-firewall_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster-post'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
                  - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: Create DNS Firewall Cluster response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
          description: Create DNS Firewall Cluster response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create DNS Firewall Cluster
      tags:
        - DNS Firewall
      x-api-token-group:
        - DNS Firewall Write
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/dns_firewall/{dns_firewall_id}:
    delete:
      description: Delete a DNS Firewall cluster
      operationId: dns-firewall-delete-dns-firewall-cluster
      parameters:
        - in: path
          name: dns_firewall_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-firewall_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-firewall_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/dns-firewall_api-response-single'
                      - properties:
                          result:
                            properties:
                              id:
                                $ref: '#/components/schemas/dns-firewall_identifier'
                  - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: Delete DNS Firewall Cluster response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-firewall_api-response-single'
                  - properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/dns-firewall_identifier'
          description: Delete DNS Firewall Cluster response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete DNS Firewall Cluster
      tags:
        - DNS Firewall
      x-api-token-group:
        - DNS Firewall Write
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Show a single DNS Firewall cluster for an account
      operationId: dns-firewall-dns-firewall-cluster-details
      parameters:
        - in: path
          name: dns_firewall_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-firewall_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-firewall_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
                  - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: DNS Firewall Cluster Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
          description: DNS Firewall Cluster Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform DNS Firewall Cluster Details
      tags:
        - DNS Firewall
      x-api-token-group:
        - DNS Firewall Write
        - DNS Firewall Read
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      description: Modify the configuration of a DNS Firewall cluster
      operationId: dns-firewall-update-dns-firewall-cluster
      parameters:
        - in: path
          name: dns_firewall_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-firewall_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-firewall_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster-patch'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
                  - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: Update DNS Firewall Cluster response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
          description: Update DNS Firewall Cluster response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update DNS Firewall Cluster
      tags:
        - DNS Firewall
      x-api-token-group:
        - DNS Firewall Write
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report:
    get:
      description: |-
        Retrieves a list of summarised aggregate metrics over a given time period.

        See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.
      operationId: dns-firewall-analytics-table
      parameters:
        - in: path
          name: dns_firewall_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-analytics_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-analytics_identifier'
        - in: query
          name: metrics
          schema:
            $ref: '#/components/schemas/dns-analytics_metrics'
        - in: query
          name: dimensions
          schema:
            $ref: '#/components/schemas/dns-analytics_dimensions'
        - in: query
          name: since
          schema:
            $ref: '#/components/schemas/dns-analytics_since'
        - in: query
          name: until
          schema:
            $ref: '#/components/schemas/dns-analytics_until'
        - in: query
          name: limit
          schema:
            $ref: '#/components/schemas/dns-analytics_limit'
        - in: query
          name: sort
          schema:
            $ref: '#/components/schemas/dns-analytics_sort'
        - in: query
          name: filters
          schema:
            $ref: '#/components/schemas/dns-analytics_filters'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/dns-analytics_api-response-single'
                      - properties:
                          result:
                            $ref: '#/components/schemas/dns-analytics_report'
                        type: object
                  - $ref: '#/components/schemas/dns-analytics_api-response-common-failure'
          description: Table response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-analytics_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dns-analytics_report'
                    type: object
          description: Table response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Table
      tags:
        - DNS Firewall Analytics
      x-cfPermissionsRequired:
        enum:
          - '#analytics:read'
  /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report/bytime:
    get:
      description: |-
        Retrieves a list of aggregate metrics grouped by time interval.

        See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.
      operationId: dns-firewall-analytics-by-time
      parameters:
        - in: path
          name: dns_firewall_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-analytics_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-analytics_identifier'
        - in: query
          name: metrics
          schema:
            $ref: '#/components/schemas/dns-analytics_metrics'
        - in: query
          name: dimensions
          schema:
            $ref: '#/components/schemas/dns-analytics_dimensions'
        - in: query
          name: since
          schema:
            $ref: '#/components/schemas/dns-analytics_since'
        - in: query
          name: until
          schema:
            $ref: '#/components/schemas/dns-analytics_until'
        - in: query
          name: limit
          schema:
            $ref: '#/components/schemas/dns-analytics_limit'
        - in: query
          name: sort
          schema:
            $ref: '#/components/schemas/dns-analytics_sort'
        - in: query
          name: filters
          schema:
            $ref: '#/components/schemas/dns-analytics_filters'
        - in: query
          name: time_delta
          schema:
            $ref: '#/components/schemas/dns-analytics_time_delta'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/dns-analytics_api-response-single'
                      - properties:
                          result:
                            $ref: '#/components/schemas/dns-analytics_report_bytime'
                        type: object
                  - $ref: '#/components/schemas/dns-analytics_api-response-common-failure'
          description: By Time response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-analytics_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dns-analytics_report_bytime'
                    type: object
          description: By Time response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform By Time
      tags:
        - DNS Firewall Analytics
      x-cfPermissionsRequired:
        enum:
          - '#analytics:read'
  /accounts/{account_id}/dns_firewall/{dns_firewall_id}/reverse_dns:
    get:
      description: Show reverse DNS configuration (PTR records) for a DNS Firewall cluster
      operationId: dns-firewall-show-dns-firewall-cluster-reverse-dns
      parameters:
        - in: path
          name: dns_firewall_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-firewall_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-firewall_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-firewall_dns_firewall_reverse_dns_response'
                  - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: Show DNS Firewall Cluster Reverse DNS response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-firewall_dns_firewall_reverse_dns_response'
          description: Show DNS Firewall Cluster Reverse DNS response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Show DNS Firewall Cluster Reverse DNS
      tags:
        - DNS Firewall
      x-api-token-group:
        - DNS Firewall Write
        - DNS Firewall Read
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      description: Update reverse DNS configuration (PTR records) for a DNS Firewall cluster
      operationId: dns-firewall-update-dns-firewall-cluster-reverse-dns
      parameters:
        - in: path
          name: dns_firewall_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-firewall_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-firewall_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-firewall_dns-firewall-reverse-dns-patch'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-firewall_dns_firewall_reverse_dns_response'
                  - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: Update DNS Firewall Cluster Reverse DNS response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-firewall_dns_firewall_reverse_dns_response'
          description: Update DNS Firewall Cluster Reverse DNS response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update DNS Firewall Cluster Reverse DNS
      tags:
        - DNS Firewall
      x-api-token-group:
        - DNS Firewall Write
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/dns_settings:
    get:
      description: Show DNS settings for an account
      operationId: dns-settings-for-an-account-list-dns-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-settings_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-settings_dns_response_single'
                  - $ref: '#/components/schemas/dns-settings_api-response-common-failure'
          description: Show DNS Settings response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-settings_dns_response_single'
          description: Show DNS Settings response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Show DNS Settings
      tags:
        - DNS Settings for an Account
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    patch:
      description: Update DNS settings for an account
      operationId: dns-settings-for-an-account-update-dns-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/dns-settings_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-settings_account_settings'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dns-settings_dns_response_single'
                  - $ref: '#/components/schemas/dns-settings_api-response-common-failure'
          description: Show DNS Settings response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-settings_dns_response_single'
          description: Show DNS Settings response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update DNS Settings
      tags:
        - DNS Settings for an Account
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/email-security/investigate:
    get:
      description: This endpoint returns information for each email that matches the search parameter(s).
      operationId: email_security_investigate
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - description: |-
            The beginning of the search date range.
            Defaults to `now - 30 days`.
          example: "2022-07-25T14:30:00Z"
          in: query
          name: start
          schema:
            format: date-time
            type: string
        - description: |-
            The end of the search date range.
            Defaults to `now`.
          example: "2022-06-25T14:30:00Z"
          in: query
          name: end
          schema:
            format: date-time
            type: string
        - description: |-
            Space delimited query term(s).
            The search is case-insensitive.

            The content of the following email metadata fields are searched:
            * alert_id
            * CC
            * From (envelope_from)
            * From Name
            * final_disposition
            * md5 hash (of any attachment)
            * sha1 hash (of any attachment)
            * sha256 hash (of any attachment)
            * name (of any attachment)
            * Reason
            * Received DateTime (yyyy-mm-ddThh:mm:ss)
            * Sent DateTime (yyyy-mm-ddThh:mm:ss)
            * ReplyTo
            * To (envelope_to)
            * To Name
            * Message-ID
            * smtp_helo_server_ip
            * smtp_previous_hop_ip
            * x_originating_ip
            * Subject
          example: bob jones
          in: query
          name: query
          schema:
            type: string
        - description: If `false`, the search includes non-detections.
          in: query
          name: detections_only
          schema:
            default: true
            type: boolean
        - description: Controls whether the message action log in included in the response.
          in: query
          name: action_log
          schema:
            default: true
            type: boolean
        - description: Filter messages by the provided disposition.
          in: query
          name: final_disposition
          schema:
            allOf:
              - enum:
                  - MALICIOUS
                  - SUSPICIOUS
                  - SPOOF
                  - SPAM
                  - BULK
                type: string
        - in: query
          name: metric
          schema:
            type: string
        - description: Filter messages by actions applied to them
          in: query
          name: message_action
          schema:
            allOf:
              - enum:
                  - PREVIEW
                  - QUARANTINE_RELEASED
                  - MOVED
                type: string
        - example: me@example.com
          in: query
          name: recipient
          schema:
            type: string
        - example: noreply@example.com
          in: query
          name: sender
          schema:
            type: string
        - example: 4Njp3P0STMz2c02Q-2022-12-30T02:44:49
          in: query
          name: alert_id
          schema:
            type: string
        - description: Filter by the sender domain
          example: example.com
          in: query
          name: domain
          schema:
            type: string
        - example: <4VAZPrAdg7IGNxdt1DWRNu0gvOeL_iZiwP4BQfo4DaE.Yw-woXuugQbeFhBpzwFQtqq_v2v1HOKznoMBqbciQpE@example.com>
          in: query
          name: message_id
          schema:
            type: string
        - description: Page number of paginated results.
          in: query
          name: page
          schema:
            default: 1
            format: int32
            minimum: 1
            type: integer
        - description: Number of results to display.
          in: query
          name: per_page
          schema:
            default: 20
            format: int32
            minimum: 1
            type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/email-security_MailsearchMessage'
                        type: array
                      result_info:
                        $ref: '#/components/schemas/email-security_ResultInfo'
                    required:
                      - result
                      - result_info
                    type: object
          description: Search results for the provided query
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Search email messages
      tags:
        - Email Security
      x-api-token-group:
        - 'Cloud Email Security: Write'
        - 'Cloud Email Security: Read'
  /accounts/{account_id}/email-security/investigate/{postfix_id}:
    get:
      operationId: email_security_get_message
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: postfix_id
          required: true
          schema:
            description: Message identifier
            example: 4Njp3P0STMz2c02Q
            title: postfix_id
            type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        allOf:
                          - properties:
                              action_log: {}
                              alert_id:
                                nullable: true
                                type: string
                              client_recipients:
                                items:
                                  type: string
                                type: array
                              delivery_mode:
                                allOf:
                                  - $ref: '#/components/schemas/email-security_MessageDeliveryMode'
                                  - nullable: true
                                    type: string
                              detection_reasons:
                                items:
                                  type: string
                                type: array
                              edf_hash:
                                nullable: true
                                type: string
                              final_disposition:
                                allOf:
                                  - $ref: '#/components/schemas/email-security_DispositionLabel'
                                  - nullable: true
                                    type: string
                              from:
                                nullable: true
                                type: string
                              from_name:
                                nullable: true
                                type: string
                              is_phish_submission:
                                type: boolean
                              is_quarantined:
                                type: boolean
                              message_id:
                                type: string
                              postfix_id:
                                $ref: '#/components/schemas/email-security_PostfixId'
                              sent_date:
                                nullable: true
                                type: string
                              subject:
                                nullable: true
                                type: string
                              threat_categories:
                                items:
                                  type: string
                                nullable: true
                                type: array
                              to:
                                items:
                                  type: string
                                nullable: true
                                type: array
                              to_name:
                                items:
                                  type: string
                                nullable: true
                                type: array
                              ts:
                                type: string
                              validation:
                                allOf:
                                  - properties:
                                      comment:
                                        nullable: true
                                        type: string
                                      dkim:
                                        allOf:
                                          - $ref: '#/components/schemas/email-security_ValidationStatus'
                                          - nullable: true
                                            type: string
                                      dmarc:
                                        allOf:
                                          - $ref: '#/components/schemas/email-security_ValidationStatus'
                                          - nullable: true
                                            type: string
                                      spf:
                                        allOf:
                                          - $ref: '#/components/schemas/email-security_ValidationStatus'
                                          - nullable: true
                                            type: string
                                    type: object
                                  - nullable: true
                                    type: object
                            required:
                              - ts
                              - message_id
                              - client_recipients
                              - postfix_id
                              - detection_reasons
                              - action_log
                              - is_quarantined
                              - is_phish_submission
                            type: object
                          - properties:
                              id:
                                type: string
                            required:
                              - id
                            type: object
                        example:
                          action_log: []
                          alert_id: 4Njp3P0STMz2c02Q-2022-12-30T02:44:49
                          client_recipients:
                            - email@example.com
                          delivery_mode: DIRECT
                          detection_reasons:
                            - 'Selector is a source of spam/uce : Smtp-Helo-Server-Ip=<b>127.0.0[dot]186</b>'
                          edf_hash:
                          final_disposition: MALICIOUS
                          from: d1994@example.com
                          from_name: Sender Name
                          id: 47JJcT1w6GztQV7-email@example.com
                          is_phish_submission: false
                          is_quarantined: false
                          message_id: <4VAZPrAdg7IGNxdt1DWRNu0gvOeL_iZiwP4BQfo4DaE.Yw-woXuugQbeFhBpzwFQtqq_v2v1HOKznoMBqbciQpE@example.com>
                          postfix_id: 47JJcT1w6GztQV7
                          sent_date: 2019-11-21T00:22:01
                          subject: listen, I highly recommend u to read that email, just to ensure not a thing will take place
                          threat_categories:
                            - IPReputation
                            - ASNReputation
                          to:
                            - email@example.com
                          to_name:
                            - Recipient Name
                          ts: 2019-11-20T23:22:01
                          validation:
                            comment:
                            dkim: pass
                            dmarc: none
                            spf: fail
                    required:
                      - result
                    type: object
          description: Email message details
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get message details
      tags:
        - Email Security
  /accounts/{account_id}/email-security/investigate/{postfix_id}/detections:
    get:
      description: |-
        For emails that have a detection, this endpoint returns detection details
        such as threat categories, sender information, and links.
      operationId: email_security_get_message_detections
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: postfix_id
          required: true
          schema:
            description: Message identifier
            example: 4Njp3P0STMz2c02Q
            title: postfix_id
            type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        example:
                          action: QUARANTINED
                          attachments: []
                          final_disposition: MALICIOUS
                          headers:
                            - name: From
                              value: Sender Name <d1994@example.com>
                            - name: Subject
                              value: listen, I highly recommend u to read that email, just to ensure not a thing will take place
                          links:
                            - href: https://example.com
                              text: Click here!
                          sender_info:
                            as_name: AS0
                            as_number: 0
                            geo: US/-/-
                            ip: 127.0.0.1
                            pld: example.com
                          threat_categories:
                            - description:
                              id: 1234
                              name: IP Reputation
                          validation:
                            comment:
                            dkim: pass
                            dmarc: none
                            spf: fail
                        properties:
                          action:
                            type: string
                          attachments:
                            items:
                              $ref: '#/components/schemas/email-security_Attachment'
                            type: array
                          final_disposition:
                            allOf:
                              - $ref: '#/components/schemas/email-security_DispositionLabel'
                              - nullable: true
                                type: string
                          headers:
                            items:
                              $ref: '#/components/schemas/email-security_MessageHeader'
                            type: array
                          links:
                            items:
                              $ref: '#/components/schemas/email-security_Link'
                            type: array
                          sender_info:
                            properties:
                              as_name:
                                description: Name of the autonomous system
                                nullable: true
                                type: string
                              as_number:
                                description: Number of the autonomous system
                                format: int64
                                nullable: true
                                type: integer
                              geo:
                                nullable: true
                                type: string
                              ip:
                                nullable: true
                                type: string
                              pld:
                                nullable: true
                                type: string
                            type: object
                          threat_categories:
                            items:
                              $ref: '#/components/schemas/email-security_ThreatCategory'
                            type: array
                          validation:
                            properties:
                              comment:
                                nullable: true
                                type: string
                              dkim:
                                allOf:
                                  - $ref: '#/components/schemas/email-security_ValidationStatus'
                                  - nullable: true
                                    type: string
                              dmarc:
                                allOf:
                                  - $ref: '#/components/schemas/email-security_ValidationStatus'
                                  - nullable: true
                                    type: string
                              spf:
                                allOf:
                                  - $ref: '#/components/schemas/email-security_ValidationStatus'
                                  - nullable: true
                                    type: string
                            type: object
                        required:
                          - validation
                          - headers
                          - threat_categories
                          - sender_info
                          - links
                          - action
                          - attachments
                        type: object
                    required:
                      - result
                    type: object
          description: Email detection details
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get message detection details
      tags:
        - Email Security
  /accounts/{account_id}/email-security/investigate/{postfix_id}/preview:
    get:
      description: |-
        For emails that have a detection, this endpoint returns a preview of the
        message body as a base64 encoded PNG image.
      operationId: email_security_get_message_preview
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: postfix_id
          required: true
          schema:
            description: Message identifier
            example: 4Njp3P0STMz2c02Q
            title: postfix_id
            type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        example:
                          screenshot: iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAYAAADimHc4AAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABgAAAAAQAAAGAAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAAGCgAwAEAAAAAQAAAGAAAAAAtVTeigAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KGV7hBwAACXtJREFUeAHtmwtwXFUZgP9zX7t3b7LNa9M2tGmLDbaWKpL6aBBJHdERQWGkU4u8CraVWmYQYWQUMSoKhZJikYo4Qqc6RVqkKmNHC0K1FGYoM9pqS4FAa9s0aTavfd3d+zq/527YSNvdzWY3m2ySc2c2595z/vOf///+e+4959wTAH5wApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwAhOJABmvzuCz158HXmUp2rCEOlhGbEdFh2qASFAgtiCKMUGgh8FM7IDDp3aQlt12Kfo6rgKAz3ylAQ3rJ/Fg39XYfyx32wUJpJpZ7wiq8LPebuGJaXfuipVKMHJ3YowsRgQC265aE+/quYf2/Le2YDM85aBOn/m7GDHX+m/4W0/B+gpUUNIBwN98rknvif4J+9urC/Tz7OqKBp66+vWSUf9dsvpx62yB0ckpyQDgLxtlS5iyyTx59OuATlFJkOrZYV9l7afItdv/XdSGMigvuQBEHmyqJRLug9DJ+gw2j3y2qIDWcOEPyFef/tHIK8+usaQCEGpdPFd0rEMQC8rZzS5OqXr+JU+JV2+5pjja02sV0mePfm7/I5+eIznm22MF3/U4/p+/L3d23LhxNL0viR7Qs/ETfo/lnIBIsHw0nU/bFiGgLbp0BfnirzanLR/hzJLoAV6QXywJ+C5cNu6N7d/7JD6zat4Is06rbswDENvU/A3sPd6Y1rqxyjRjkDj1zp7RaH5MA3CkpdkL0fAvRsPR4bbhBNtqcNvS7w233nDlxzQAgUp7E+pjPhnNyEw/duRefJLdJEU8pGLo7mptnuuTSJNHkeaBIPhMK/6Gbjm7A7ftfTPV3sGWBQpEu1ekrksxxWgQoLr6Tmbbj4tl34iOgmIbPnsLG8w9hKETajqDiX86sCXJe/1a4D4QEnfF2t/6fjq5UsojFTNQu21v0Z4UIxKA4LqL6nwyfQ3DJ8/JBR7x1wGIEmDfsVzEx1xGO3f+xeT6v7xcDEMKjmystXmRSkPtucJ3nWCy4wZ+0l7wfLsY8F2dBQWg46cfDaDVtw+MSLHsKwm98VDky8UypKAA+BVpF8T7i2Vb6eg1IiPyqE7nUN6joL51jUsw2nVBOqUTLc9TGfi965O++dLlomZvBSICyBoQpdyQVP8R4hFfgAQ+Spb8/PBwfc87AGWadrcR7x5ue+NS3qK2OxQFpcq72jGi7CXGvlGYYUAz7LGi7e6Shftba/x5ma1UB9ZDL2khlz1iuHWGOvJ+BJl65DNDKZ8I5UL17E515a4jri+OEbsoq096l2QeP3iXaR5N4MurH8SWliH5DimQqUHUezMVTah8tVx7wHUIdy6/gv3N7YlhRcHseOsOc9HBKL54S9Z1rrwCcLxlQdWEopzJGfbdGG7Y+XAyABK9MZNYxvx4t2r2vv067l55ayaZvAJgQ0zPpHAi5StT52xjnwfQ9cnWI9kfP5kcZ+8LM9i2EXfffE86kbwCMBuOmiCnXW1I18a4zCO+KuiVrZtSxqMVn5o6zyc1g+/+EF+47uYz6+Y8vg0/vPhygQjLRFH5JLXNWgx3+oGW5GazM33M61o+Z96VnpV//WOqsrF9SbInpK7zStnwVdDqmuQvbHk1VT9rAI63Lq6qJnQTNfRlkAin6kz4VKit/5ZvzZ7ksz/lrPmHy6KsF7CXQoGHp1JXOmoqUnuRMj6CEq0ff6Ay2tVDQ52TB77INmME6lecCd9FLlfUPFUg+oHqRp+Pzk08mtJ1Vg/oallQVlZR/i/a3/GBlNBkSIWqGW2iR7vCs3pX2tksvtQi2frBU1TvLnwEKChgls2ZWv75x7pOC4C7O8GbMNvYGD8wGaAD27QrT2s4KsrON6UVz+8cymd8fZUPYvLzZk9bEzjmUOJZy5VAw29J8+PXnRaAWGvjIQx3z89aM89CEmhwRMUXQVGRmOMC+x5AWOr+2NIKSwl7Ggoish8lRKDsSxplTVnuTwTU2aZzQwCMszehxXYu2AIhCQDKpvvERAImUGIK7jXSePJHWWpRHWw7wQYLcaDolplA0GLnukWddvmmpw+khpnDcQvfXF8DAlkKhnkhmEY52IYKlqGiZWho2z5KDYWtEPtpondGRr3eKlDKFsqDAQhvaLxfCHV/J2OFQgpkL2g152mw6rl4Pg4X0nSx6iL7PwQ4tF0GpXOAYchDIdIxMFIKHkRQKz2m8W4nWzcqz2SDUvfhS5KVO+9vXFhm9B5gd0gm2YLzhepze8G2goiCA6J7dxN31y0bxxKbBcUdz9psJ3ryjgc2d2Gb0m0KaDGTbHbHs/7Ozh1IUGC5wHoDEsthZQjUrWMTBMtheQSphQJYyFKB9Q6Kznup24Mck3Uvk1IITaP73iAtTFkeB+6/oxao8jHWA2ex3lVLEQPEtmqpZVewfxKpQjOmYLx/OpjR6mzqlfqFTyQDEHrogufESN/l2YQnXBmLuhyY+YpBjS/5177WM5R/+I9bA+Cl66ye0DUYbfcMJZ9LuVgz/wQJbrh4uho+wb4R5nUz5NJOact4/WznQ8VHylbuOZDJUNx97Vazu2P5SDMi5bNAKpetpfZkhe8SdyeYEfUVdlZ2ZgBwx5UVjoL7zWB7/ZllI3GNiW425vDVrBkJZeNaR/iUFnns4g+93wd89qpqC+Jtjh4uCvxkW1YMBDNhfvD9DU/Wc0VwBoff+FKz5JDwPrTNrC/Rglm5/zyIkVMF65kICmyHzRPeO5w+2Ow4dE7qumgpmwsIk2JXQw4E43H9n65Y75am8x2HfC2HKgWLEG+1I4BU1L2nBRs5GgrcLZM1t+9vd9vy+jx3j0abbhuypu0TSNnkWPbJBpWtV/w6VS6gsDR1XvQU6Vapa4qkJvrVaRTEMFvAsB2drcewQ/Q5BNj0JOSjA1NtljdFFwY/Srgzlwp1QNaVTx1inNU77dV12gU4qjSoI1XHictn5dla71l5KfnBdIjXl1U2oNcMKTh9SgfaPazthoHaXjswuBQ/8/ZX4ymdHVFHU+tmimoo4Ul4JBmdBFt5khDVBJtbS1junvt0REtO/tx6RLaSjIg+kKZ0oclktCibx//fP0HzCIIlCwnPFLn2+LHJsa8nBYSnnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACk4DA/wDoepVZ2hARhAAAAABJRU5ErkJggg==
                        properties:
                          screenshot:
                            description: Base64 encoded PNG image
                            type: string
                        required:
                          - screenshot
                        type: object
                    required:
                      - result
                    type: object
          description: Email preview
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get email preview
      tags:
        - Email Security
      x-api-token-group:
        - 'Cloud Email Security: Write'
        - 'Cloud Email Security: Read'
  /accounts/{account_id}/email-security/investigate/{postfix_id}/raw:
    get:
      description: |-
        For emails that have a detection, this endpoint returns the raw email
        as an EML file.
      operationId: email_security_get_message_raw
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: postfix_id
          required: true
          schema:
            description: Message identifier
            example: 4Njp3P0STMz2c02Q
            title: postfix_id
            type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        example:
                          raw: |-
                            MIME-Version: 1.0
                            Content-Type: text/plain; charset="utf-8"

                            From: sender@example.com
                            To: recipient@example.com
                            Subject: Test Email

                            This is a test email.
                        properties:
                          raw:
                            description: UTF-8 encoded eml file
                            type: string
                        required:
                          - raw
                        type: object
                    required:
                      - result
                    type: object
          description: Raw email content
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get raw email content
      tags:
        - Email Security
      x-api-token-group:
        - 'Cloud Email Security: Write'
        - 'Cloud Email Security: Read'
  /accounts/{account_id}/email-security/investigate/{postfix_id}/trace:
    get:
      operationId: email_security_get_message_trace
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: postfix_id
          required: true
          schema:
            description: Message identifier
            example: 4Njp3P0STMz2c02Q
            title: postfix_id
            type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        properties:
                          inbound:
                            properties:
                              lines:
                                items:
                                  $ref: '#/components/schemas/email-security_TraceLine'
                                nullable: true
                                type: array
                            type: object
                          outbound:
                            properties:
                              lines:
                                items:
                                  $ref: '#/components/schemas/email-security_TraceLine'
                                nullable: true
                                type: array
                            type: object
                        required:
                          - inbound
                          - outbound
                        type: object
                    required:
                      - result
                    type: object
          description: Email trace
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get email trace
      tags:
        - Email Security
      x-api-token-group:
        - 'Cloud Email Security: Write'
        - 'Cloud Email Security: Read'
  /accounts/{account_id}/email-security/phishguard/reports:
    get:
      operationId: email_security_get_phishguard_reports
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - example: "2020-08-01"
          in: query
          name: from_date
          required: true
          schema:
            format: date
            type: string
        - example: "2020-09-01"
          in: query
          name: to_date
          required: true
          schema:
            format: date
            type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/email-security_PhishGuardReport'
                        type: array
                    required:
                      - result
                    type: object
          description: PhishGuard reports
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get PhishGuard reports
      tags:
        - Email Security
  /accounts/{account_id}/email-security/settings/allow_patterns:
    delete:
      operationId: email_security_delete_allow_patterns
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    example: 2401
                    format: int32
                    title: identifier
                    type: integer
                required:
                  - id
                type: object
              minItems: 1
              type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        items:
                          properties:
                            id:
                              example: 2401
                              format: int32
                              title: identifier
                              type: integer
                          required:
                            - id
                          type: object
                        minItems: 1
                        type: array
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete multiple email allow patterns
      tags:
        - Email Security Settings
    get:
      description: List, search, and sort an accounts's email allow patterns.
      operationId: email_security_list_allow_patterns
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - description: Page number of paginated results.
          in: query
          name: page
          schema:
            default: 1
            format: int32
            minimum: 1
            type: integer
        - description: Number of results to display.
          in: query
          name: per_page
          schema:
            default: 20
            format: int32
            minimum: 1
            type: integer
        - description: The field to sort by.
          in: query
          name: order
          schema:
            enum:
              - pattern
              - created_at
            type: string
        - description: The sorting direction.
          in: query
          name: direction
          schema:
            allOf:
              - $ref: '#/components/schemas/email-security_SortingDirection'
        - description: |-
            Allows searching in multiple properties of a record simultaneously.
            This parameter is intended for human users, not automation. Its exact
            behavior is intentionally left unspecified and is subject to change
            in the future.
          in: query
          name: search
          schema:
            type: string
        - in: query
          name: is_sender
          schema:
            type: boolean
        - in: query
          name: is_recipient
          schema:
            type: boolean
        - in: query
          name: is_spoof
          schema:
            type: boolean
        - in: query
          name: verify_sender
          schema:
            type: boolean
        - in: query
          name: pattern_type
          schema:
            allOf:
              - $ref: '#/components/schemas/email-security_PatternType'
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/email-security_AllowPattern'
                        type: array
                      result_info:
                        $ref: '#/components/schemas/email-security_ResultInfo'
                    required:
                      - result
                      - result_info
                    type: object
          description: List of allow-patterns for the provided account
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List email allow patterns
      tags:
        - Email Security Settings
    post:
      operationId: email_security_create_allow_pattern
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/email-security_CreateAllowPattern'
                - items:
                    $ref: '#/components/schemas/email-security_CreateAllowPattern'
                  type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "201":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        oneOf:
                          - $ref: '#/components/schemas/email-security_AllowPattern'
                          - items:
                              $ref: '#/components/schemas/email-security_AllowPattern'
                            type: array
                    required:
                      - result
                    type: object
          description: Returns the newly created patterns in the same shape as the request body
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create an email allow pattern
      tags:
        - Email Security Settings
  /accounts/{account_id}/email-security/settings/allow_patterns/{pattern_id}:
    delete:
      operationId: email_security_delete_allow_pattern
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: pattern_id
          required: true
          schema:
            example: 2401
            format: int32
            title: identifier
            type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        properties:
                          id:
                            example: 2401
                            format: int32
                            title: identifier
                            type: integer
                        required:
                          - id
                        type: object
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an email allow pattern
      tags:
        - Email Security Settings
    get:
      operationId: email_security_get_allow_pattern
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: pattern_id
          required: true
          schema:
            example: 2401
            format: int32
            title: identifier
            type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        allOf:
                          - additionalProperties: false
                            example:
                              comments: Trust all messages send from test@example.com
                              is_recipient: false
                              is_regex: false
                              is_sender: true
                              is_spoof: false
                              pattern: test@example.com
                              pattern_type: EMAIL
                              verify_sender: true
                            properties:
                              comments:
                                nullable: true
                                type: string
                              is_recipient:
                                type: boolean
                              is_regex:
                                type: boolean
                              is_sender:
                                type: boolean
                              is_spoof:
                                type: boolean
                              pattern:
                                minLength: 1
                                type: string
                              pattern_type:
                                $ref: '#/components/schemas/email-security_PatternType'
                              verify_sender:
                                type: boolean
                            required:
                              - is_recipient
                              - is_sender
                              - is_spoof
                              - pattern
                              - is_regex
                              - verify_sender
                              - pattern_type
                            type: object
                          - properties:
                              created_at:
                                format: date-time
                                type: string
                              id:
                                example: 2401
                                format: int32
                                title: identifier
                                type: integer
                              last_modified:
                                format: date-time
                                type: string
                            required:
                              - id
                              - created_at
                              - last_modified
                            type: object
                        example:
                          comments: Trust all messages send from test@example.com
                          created_at: "2023-11-14T22:13:20Z"
                          id: 2401
                          is_recipient: false
                          is_regex: false
                          is_sender: true
                          is_spoof: false
                          last_modified: "2023-11-14T22:13:20Z"
                          pattern: test@example.com
                          pattern_type: EMAIL
                          verify_sender: true
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an email allow pattern
      tags:
        - Email Security Settings
    patch:
      operationId: email_security_update_allow_pattern
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: pattern_id
          required: true
          schema:
            example: 2401
            format: int32
            title: identifier
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                comments:
                  nullable: true
                  type: string
                is_recipient:
                  nullable: true
                  type: boolean
                is_regex:
                  nullable: true
                  type: boolean
                is_sender:
                  nullable: true
                  type: boolean
                is_spoof:
                  nullable: true
                  type: boolean
                pattern:
                  minLength: 1
                  nullable: true
                  type: string
                pattern_type:
                  allOf:
                    - $ref: '#/components/schemas/email-security_PatternType'
                    - nullable: true
                      type: string
                verify_sender:
                  nullable: true
                  type: boolean
              type: object
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        allOf:
                          - additionalProperties: false
                            example:
                              comments: Trust all messages send from test@example.com
                              is_recipient: false
                              is_regex: false
                              is_sender: true
                              is_spoof: false
                              pattern: test@example.com
                              pattern_type: EMAIL
                              verify_sender: true
                            properties:
                              comments:
                                nullable: true
                                type: string
                              is_recipient:
                                type: boolean
                              is_regex:
                                type: boolean
                              is_sender:
                                type: boolean
                              is_spoof:
                                type: boolean
                              pattern:
                                minLength: 1
                                type: string
                              pattern_type:
                                $ref: '#/components/schemas/email-security_PatternType'
                              verify_sender:
                                type: boolean
                            required:
                              - is_recipient
                              - is_sender
                              - is_spoof
                              - pattern
                              - is_regex
                              - verify_sender
                              - pattern_type
                            type: object
                          - properties:
                              created_at:
                                format: date-time
                                type: string
                              id:
                                example: 2401
                                format: int32
                                title: identifier
                                type: integer
                              last_modified:
                                format: date-time
                                type: string
                            required:
                              - id
                              - created_at
                              - last_modified
                            type: object
                        example:
                          comments: Trust all messages send from test@example.com
                          created_at: "2023-11-14T22:13:20Z"
                          id: 2401
                          is_recipient: false
                          is_regex: false
                          is_sender: true
                          is_spoof: false
                          last_modified: "2023-11-14T22:13:20Z"
                          pattern: test@example.com
                          pattern_type: EMAIL
                          verify_sender: true
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an email allow pattern
      tags:
        - Email Security Settings
  /accounts/{account_id}/email-security/settings/block_senders:
    delete:
      operationId: email_security_delete_blocked_senders
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    example: 2402
                    format: int32
                    title: identifier
                    type: integer
                required:
                  - id
                type: object
              minItems: 1
              type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        items:
                          properties:
                            id:
                              example: 2402
                              format: int32
                              title: identifier
                              type: integer
                          required:
                            - id
                          type: object
                        minItems: 1
                        type: array
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete multiple blocked email senders
      tags:
        - Email Security Settings
    get:
      operationId: email_security_list_blocked_senders
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - description: Page number of paginated results.
          in: query
          name: page
          schema:
            default: 1
            format: int32
            minimum: 1
            type: integer
        - description: Number of results to display.
          in: query
          name: per_page
          schema:
            default: 20
            format: int32
            minimum: 1
            type: integer
        - description: The field to sort by.
          in: query
          name: order
          schema:
            enum:
              - pattern
              - created_at
            type: string
        - description: The sorting direction.
          in: query
          name: direction
          schema:
            allOf:
              - $ref: '#/components/schemas/email-security_SortingDirection'
        - description: |-
            Allows searching in multiple properties of a record simultaneously.
            This parameter is intended for human users, not automation. Its exact
            behavior is intentionally left unspecified and is subject to change
            in the future.
          in: query
          name: search
          schema:
            type: string
        - in: query
          name: pattern_type
          schema:
            allOf:
              - $ref: '#/components/schemas/email-security_PatternType'
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/email-security_BlockedSender'
                        type: array
                      result_info:
                        $ref: '#/components/schemas/email-security_ResultInfo'
                    required:
                      - result
                      - result_info
                    type: object
          description: List of blocked senders for the provided account
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List blocked email senders
      tags:
        - Email Security Settings
    post:
      operationId: email_security_create_blocked_sender
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/email-security_CreateBlockedSender'
                - items:
                    $ref: '#/components/schemas/email-security_CreateBlockedSender'
                  type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "201":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        oneOf:
                          - $ref: '#/components/schemas/email-security_BlockedSender'
                          - items:
                              $ref: '#/components/schemas/email-security_BlockedSender'
                            type: array
                    required:
                      - result
                    type: object
          description: Returns the newly created patterns in the same shape as the request body
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a blocked email sender
      tags:
        - Email Security Settings
  /accounts/{account_id}/email-security/settings/block_senders/{pattern_id}:
    delete:
      operationId: email_security_delete_blocked_sender
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: pattern_id
          required: true
          schema:
            example: 2402
            format: int32
            title: identifier
            type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        properties:
                          id:
                            example: 2402
                            format: int32
                            title: identifier
                            type: integer
                        required:
                          - id
                        type: object
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a blocked email sender
      tags:
        - Email Security Settings
    get:
      operationId: email_security_get_blocked_sender
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: pattern_id
          required: true
          schema:
            example: 2402
            format: int32
            title: identifier
            type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        allOf:
                          - additionalProperties: false
                            example:
                              comments: block sender with email test@example.com
                              is_regex: false
                              pattern: test@example.com
                              pattern_type: EMAIL
                            properties:
                              comments:
                                nullable: true
                                type: string
                              is_regex:
                                type: boolean
                              pattern:
                                minLength: 1
                                type: string
                              pattern_type:
                                $ref: '#/components/schemas/email-security_PatternType'
                            required:
                              - pattern
                              - is_regex
                              - pattern_type
                            type: object
                          - properties:
                              created_at:
                                format: date-time
                                type: string
                              id:
                                example: 2402
                                format: int32
                                title: identifier
                                type: integer
                              last_modified:
                                format: date-time
                                type: string
                            required:
                              - id
                              - created_at
                              - last_modified
                            type: object
                        example:
                          comments: block sender with email test@example.com
                          created_at: "2023-11-14T22:13:20Z"
                          id: 2402
                          is_regex: false
                          last_modified: "2023-11-14T22:13:20Z"
                          pattern: test@example.com
                          pattern_type: EMAIL
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a blocked email sender
      tags:
        - Email Security Settings
    patch:
      operationId: email_security_update_blocked_sender
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: pattern_id
          required: true
          schema:
            example: 2402
            format: int32
            title: identifier
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                comments:
                  nullable: true
                  type: string
                is_regex:
                  nullable: true
                  type: boolean
                pattern:
                  minLength: 1
                  nullable: true
                  type: string
                pattern_type:
                  allOf:
                    - $ref: '#/components/schemas/email-security_PatternType'
                    - nullable: true
                      type: string
              type: object
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        allOf:
                          - additionalProperties: false
                            example:
                              comments: block sender with email test@example.com
                              is_regex: false
                              pattern: test@example.com
                              pattern_type: EMAIL
                            properties:
                              comments:
                                nullable: true
                                type: string
                              is_regex:
                                type: boolean
                              pattern:
                                minLength: 1
                                type: string
                              pattern_type:
                                $ref: '#/components/schemas/email-security_PatternType'
                            required:
                              - pattern
                              - is_regex
                              - pattern_type
                            type: object
                          - properties:
                              created_at:
                                format: date-time
                                type: string
                              id:
                                example: 2402
                                format: int32
                                title: identifier
                                type: integer
                              last_modified:
                                format: date-time
                                type: string
                            required:
                              - id
                              - created_at
                              - last_modified
                            type: object
                        example:
                          comments: block sender with email test@example.com
                          created_at: "2023-11-14T22:13:20Z"
                          id: 2402
                          is_regex: false
                          last_modified: "2023-11-14T22:13:20Z"
                          pattern: test@example.com
                          pattern_type: EMAIL
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a blocked email sender
      tags:
        - Email Security Settings
  /accounts/{account_id}/email-security/settings/domains:
    delete:
      operationId: email_security_delete_domains
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    description: Unique domain identifier
                    example: 2400
                    format: int32
                    type: integer
                required:
                  - id
                type: object
              minItems: 1
              type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        items:
                          properties:
                            id:
                              description: Unique domain identifier
                              example: 2400
                              format: int32
                              type: integer
                          required:
                            - id
                          type: object
                        minItems: 1
                        type: array
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Unprotect multiple email domains
      tags:
        - Email Security Settings
    get:
      description: List, search, and sort an account's email domains.
      operationId: email_security_list_domains
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - description: Page number of paginated results.
          in: query
          name: page
          schema:
            default: 1
            format: int32
            minimum: 1
            type: integer
        - description: Number of results to display.
          in: query
          name: per_page
          schema:
            default: 20
            format: int32
            minimum: 1
            type: integer
        - description: The field to sort by.
          in: query
          name: order
          schema:
            enum:
              - domain
              - created_at
            type: string
        - description: The sorting direction.
          in: query
          name: direction
          schema:
            allOf:
              - $ref: '#/components/schemas/email-security_SortingDirection'
        - description: |-
            Allows searching in multiple properties of a record simultaneously.
            This parameter is intended for human users, not automation. Its exact
            behavior is intentionally left unspecified and is subject to change
            in the future.
          in: query
          name: search
          schema:
            type: string
        - description: If present, the response contains only domains with the provided delivery mode.
          in: query
          name: allowed_delivery_mode
          schema:
            allOf:
              - $ref: '#/components/schemas/email-security_DeliveryMode'
        - description: |-
            Filter result by the provided domains.
            Allows for multiple occurrences, e.g., `domain=example.com&domain=example.xyz`.
          in: query
          name: domain
          schema:
            items:
              type: string
            type: array
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/email-security_Domain'
                        type: array
                      result_info:
                        $ref: '#/components/schemas/email-security_ResultInfo'
                    required:
                      - result
                      - result_info
                    type: object
          description: List of domains for the provided account
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List protected email domains
      tags:
        - Email Security Settings
  /accounts/{account_id}/email-security/settings/domains/{domain_id}:
    delete:
      operationId: email_security_delete_domain
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: domain_id
          required: true
          schema:
            description: Unique domain identifier
            example: 2400
            format: int32
            type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        properties:
                          id:
                            description: Unique domain identifier
                            example: 2400
                            format: int32
                            type: integer
                        required:
                          - id
                        type: object
                    required:
                      - result
                    type: object
          description: Delete the domain with the provided id
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Unprotect an email domain
      tags:
        - Email Security Settings
    patch:
      operationId: email_security_update_domain
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: domain_id
          required: true
          schema:
            description: Unique domain identifier
            example: 2400
            format: int32
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                domain:
                  nullable: true
                  type: string
                lookback_hops:
                  format: int32
                  maximum: 20
                  minimum: 1
                  nullable: true
                  type: integer
              type: object
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        example:
                          allowed_delivery_modes:
                            - API
                          created_at: "2023-11-14T22:13:20Z"
                          domain: example.com
                          id: 2400
                          integration_id: a5dbb180-60ea-4578-84bb-d01a5d4e50c3
                          last_modified: "2023-11-14T22:13:20Z"
                          lookback_hops: 2
                          o365_tenant_id: c3c3239d-8858-47df-9618-0e2d9bdf6aa8
                        properties:
                          allowed_delivery_modes:
                            items:
                              $ref: '#/components/schemas/email-security_DeliveryMode'
                            type: array
                          created_at:
                            format: date-time
                            type: string
                          domain:
                            type: string
                          id:
                            description: Unique domain identifier
                            example: 2400
                            format: int32
                            type: integer
                          integration_id:
                            format: uuid
                            nullable: true
                            type: string
                          last_modified:
                            format: date-time
                            type: string
                          lookback_hops:
                            format: int32
                            type: integer
                          o365_tenant_id:
                            nullable: true
                            type: string
                        required:
                          - id
                          - created_at
                          - last_modified
                          - domain
                          - allowed_delivery_modes
                          - lookback_hops
                        type: object
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an email domain
      tags:
        - Email Security Settings
  /accounts/{account_id}/email-security/settings/impersonation_registry:
    delete:
      operationId: email_security_delete_display_names
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    example: 2403
                    format: int32
                    title: identifier
                    type: integer
                required:
                  - id
                type: object
              minItems: 1
              type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        items:
                          properties:
                            id:
                              example: 2403
                              format: int32
                              title: identifier
                              type: integer
                          required:
                            - id
                          type: object
                        minItems: 1
                        type: array
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete multiple entries from impersonation registry
      tags:
        - Email Security Settings
    get:
      description: List, search, and sort entries in impersonation registry.
      operationId: email_security_list_display_names
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - description: Page number of paginated results.
          in: query
          name: page
          schema:
            default: 1
            format: int32
            minimum: 1
            type: integer
        - description: Number of results to display.
          in: query
          name: per_page
          schema:
            default: 20
            format: int32
            minimum: 1
            type: integer
        - description: The field to sort by.
          in: query
          name: order
          schema:
            enum:
              - name
              - email
              - created_at
            type: string
        - description: The sorting direction.
          in: query
          name: direction
          schema:
            allOf:
              - $ref: '#/components/schemas/email-security_SortingDirection'
        - description: |-
            Allows searching in multiple properties of a record simultaneously.
            This parameter is intended for human users, not automation. Its exact
            behavior is intentionally left unspecified and is subject to change
            in the future.
          in: query
          name: search
          schema:
            type: string
        - in: query
          name: provenance
          schema:
            allOf:
              - enum:
                  - A1S_INTERNAL
                  - SNOOPY-CASB_OFFICE_365
                  - SNOOPY-OFFICE_365
                  - SNOOPY-GOOGLE_DIRECTORY
                type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/email-security_DisplayName'
                        type: array
                      result_info:
                        $ref: '#/components/schemas/email-security_ResultInfo'
                    required:
                      - result
                      - result_info
                    type: object
          description: List of impersonation registry entries for the provided account
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List entries in impersonation registry
      tags:
        - Email Security Settings
    post:
      operationId: email_security_create_display_name
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/email-security_CreateDisplayName'
                - items:
                    $ref: '#/components/schemas/email-security_CreateDisplayName'
                  type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "201":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        oneOf:
                          - $ref: '#/components/schemas/email-security_DisplayName'
                          - items:
                              $ref: '#/components/schemas/email-security_DisplayName'
                            type: array
                    required:
                      - result
                    type: object
          description: Returns the newly created entry in the same shape as the request body
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create an entry in impersonation registry
      tags:
        - Email Security Settings
  /accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}:
    delete:
      operationId: email_security_delete_display_name
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: display_name_id
          required: true
          schema:
            example: 2403
            format: int32
            title: identifier
            type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        properties:
                          id:
                            example: 2403
                            format: int32
                            title: identifier
                            type: integer
                        required:
                          - id
                        type: object
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an entry from impersonation registry
      tags:
        - Email Security Settings
    get:
      operationId: email_security_get_display_name
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: display_name_id
          required: true
          schema:
            example: 2403
            format: int32
            title: identifier
            type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        properties:
                          comments:
                            nullable: true
                            type: string
                          created_at:
                            format: date-time
                            type: string
                          directory_id:
                            allOf:
                              - format: int64
                                type: integer
                              - nullable: true
                                type: integer
                          directory_node_id:
                            nullable: true
                            type: string
                          email:
                            nullable: true
                            type: string
                          id:
                            example: 2403
                            format: int32
                            title: identifier
                            type: integer
                          is_email_regex:
                            type: boolean
                          last_modified:
                            format: date-time
                            type: string
                          name:
                            type: string
                          provenance:
                            nullable: true
                            type: string
                        required:
                          - id
                          - created_at
                          - last_modified
                          - name
                          - is_email_regex
                        type: object
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an entry in impersonation registry
      tags:
        - Email Security Settings
    patch:
      operationId: email_security_update_display_name
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: display_name_id
          required: true
          schema:
            example: 2403
            format: int32
            title: identifier
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                email:
                  nullable: true
                  type: string
                is_email_regex:
                  nullable: true
                  type: boolean
                name:
                  nullable: true
                  type: string
              type: object
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        properties:
                          comments:
                            nullable: true
                            type: string
                          created_at:
                            format: date-time
                            type: string
                          directory_id:
                            allOf:
                              - format: int64
                                type: integer
                              - nullable: true
                                type: integer
                          directory_node_id:
                            nullable: true
                            type: string
                          email:
                            nullable: true
                            type: string
                          id:
                            example: 2403
                            format: int32
                            title: identifier
                            type: integer
                          is_email_regex:
                            type: boolean
                          last_modified:
                            format: date-time
                            type: string
                          name:
                            type: string
                          provenance:
                            nullable: true
                            type: string
                        required:
                          - id
                          - created_at
                          - last_modified
                          - name
                          - is_email_regex
                        type: object
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an entry in impersonation registry
      tags:
        - Email Security Settings
  /accounts/{account_id}/email-security/settings/trusted_domains:
    delete:
      operationId: email_security_delete_trusted_domains
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    example: 2401
                    format: int32
                    title: identifier
                    type: integer
                required:
                  - id
                type: object
              minItems: 1
              type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        items:
                          properties:
                            id:
                              example: 2401
                              format: int32
                              title: identifier
                              type: integer
                          required:
                            - id
                          type: object
                        minItems: 1
                        type: array
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete multiple trusted email domains
      tags:
        - Email Security Settings
    get:
      description: List, search, and sort an account's trusted email domains.
      operationId: email_security_list_trusted_domains
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - description: Page number of paginated results.
          in: query
          name: page
          schema:
            default: 1
            format: int32
            minimum: 1
            type: integer
        - description: Number of results to display.
          in: query
          name: per_page
          schema:
            default: 20
            format: int32
            minimum: 1
            type: integer
        - description: The field to sort by.
          in: query
          name: order
          schema:
            enum:
              - pattern
              - created_at
            type: string
        - description: The sorting direction.
          in: query
          name: direction
          schema:
            allOf:
              - $ref: '#/components/schemas/email-security_SortingDirection'
        - description: |-
            Allows searching in multiple properties of a record simultaneously.
            This parameter is intended for human users, not automation. Its exact
            behavior is intentionally left unspecified and is subject to change
            in the future.
          in: query
          name: search
          schema:
            type: string
        - in: query
          name: is_recent
          schema:
            type: boolean
        - in: query
          name: is_similarity
          schema:
            type: boolean
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/email-security_TrustedDomain'
                        type: array
                      result_info:
                        $ref: '#/components/schemas/email-security_ResultInfo'
                    required:
                      - result
                      - result_info
                    type: object
          description: List of trusted domains for the provided account
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List trusted email domains
      tags:
        - Email Security Settings
    post:
      operationId: email_security_create_trusted_domain
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/email-security_CreateTrustedDomain'
                - items:
                    $ref: '#/components/schemas/email-security_CreateTrustedDomain'
                  type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "201":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        oneOf:
                          - $ref: '#/components/schemas/email-security_TrustedDomain'
                          - items:
                              $ref: '#/components/schemas/email-security_TrustedDomain'
                            type: array
                    required:
                      - result
                    type: object
          description: Returns the newly created trusted domains in the same shape as the request body
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a trusted email domain
      tags:
        - Email Security Settings
  /accounts/{account_id}/email-security/settings/trusted_domains/{pattern_id}:
    delete:
      operationId: email_security_delete_trusted_domain
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: pattern_id
          required: true
          schema:
            example: 2401
            format: int32
            title: identifier
            type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        properties:
                          id:
                            example: 2401
                            format: int32
                            title: identifier
                            type: integer
                        required:
                          - id
                        type: object
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a trusted email domain
      tags:
        - Email Security Settings
    get:
      operationId: email_security_get_trusted_domain
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: pattern_id
          required: true
          schema:
            example: 2401
            format: int32
            title: identifier
            type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        allOf:
                          - additionalProperties: false
                            example:
                              comments:
                              is_recent: true
                              is_regex: false
                              is_similarity: false
                              pattern: example.com
                            properties:
                              comments:
                                nullable: true
                                type: string
                              is_recent:
                                type: boolean
                              is_regex:
                                type: boolean
                              is_similarity:
                                type: boolean
                              pattern:
                                minLength: 1
                                type: string
                            required:
                              - is_recent
                              - is_similarity
                              - is_regex
                              - pattern
                            type: object
                          - properties:
                              created_at:
                                format: date-time
                                type: string
                              id:
                                example: 2401
                                format: int32
                                title: identifier
                                type: integer
                              last_modified:
                                format: date-time
                                type: string
                            required:
                              - id
                              - created_at
                              - last_modified
                            type: object
                        example:
                          comments:
                          created_at: "2023-11-14T22:13:20Z"
                          id: 2401
                          is_recent: true
                          is_regex: false
                          is_similarity: false
                          last_modified: "2023-11-14T22:13:20Z"
                          pattern: example.com
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a trusted email domain
      tags:
        - Email Security Settings
    patch:
      operationId: email_security_update_trusted_domain
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email-security_AccountId'
        - in: path
          name: pattern_id
          required: true
          schema:
            example: 2401
            format: int32
            title: identifier
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                comments:
                  nullable: true
                  type: string
                is_recent:
                  nullable: true
                  type: boolean
                is_regex:
                  nullable: true
                  type: boolean
                is_similarity:
                  nullable: true
                  type: boolean
                pattern:
                  minLength: 1
                  nullable: true
                  type: string
              type: object
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                  - properties:
                      result:
                        allOf:
                          - additionalProperties: false
                            example:
                              comments:
                              is_recent: true
                              is_regex: false
                              is_similarity: false
                              pattern: example.com
                            properties:
                              comments:
                                nullable: true
                                type: string
                              is_recent:
                                type: boolean
                              is_regex:
                                type: boolean
                              is_similarity:
                                type: boolean
                              pattern:
                                minLength: 1
                                type: string
                            required:
                              - is_recent
                              - is_similarity
                              - is_regex
                              - pattern
                            type: object
                          - properties:
                              created_at:
                                format: date-time
                                type: string
                              id:
                                example: 2401
                                format: int32
                                title: identifier
                                type: integer
                              last_modified:
                                format: date-time
                                type: string
                            required:
                              - id
                              - created_at
                              - last_modified
                            type: object
                        example:
                          comments:
                          created_at: "2023-11-14T22:13:20Z"
                          id: 2401
                          is_recent: true
                          is_regex: false
                          is_similarity: false
                          last_modified: "2023-11-14T22:13:20Z"
                          pattern: example.com
                    required:
                      - result
                    type: object
          description: ""
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a trusted email domain
      tags:
        - Email Security Settings
  /accounts/{account_id}/email/routing/addresses:
    get:
      description: Lists existing destination addresses.
      operationId: email-routing-destination-addresses-list-destination-addresses
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email_identifier'
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 20
            description: Maximum number of results per page.
            maximum: 50
            minimum: 5
            type: number
        - in: query
          name: direction
          schema:
            default: asc
            description: Sorts results in an ascending or descending order.
            enum:
              - asc
              - desc
            example: asc
            type: string
        - in: query
          name: verified
          schema:
            default: true
            description: Filter by verified destination addresses.
            enum:
              - true
              - false
            example: true
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_destination_addresses_response_collection'
          description: List destination addresses response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List destination addresses
      tags:
        - Email Routing Destination Addresses
      x-api-token-group:
        - Email Routing Addresses Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.email.routing.address.list
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/email_create_destination_address_properties'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_destination_address_response_single'
          description: Create a destination address response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a destination address
      tags:
        - Email Routing Destination Addresses
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.email.routing.address.create
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/email/routing/addresses/{destination_address_identifier}:
    delete:
      description: Deletes a specific destination address.
      operationId: email-routing-destination-addresses-delete-destination-address
      parameters:
        - in: path
          name: destination_address_identifier
          required: true
          schema:
            $ref: '#/components/schemas/email_destination_address_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email_identifier'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_destination_address_response_single'
          description: Delete destination address response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete destination address
      tags:
        - Email Routing Destination Addresses
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.email.routing.address.delete
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Gets information for a specific destination email already created.
      operationId: email-routing-destination-addresses-get-a-destination-address
      parameters:
        - in: path
          name: destination_address_identifier
          required: true
          schema:
            $ref: '#/components/schemas/email_destination_address_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/email_identifier'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_destination_address_response_single'
          description: Get a destination address response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a destination address
      tags:
        - Email Routing Destination Addresses
      x-api-token-group:
        - Email Routing Addresses Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.email.routing.address.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration:
    get:
      description: Returns all notification rules for each queue for which bucket notifications are produced.
      operationId: event-notification-get-r2-bucket-configs
      parameters:
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Read Configuration failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/mq_bucket-config'
                    type: object
          description: Read Configuration response
        "404":
          content:
            application/json:
              example:
                errors:
                  - code: 11015
                    message: workers.api.error.no_configs_found_for_bucket
                messages: []
                result:
                success: false
              schema:
                $ref: '#/components/schemas/mq_api-response-common-failure'
          description: No Configuration Found response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Read Configuration
      tags:
        - R2 Event Notification
      x-api-token-group:
        - Workers R2 Storage Read
  /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id}:
    delete:
      description: Turn off all event notifications configured for delivery to a given queue. No further notifications will be produced for the queue once complete.
      operationId: event-notification-delete-queue-config
      parameters:
        - in: path
          name: queue_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Create Configuration failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-response-common'
          description: Delete Configuration response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete Configuration
      tags:
        - R2 Event Notification
    put:
      description: Define the rules for a given queue which will determine event notification production.
      operationId: event-notification-create-queue-config
      parameters:
        - in: path
          name: queue_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                rules:
                  description: Array of rules to drive notifications
                  items:
                    $ref: '#/components/schemas/mq_rule'
                  type: array
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Create Configuration failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-common'
                  - properties:
                      result:
                        properties:
                          event_notification_detail_id:
                            example: deadbeef-1234-4e81-5678-abadfeedbead
                            type: string
                        type: object
                    type: object
          description: Create Configuration response
        "409":
          content:
            application/json:
              example:
                errors:
                  - code: 11010
                    message: workers.api.error.event_notification_detail_exists
                messages: []
                result:
                success: false
              schema:
                $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Duplicate Configuration failure
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create Configuration
      tags:
        - R2 Event Notification
  /accounts/{account_id}/gateway:
    get:
      description: Gets information about the current Zero Trust account.
      operationId: zero-trust-accounts-get-zero-trust-account-information
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_gateway_account'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust account information response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway_account'
          description: Get Zero Trust account information response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust account information
      tags:
        - Zero Trust Accounts
      x-api-token-group:
        - Teams Read
        - Teams Write
    post:
      description: Creates a Zero Trust account with an existing Cloudflare account.
      operationId: zero-trust-accounts-create-zero-trust-account
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_gateway_account'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Create Zero Trust account response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway_account'
          description: Create Zero Trust account response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Zero Trust account
      tags:
        - Zero Trust Accounts
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/gateway/app_types:
    get:
      description: Fetches all application and application type mappings.
      operationId: zero-trust-gateway-application-and-application-type-mappings-list-application-and-application-type-mappings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_app-types_components-schemas-response_collection'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: List application and application type mappings response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_app-types_components-schemas-response_collection'
          description: List application and application type mappings response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List application and application type mappings
      tags:
        - Zero Trust Gateway Application and Application Type Mappings
  /accounts/{account_id}/gateway/audit_ssh_settings:
    get:
      description: Get all Zero Trust Audit SSH settings for an account.
      operationId: zero-trust-get-audit-ssh-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust Audit SSH Settings response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response'
          description: Get Zero Trust Audit SSH settings response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust Audit SSH settings
      tags:
        - Zero Trust Audit SSH Settings
    put:
      description: Updates Zero Trust Audit SSH settings.
      operationId: zero-trust-update-audit-ssh-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                public_key:
                  $ref: '#/components/schemas/zero-trust-gateway_public_key'
                seed_id:
                  $ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-uuid'
              required:
                - public_key
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update Zero Trust Audit SSH Setting response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response'
          description: Update Zero Trust Audit SSH Setting response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Zero Trust Audit SSH settings
      tags:
        - Zero Trust Audit SSH Settings
  /accounts/{account_id}/gateway/categories:
    get:
      description: Fetches a list of all categories.
      operationId: zero-trust-gateway-categories-list-categories
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-response_collection'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: List categories response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-response_collection'
          description: List categories response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List categories
      tags:
        - Zero Trust Gateway Categories
  /accounts/{account_id}/gateway/certificates:
    get:
      description: Fetches all Zero Trust certificates for an account.
      operationId: zero-trust-certificates-list-zero-trust-certificates
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_response_collection'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: List Zero Trust certificates response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_response_collection'
          description: List Zero Trust certificates response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Zero Trust certificates
      tags:
        - Zero Trust Certificates
    post:
      description: Creates a new Zero Trust certificate.
      operationId: zero-trust-certificates-create-zero-trust-certificate
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/zero-trust-gateway_generate-cert-request'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Create Zero Trust certificate response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_single_response'
          description: Create Zero Trust certificate response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Zero Trust certificate
      tags:
        - Zero Trust Certificates
  /accounts/{account_id}/gateway/certificates/{certificate_id}:
    delete:
      description: Deletes a gateway-managed Zero Trust certificate. A certificate must be deactivated from the edge (inactive) before it is deleted.
      operationId: zero-trust-certificates-delete-zero-trust-certificate
      parameters:
        - in: path
          name: certificate_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Delete Zero Trust certificate response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_single_response'
          description: Delete Zero Trust certificate response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Zero Trust certificate
      tags:
        - Zero Trust Certificates
    get:
      description: Fetches a single Zero Trust certificate.
      operationId: zero-trust-certificates-zero-trust-certificate-details
      parameters:
        - in: path
          name: certificate_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust certificate details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_single_response'
          description: Get Zero Trust certificate details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust certificate details
      tags:
        - Zero Trust Certificates
  /accounts/{account_id}/gateway/certificates/{certificate_id}/activate:
    post:
      description: Binds a single Zero Trust certificate to the edge.
      operationId: zero-trust-certificates-activate-zero-trust-certificate
      parameters:
        - in: path
          name: certificate_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Activate Zero Trust certificate details response failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_single_response'
          description: Activate Zero Trust certificate details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Activate a Zero Trust certificate
      tags:
        - Zero Trust Certificates
  /accounts/{account_id}/gateway/certificates/{certificate_id}/deactivate:
    post:
      description: Unbinds a single Zero Trust certificate from the edge
      operationId: zero-trust-certificates-deactivate-zero-trust-certificate
      parameters:
        - in: path
          name: certificate_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Deactivate Zero Trust certificate details response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_single_response'
          description: Deactivate Zero Trust certificate details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Deactivate a Zero Trust certificate
      tags:
        - Zero Trust Certificates
  /accounts/{account_id}/gateway/configuration:
    get:
      description: Fetches the current Zero Trust account configuration.
      operationId: zero-trust-accounts-get-zero-trust-account-configuration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust account configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
          description: Get Zero Trust account configuration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust account configuration
      tags:
        - Zero Trust Accounts
    patch:
      description: Patches the current Zero Trust account configuration. This endpoint can update a single subcollection of settings such as `antivirus`, `tls_decrypt`, `activity_log`, `block_page`, `browser_isolation`, `fips`, `body_scanning`, or `certificate`, without updating the entire configuration object. Returns an error if any collection of settings is not properly configured.
      operationId: zero-trust-accounts-patch-zero-trust-account-configuration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/zero-trust-gateway_gateway-account-settings'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update Zero Trust account configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
          description: Update Zero Trust account configuration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch Zero Trust account configuration
      tags:
        - Zero Trust Accounts
    put:
      description: Updates the current Zero Trust account configuration.
      operationId: zero-trust-accounts-update-zero-trust-account-configuration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/zero-trust-gateway_gateway-account-settings'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update Zero Trust account configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
          description: Update Zero Trust account configuration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Zero Trust account configuration
      tags:
        - Zero Trust Accounts
  /accounts/{account_id}/gateway/configuration/custom_certificate:
    get:
      description: Fetches the current Zero Trust certificate configuration.
      operationId: zero-trust-accounts-get-zero-trust-certificate-configuration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_custom-certificate-settings'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust account configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_custom-certificate-settings'
          description: Get Zero Trust account configuration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust certificate configuration
      tags:
        - Zero Trust Accounts
  /accounts/{account_id}/gateway/lists:
    get:
      description: Fetches all Zero Trust lists for an account.
      operationId: zero-trust-lists-list-zero-trust-lists
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
        - in: query
          name: type
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_schemas-type'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_schemas-response_collection'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: List Zero Trust lists response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_schemas-response_collection'
          description: List Zero Trust lists response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Zero Trust lists
      tags:
        - Zero Trust Lists
    post:
      description: Creates a new Zero Trust list.
      operationId: zero-trust-lists-create-zero-trust-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                description:
                  $ref: '#/components/schemas/zero-trust-gateway_description'
                items:
                  $ref: '#/components/schemas/zero-trust-gateway_items'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_name'
                type:
                  $ref: '#/components/schemas/zero-trust-gateway_schemas-type'
              required:
                - name
                - type
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_single_response_with_list_items'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Create Zero Trust list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_single_response_with_list_items'
          description: Create Zero Trust list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Zero Trust list
      tags:
        - Zero Trust Lists
  /accounts/{account_id}/gateway/lists/{list_id}:
    delete:
      description: Deletes a Zero Trust list.
      operationId: zero-trust-lists-delete-zero-trust-list
      parameters:
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_empty_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Delete Zero Trust list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_empty_response'
          description: Delete Zero Trust list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Zero Trust list
      tags:
        - Zero Trust Lists
    get:
      description: Fetches a single Zero Trust list.
      operationId: zero-trust-lists-zero-trust-list-details
      parameters:
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust list details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response'
          description: Get Zero Trust list details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust list details
      tags:
        - Zero Trust Lists
    patch:
      description: Appends or removes an item from a configured Zero Trust list.
      operationId: zero-trust-lists-patch-zero-trust-list
      parameters:
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                append:
                  $ref: '#/components/schemas/zero-trust-gateway_items'
                remove:
                  description: A list of the item values you want to remove.
                  items:
                    $ref: '#/components/schemas/zero-trust-gateway_value'
                  type: array
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Patch Zero Trust list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response'
          description: Patch Zero Trust list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch Zero Trust list
      tags:
        - Zero Trust Lists
    put:
      description: Updates a configured Zero Trust list.
      operationId: zero-trust-lists-update-zero-trust-list
      parameters:
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                description:
                  $ref: '#/components/schemas/zero-trust-gateway_description'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_name'
              required:
                - name
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update Zero Trust list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response'
          description: Update Zero Trust list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Zero Trust list
      tags:
        - Zero Trust Lists
  /accounts/{account_id}/gateway/lists/{list_id}/items:
    get:
      description: Fetches all items in a single Zero Trust list.
      operationId: zero-trust-lists-zero-trust-list-items
      parameters:
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_list_item_response_collection'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust list items response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_list_item_response_collection'
          description: Get Zero Trust list items response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust list items
      tags:
        - Zero Trust Lists
  /accounts/{account_id}/gateway/locations:
    get:
      description: Fetches Zero Trust Gateway locations for an account.
      operationId: zero-trust-gateway-locations-list-zero-trust-gateway-locations
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_components-schemas-response_collection'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: List Zero Trust Gateway locations response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_components-schemas-response_collection'
          description: List Zero Trust Gateway locations response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Zero Trust Gateway locations
      tags:
        - Zero Trust Gateway Locations
    post:
      description: Creates a new Zero Trust Gateway location.
      operationId: zero-trust-gateway-locations-create-zero-trust-gateway-location
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                client_default:
                  $ref: '#/components/schemas/zero-trust-gateway_client-default'
                dns_destination_ips_id:
                  $ref: '#/components/schemas/zero-trust-gateway_dns-destination-ips-id-write'
                ecs_support:
                  $ref: '#/components/schemas/zero-trust-gateway_ecs-support'
                endpoints:
                  $ref: '#/components/schemas/zero-trust-gateway_endpoints'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_schemas-name'
                networks:
                  $ref: '#/components/schemas/zero-trust-gateway_ipv4_networks'
              required:
                - name
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Create a Zero Trust Gateway location response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
          description: Create a Zero Trust Gateway location response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a Zero Trust Gateway location
      tags:
        - Zero Trust Gateway Locations
  /accounts/{account_id}/gateway/locations/{location_id}:
    delete:
      description: Deletes a configured Zero Trust Gateway location.
      operationId: zero-trust-gateway-locations-delete-zero-trust-gateway-location
      parameters:
        - in: path
          name: location_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_empty_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Delete a Zero Trust Gateway location response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_empty_response'
          description: Delete a Zero Trust Gateway location response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a Zero Trust Gateway location
      tags:
        - Zero Trust Gateway Locations
    get:
      description: Fetches a single Zero Trust Gateway location.
      operationId: zero-trust-gateway-locations-zero-trust-gateway-location-details
      parameters:
        - in: path
          name: location_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust Gateway location details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
          description: Get Zero Trust Gateway location details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust Gateway location details
      tags:
        - Zero Trust Gateway Locations
    put:
      description: Updates a configured Zero Trust Gateway location.
      operationId: zero-trust-gateway-locations-update-zero-trust-gateway-location
      parameters:
        - in: path
          name: location_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                client_default:
                  $ref: '#/components/schemas/zero-trust-gateway_client-default'
                dns_destination_ips_id:
                  $ref: '#/components/schemas/zero-trust-gateway_dns-destination-ips-id-write'
                ecs_support:
                  $ref: '#/components/schemas/zero-trust-gateway_ecs-support'
                endpoints:
                  $ref: '#/components/schemas/zero-trust-gateway_endpoints'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_schemas-name'
                networks:
                  $ref: '#/components/schemas/zero-trust-gateway_ipv4_networks'
              required:
                - name
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update a Zero Trust Gateway location response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
          description: Update a Zero Trust Gateway location response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a Zero Trust Gateway location
      tags:
        - Zero Trust Gateway Locations
  /accounts/{account_id}/gateway/logging:
    get:
      description: Fetches the current logging settings for Zero Trust account.
      operationId: zero-trust-accounts-get-logging-settings-for-the-zero-trust-account
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get logging settings for the Zero Trust account response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response'
          description: Get logging settings for the Zero Trust account response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get logging settings for the Zero Trust account
      tags:
        - Zero Trust Accounts
    put:
      description: Updates logging settings for the current Zero Trust account.
      operationId: zero-trust-accounts-update-logging-settings-for-the-zero-trust-account
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update logging settings for the Zero Trust account response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response'
          description: Update logging settings for the Zero Trust account response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Zero Trust account logging settings
      tags:
        - Zero Trust Accounts
  /accounts/{account_id}/gateway/proxy_endpoints:
    get:
      description: Fetches all Zero Trust Gateway proxy endpoints for an account.
      operationId: zero-trust-gateway-proxy-endpoints-list-proxy-endpoints
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: List proxy endpoints response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
          description: List proxy endpoints response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List proxy endpoints
      tags:
        - Zero Trust Gateway Proxy Endpoints
    post:
      description: Creates a new Zero Trust Gateway proxy endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-create-proxy-endpoint
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                ips:
                  $ref: '#/components/schemas/zero-trust-gateway_ips'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name'
              required:
                - name
                - ips
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Create a proxy endpoint response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
          description: Create a proxy endpoint response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a proxy endpoint
      tags:
        - Zero Trust Gateway Proxy Endpoints
  /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}:
    delete:
      description: Deletes a configured Zero Trust Gateway proxy endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint
      parameters:
        - in: path
          name: proxy_endpoint_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_empty_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Delete a proxy endpoint response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_empty_response'
          description: Delete a proxy endpoint response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a proxy endpoint
      tags:
        - Zero Trust Gateway Proxy Endpoints
    get:
      description: Fetches a single Zero Trust Gateway proxy endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-proxy-endpoint-details
      parameters:
        - in: path
          name: proxy_endpoint_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-response_collection'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get a proxy endpoint response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-response_collection'
          description: Get a proxy endpoint response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a proxy endpoint
      tags:
        - Zero Trust Gateway Proxy Endpoints
    patch:
      description: Updates a configured Zero Trust Gateway proxy endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-update-proxy-endpoint
      parameters:
        - in: path
          name: proxy_endpoint_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                ips:
                  $ref: '#/components/schemas/zero-trust-gateway_ips'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update a proxy endpoint response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
          description: Update a proxy endpoint response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a proxy endpoint
      tags:
        - Zero Trust Gateway Proxy Endpoints
  /accounts/{account_id}/gateway/rules:
    get:
      description: Fetches the Zero Trust Gateway rules for an account.
      operationId: zero-trust-gateway-rules-list-zero-trust-gateway-rules
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_rules_components-schemas-response_collection'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: List Zero Trust Gateway rules response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_rules_components-schemas-response_collection'
          description: List Zero Trust Gateway rules response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Zero Trust Gateway rules
      tags:
        - Zero Trust Gateway Rules
    post:
      description: Creates a new Zero Trust Gateway rule.
      operationId: zero-trust-gateway-rules-create-zero-trust-gateway-rule
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                action:
                  $ref: '#/components/schemas/zero-trust-gateway_action'
                description:
                  $ref: '#/components/schemas/zero-trust-gateway_schemas-description'
                device_posture:
                  $ref: '#/components/schemas/zero-trust-gateway_device_posture'
                enabled:
                  $ref: '#/components/schemas/zero-trust-gateway_enabled'
                filters:
                  $ref: '#/components/schemas/zero-trust-gateway_filters'
                identity:
                  $ref: '#/components/schemas/zero-trust-gateway_identity'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_components-schemas-name'
                precedence:
                  $ref: '#/components/schemas/zero-trust-gateway_precedence'
                rule_settings:
                  $ref: '#/components/schemas/zero-trust-gateway_rule-settings'
                schedule:
                  $ref: '#/components/schemas/zero-trust-gateway_schedule'
                traffic:
                  $ref: '#/components/schemas/zero-trust-gateway_traffic'
              required:
                - name
                - action
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_rules_components-schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Create a Zero Trust Gateway rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_rules_components-schemas-single_response'
          description: Create a Zero Trust Gateway rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a Zero Trust Gateway rule
      tags:
        - Zero Trust Gateway Rules
  /accounts/{account_id}/gateway/rules/{rule_id}:
    delete:
      description: Deletes a Zero Trust Gateway rule.
      operationId: zero-trust-gateway-rules-delete-zero-trust-gateway-rule
      parameters:
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_rules_components-schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_empty_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Delete a Zero Trust Gateway rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_empty_response'
          description: Delete a Zero Trust Gateway rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a Zero Trust Gateway rule
      tags:
        - Zero Trust Gateway Rules
    get:
      description: Fetches a single Zero Trust Gateway rule.
      operationId: zero-trust-gateway-rules-zero-trust-gateway-rule-details
      parameters:
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_rules_components-schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_rules_components-schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust Gateway rule details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_rules_components-schemas-single_response'
          description: Get Zero Trust Gateway rule details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust Gateway rule details
      tags:
        - Zero Trust Gateway Rules
    put:
      description: Updates a configured Zero Trust Gateway rule.
      operationId: zero-trust-gateway-rules-update-zero-trust-gateway-rule
      parameters:
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_rules_components-schemas-uuid'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                action:
                  $ref: '#/components/schemas/zero-trust-gateway_action'
                description:
                  $ref: '#/components/schemas/zero-trust-gateway_schemas-description'
                device_posture:
                  $ref: '#/components/schemas/zero-trust-gateway_device_posture'
                enabled:
                  $ref: '#/components/schemas/zero-trust-gateway_enabled'
                filters:
                  $ref: '#/components/schemas/zero-trust-gateway_filters'
                identity:
                  $ref: '#/components/schemas/zero-trust-gateway_identity'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_components-schemas-name'
                precedence:
                  $ref: '#/components/schemas/zero-trust-gateway_precedence'
                rule_settings:
                  $ref: '#/components/schemas/zero-trust-gateway_rule-settings'
                schedule:
                  $ref: '#/components/schemas/zero-trust-gateway_schedule'
                traffic:
                  $ref: '#/components/schemas/zero-trust-gateway_traffic'
              required:
                - name
                - action
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zero-trust-gateway_rules_components-schemas-single_response'
                  - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update a Zero Trust Gateway rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_rules_components-schemas-single_response'
          description: Update a Zero Trust Gateway rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a Zero Trust Gateway rule
      tags:
        - Zero Trust Gateway Rules
  /accounts/{account_id}/hyperdrive/configs:
    get:
      description: Returns a list of Hyperdrives
      operationId: list-hyperdrive
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/hyperdrive_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/hyperdrive_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/hyperdrive_api-response-common-failure'
          description: List Hyperdrives Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/hyperdrive_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier'
                        type: array
          description: List Hyperdrives Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Hyperdrives
      tags:
        - Hyperdrive
      x-api-token-group:
        - Hyperdrive Write
        - Hyperdrive Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.hyperdrive.database.list
    post:
      description: Creates and returns a new Hyperdrive configuration.
      operationId: create-hyperdrive
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/hyperdrive_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hyperdrive_create-update-hyperdrive-config'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/hyperdrive_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/hyperdrive_api-response-common-failure'
          description: Create Hyperdrive Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/hyperdrive_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier'
          description: Create Hyperdrive Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Hyperdrive
      tags:
        - Hyperdrive
      x-api-token-group:
        - Hyperdrive Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.hyperdrive.database.create
  /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}:
    delete:
      description: Deletes the specified Hyperdrive.
      operationId: delete-hyperdrive
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/hyperdrive_identifier'
        - in: path
          name: hyperdrive_id
          required: true
          schema:
            $ref: '#/components/schemas/hyperdrive_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/hyperdrive_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/hyperdrive_api-response-common-failure'
          description: Delete Hyperdrive Failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/hyperdrive_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
          description: Delete Hyperdrive Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Hyperdrive
      tags:
        - Hyperdrive
      x-api-token-group:
        - Hyperdrive Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.hyperdrive.database.delete
    get:
      description: Returns the specified Hyperdrive configuration.
      operationId: get-hyperdrive
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/hyperdrive_identifier'
        - in: path
          name: hyperdrive_id
          required: true
          schema:
            $ref: '#/components/schemas/hyperdrive_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/hyperdrive_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/hyperdrive_api-response-common-failure'
          description: Get Hyperdrive Failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/hyperdrive_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier'
          description: Get Hyperdrive Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Hyperdrive
      tags:
        - Hyperdrive
      x-api-token-group:
        - Hyperdrive Write
        - Hyperdrive Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.hyperdrive.database.read
    patch:
      description: Patches and returns the specified Hyperdrive configuration. Updates to the origin and caching settings are applied with an all-or-nothing approach.
      operationId: patch-hyperdrive
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/hyperdrive_identifier'
        - in: path
          name: hyperdrive_id
          required: true
          schema:
            $ref: '#/components/schemas/hyperdrive_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hyperdrive_patch-hyperdrive-config'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/hyperdrive_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/hyperdrive_api-response-common-failure'
          description: Patch Hyperdrive Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/hyperdrive_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier'
          description: Patch Hyperdrive Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch Hyperdrive
      tags:
        - Hyperdrive
      x-api-token-group:
        - Hyperdrive Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.hyperdrive.database.update
    put:
      description: Updates and returns the specified Hyperdrive configuration.
      operationId: update-hyperdrive
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/hyperdrive_identifier'
        - in: path
          name: hyperdrive_id
          required: true
          schema:
            $ref: '#/components/schemas/hyperdrive_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hyperdrive_create-update-hyperdrive-config'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/hyperdrive_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/hyperdrive_api-response-common-failure'
          description: Update Hyperdrive Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/hyperdrive_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier'
          description: Update Hyperdrive Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Hyperdrive
      tags:
        - Hyperdrive
      x-api-token-group:
        - Hyperdrive Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.hyperdrive.database.update
  /accounts/{account_id}/iam/permission_groups:
    get:
      description: List all the permissions groups for an account.
      operationId: account-permission-group-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
        - in: query
          name: id
          schema:
            description: ID of the permission group to be fetched.
            example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
            maxLength: 32
            minLength: 32
            type: string
        - in: query
          name: name
          schema:
            description: Name of the permission group to be fetched.
            example: NameOfThePermissionGroup
            type: string
        - in: query
          name: label
          schema:
            description: Label of the permission group to be fetched.
            example: labelOfThePermissionGroup
            type: string
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 20
            description: Maximum number of results per page.
            maximum: 50
            minimum: 5
            type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Permission Groups response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_collection_permission_groups_response'
          description: List Permission Groups response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Account Permission Groups
      tags:
        - Account Permission Groups
      x-api-token-group:
        - Cloudflare Zero Trust PII Read
        - DDoS Botnet Feed Write
        - DDoS Botnet Feed Read
        - Workers R2 Storage Write
        - Workers R2 Storage Read
        - DDoS Protection Write
        - DDoS Protection Read
        - Workers Tail Read
        - Workers KV Storage Write
        - Workers KV Storage Read
        - Workers Scripts Write
        - Workers Scripts Read
        - 'Load Balancing: Monitors and Pools Write'
        - 'Load Balancing: Monitors and Pools Read'
        - Account Firewall Access Rules Write
        - Account Firewall Access Rules Read
        - DNS Firewall Write
        - DNS Firewall Read
        - Billing Write
        - Billing Read
        - Account Settings Write
        - Account Settings Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.iam.permission-group.list
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/iam/permission_groups/{permission_group_id}:
    get:
      description: Get information about a specific permission group in an account.
      operationId: account-permission-group-details
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
        - in: path
          name: permission_group_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_permission_group_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Permission Group Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_permission_group'
          description: Permission Group Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Permission Group Details
      tags:
        - Account Permission Groups
      x-api-token-group:
        - Cloudflare Zero Trust PII Read
        - DDoS Botnet Feed Write
        - DDoS Botnet Feed Read
        - Workers R2 Storage Write
        - Workers R2 Storage Read
        - DDoS Protection Write
        - DDoS Protection Read
        - Workers Tail Read
        - Workers KV Storage Write
        - Workers KV Storage Read
        - Workers Scripts Write
        - Workers Scripts Read
        - 'Load Balancing: Monitors and Pools Write'
        - 'Load Balancing: Monitors and Pools Read'
        - Account Firewall Access Rules Write
        - Account Firewall Access Rules Read
        - DNS Firewall Write
        - DNS Firewall Read
        - Billing Write
        - Billing Read
        - Account Settings Write
        - Account Settings Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.iam.permission-group.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/iam/resource_groups:
    get:
      description: List all the resource groups for an account.
      operationId: account-resource-group-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
        - in: query
          name: id
          schema:
            description: ID of the resource group to be fetched.
            example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
            maxLength: 32
            minLength: 32
            type: string
        - in: query
          name: name
          schema:
            description: Name of the resource group to be fetched.
            example: NameOfTheResourceGroup
            type: string
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 20
            description: Maximum number of results per page.
            maximum: 50
            minimum: 5
            type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Resource Groups response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_collection_resource_groups_response'
          description: List Resource Groups response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Resource Groups
      tags:
        - Account Resource Groups
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.iam.resource-group.list
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Create a new Resource Group under the specified account.
      operationId: account-resource-group-create
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/iam_create_resource_group'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Add Member response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_created_resource_group_response'
          description: Add Resource Group response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Resource Group
      tags:
        - Account Resource Groups
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.iam.resource-group.create
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/iam/resource_groups/{resource_group_id}:
    delete:
      description: Remove a resource group from an account.
      operationId: account-resource-group-delete
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
        - in: path
          name: resource_group_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_resource_group_components-schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Remove Member response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-single-id'
          description: Remove Resource Group response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Remove Resource Group
      tags:
        - Account Resource Groups
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.iam.resource-group.delete
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Get information about a specific resource group in an account.
      operationId: account-resource-group-details
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
        - in: path
          name: resource_group_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_resource_group_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Resource Group Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_resource_group'
          description: Resource Group Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Resource Group Details
      tags:
        - Account Resource Groups
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.iam.resource-group.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Modify an existing resource group.
      operationId: account-resource-group-update
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
        - in: path
          name: resource_group_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_resource_group_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/iam_create_resource_group'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Update Resource Group response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_resource_group'
          description: Update Resource Group response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Resource Group
      tags:
        - Account Resource Groups
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.iam.resource-group.update
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/images/v1:
    get:
      deprecated: true
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 1000
            description: Number of items per page.
            maximum: 10000
            minimum: 10
            type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_images_list_response'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: List images response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_images_list_response'
          description: List images response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List images
      tags:
        - Cloudflare Images
      x-api-token-group:
        - Images Read
        - Images Write
    post:
      description: |
        Upload an image with up to 10 Megabytes using a single HTTP POST (multipart/form-data) request.
        An image can be uploaded by sending an image file or passing an accessible to an API url.
      operationId: cloudflare-images-upload-an-image-via-url
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/images_image_basic_upload'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_image_response_single'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Upload an image response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_response_single'
          description: Upload an image response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Upload an image
      tags:
        - Cloudflare Images
      x-api-token-group:
        - Images Write
  /accounts/{account_id}/images/v1/{image_id}:
    delete:
      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:
        - in: path
          name: image_id
          required: true
          schema:
            $ref: '#/components/schemas/images_image_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_deleted_response'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Delete image response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_deleted_response'
          description: Delete image response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete image
      tags:
        - Cloudflare Images
      x-api-token-group:
        - Images Write
    get:
      description: Fetch details for a single image.
      operationId: cloudflare-images-image-details
      parameters:
        - in: path
          name: image_id
          required: true
          schema:
            $ref: '#/components/schemas/images_image_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_image_response_single'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Image details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_response_single'
          description: Image details response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Image details
      tags:
        - Cloudflare Images
      x-api-token-group:
        - Images Read
        - Images Write
    patch:
      description: Update image access control. On access control change, all copies of the image are purged from cache.
      operationId: cloudflare-images-update-image
      parameters:
        - in: path
          name: image_id
          required: true
          schema:
            $ref: '#/components/schemas/images_image_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/images_image_patch_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_image_response_single'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Update image response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_response_single'
          description: Update image response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update image
      tags:
        - Cloudflare Images
      x-api-token-group:
        - Images Write
  /accounts/{account_id}/images/v1/{image_id}/blob:
    get:
      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:
        - in: path
          name: image_id
          required: true
          schema:
            $ref: '#/components/schemas/images_image_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_image_response_blob'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Base image response failure
        "200":
          content:
            image/*:
              schema:
                format: binary
                type: string
          description: Base image response. Returns uploaded image data.
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Base image
      tags:
        - Cloudflare Images
      x-api-token-group:
        - Images Read
        - Images Write
  /accounts/{account_id}/images/v1/keys:
    get:
      description: Lists your signing keys. These can be found on your Cloudflare Images dashboard.
      operationId: cloudflare-images-keys-list-signing-keys
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_image_key_response_collection'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: List Signing Keys response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_key_response_collection'
          description: List Signing Keys response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Signing Keys
      tags:
        - Cloudflare Images Keys
      x-api-token-group:
        - Images Read
        - Images Write
  /accounts/{account_id}/images/v1/keys/{signing_key_name}:
    delete:
      description: |
        Delete signing key with specified name. Returns all keys available.
        When last key is removed, a new default signing key will be generated.
      operationId: cloudflare-images-keys-delete-signing-key
      parameters:
        - in: path
          name: signing_key_name
          required: true
          schema:
            $ref: '#/components/schemas/images_signing_key_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_image_key_response_collection'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Delete Signing Key response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_key_response_collection'
          description: Delete Signing Key response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Signing Key
      tags:
        - Cloudflare Images Keys
    put:
      description: Create a new signing key with specified name. Returns all keys available.
      operationId: cloudflare-images-keys-add-signing-key
      parameters:
        - in: path
          name: signing_key_name
          required: true
          schema:
            $ref: '#/components/schemas/images_signing_key_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_image_key_response_collection'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Add Signing Key response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_key_response_collection'
          description: Add Signing Key response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a new Signing Key
      tags:
        - Cloudflare Images Keys
  /accounts/{account_id}/images/v1/stats:
    get:
      description: Fetch usage statistics details for Cloudflare Images.
      operationId: cloudflare-images-images-usage-statistics
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_images_stats_response'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Images usage statistics response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_images_stats_response'
          description: Images usage statistics response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Images usage statistics
      tags:
        - Cloudflare Images
      x-api-token-group:
        - Images Read
        - Images Write
  /accounts/{account_id}/images/v1/variants:
    get:
      description: Lists existing variants.
      operationId: cloudflare-images-variants-list-variants
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_image_variant_list_response'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: List variants response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_variant_list_response'
          description: List variants response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List variants
      tags:
        - Cloudflare Images Variants
      x-api-token-group:
        - Images Read
        - Images Write
    post:
      description: Specify variants that allow you to resize images for different use cases.
      operationId: cloudflare-images-variants-create-a-variant
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/images_image_variant_definition'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_image_variant_simple_response'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Create a variant response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_variant_simple_response'
          description: Create a variant response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a variant
      tags:
        - Cloudflare Images Variants
      x-api-token-group:
        - Images Write
  /accounts/{account_id}/images/v1/variants/{variant_id}:
    delete:
      description: Deleting a variant purges the cache for all images associated with the variant.
      operationId: cloudflare-images-variants-delete-a-variant
      parameters:
        - in: path
          name: variant_id
          required: true
          schema:
            $ref: '#/components/schemas/images_image_variant_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_deleted_response'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Delete a variant response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_deleted_response'
          description: Delete a variant response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a variant
      tags:
        - Cloudflare Images Variants
      x-api-token-group:
        - Images Write
    get:
      description: Fetch details for a single variant.
      operationId: cloudflare-images-variants-variant-details
      parameters:
        - in: path
          name: variant_id
          required: true
          schema:
            $ref: '#/components/schemas/images_image_variant_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_image_variant_simple_response'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Variant details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_variant_simple_response'
          description: Variant details response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Variant details
      tags:
        - Cloudflare Images Variants
      x-api-token-group:
        - Images Read
        - Images Write
    patch:
      description: Updating a variant purges the cache for all images associated with the variant.
      operationId: cloudflare-images-variants-update-a-variant
      parameters:
        - in: path
          name: variant_id
          required: true
          schema:
            $ref: '#/components/schemas/images_image_variant_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/images_image_variant_patch_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_image_variant_simple_response'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Update a variant response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_variant_simple_response'
          description: Update a variant response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a variant
      tags:
        - Cloudflare Images Variants
      x-api-token-group:
        - Images Write
  /accounts/{account_id}/images/v2:
    get:
      description: |
        List up to 10000 images with one request. Use the optional parameters below to get a specific range of images.
        Endpoint returns continuation_token if more images are present.
      operationId: cloudflare-images-list-images-v2
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
        - in: query
          name: continuation_token
          schema:
            description: Continuation token for a next page. List images V2 returns continuation_token
            nullable: true
            type: string
        - in: query
          name: per_page
          schema:
            default: 1000
            description: Number of items per page.
            maximum: 10000
            minimum: 10
            type: number
        - in: query
          name: sort_order
          schema:
            default: desc
            description: Sorting order by upload time.
            enum:
              - asc
              - desc
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_images_list_response_v2'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: List images response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_images_list_response_v2'
          description: List images response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List images V2
      tags:
        - Cloudflare Images
      x-api-token-group:
        - Images Read
        - Images Write
  /accounts/{account_id}/images/v2/direct_upload:
    post:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/images_account_identifier'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/images_image_direct_upload_request_v2'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/images_image_direct_upload_response_v2'
                  - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Create authenticated direct upload URL V2 response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_direct_upload_response_v2'
          description: Create authenticated direct upload URL V2 response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create authenticated direct upload URL V2
      tags:
        - Cloudflare Images
      x-api-token-group:
        - Images Write
  /accounts/{account_id}/infrastructure/targets:
    get:
      operationId: infra-targets-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/infra_AccountTag'
        - description: Hostname of a target
          in: query
          name: hostname
          schema:
            nullable: true
            type: string
        - description: Partial match to the hostname of a target
          in: query
          name: hostname_contains
          schema:
            nullable: true
            type: string
        - description: Private virtual network identifier of the target
          in: query
          name: virtual_network_id
          schema:
            format: uuid
            nullable: true
            type: string
        - description: IPv4 address of the target
          in: query
          name: ip_v4
          schema:
            nullable: true
            type: string
        - description: IPv6 address of the target
          in: query
          name: ip_v6
          schema:
            nullable: true
            type: string
        - description: Date and time at which the target was created
          in: query
          name: created_after
          schema:
            format: date-time
            nullable: true
            type: string
        - description: Date and time at which the target was modified
          in: query
          name: modified_after
          schema:
            format: date-time
            nullable: true
            type: string
        - description: Current page in the response
          in: query
          name: page
          schema:
            default: 1
            format: int32
            minimum: 1
            type: integer
        - description: Max amount of entries returned per page
          in: query
          name: per_page
          schema:
            default: 1000
            format: int32
            maximum: 1000
            minimum: 1
            type: integer
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/infra_api-response-common-failure'
          description: Failed to retrieve all targets in the account
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/infra_api-response-collection'
                  - properties:
                      result:
                        $ref: '#/components/schemas/infra_TargetArray'
                    type: object
          description: Successfully retrieved all targets in the account
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List all targets
      tags:
        - Infrastructure Access Targets
      x-api-token-group:
        - Teams Read
        - Teams Write
    post:
      operationId: infra-targets-post
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/infra_AccountTag'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                hostname:
                  description: |-
                    A non-unique field that refers to a target. Case insensitive, maximum
                    length of 255 characters, supports the use of special characters dash
                    and period, does not support spaces, and must start and end with an
                    alphanumeric character.
                  example: infra-access-target
                  type: string
                ip:
                  $ref: '#/components/schemas/infra_IPInfo'
              required:
                - hostname
                - ip
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/infra_api-response-common-failure'
          description: Failed to create the target
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/infra_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/infra_Target'
                    type: object
          description: Successfully created the target
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create new target
      tags:
        - Infrastructure Access Targets
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/infrastructure/targets/{target_id}:
    delete:
      operationId: infra-targets-delete
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/infra_AccountTag'
        - in: path
          name: target_id
          required: true
          schema:
            $ref: '#/components/schemas/infra_TargetId'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/infra_api-response-common-failure'
          description: Failed to delete the target
        "200":
          description: Successfully deleted the target
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete target
      tags:
        - Infrastructure Access Targets
    get:
      operationId: infra-targets-get
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/infra_AccountTag'
        - in: path
          name: target_id
          required: true
          schema:
            $ref: '#/components/schemas/infra_TargetId'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/infra_api-response-common-failure'
          description: Failed to retrieve the target
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/infra_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/infra_Target'
                    type: object
          description: Successfully retrieved the target
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get target
      tags:
        - Infrastructure Access Targets
    put:
      operationId: infra-targets-put
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/infra_AccountTag'
        - in: path
          name: target_id
          required: true
          schema:
            $ref: '#/components/schemas/infra_TargetId'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                hostname:
                  description: |-
                    A non-unique field that refers to a target. Case insensitive, maximum
                    length of 255 characters, supports the use of special characters dash
                    and period, does not support spaces, and must start and end with an
                    alphanumeric character.
                  example: infra-access-target
                  type: string
                ip:
                  $ref: '#/components/schemas/infra_IPInfo'
              required:
                - hostname
                - ip
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/infra_api-response-common-failure'
          description: Failed to update the target
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/infra_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/infra_Target'
                    type: object
          description: Successfully updated the target
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update target
      tags:
        - Infrastructure Access Targets
  /accounts/{account_id}/intel/asn/{asn}:
    get:
      operationId: asn-intelligence-get-asn-overview
      parameters:
        - in: path
          name: asn
          required: true
          schema:
            $ref: '#/components/schemas/intel_asn'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/intel_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/intel_asn_components-schemas-response'
                  - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Get ASN Overview response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_asn_components-schemas-response'
          description: Get ASN Overview response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get ASN Overview
      tags:
        - ASN Intelligence
  /accounts/{account_id}/intel/asn/{asn}/subnets:
    get:
      operationId: asn-intelligence-get-asn-subnets
      parameters:
        - in: path
          name: asn
          required: true
          schema:
            $ref: '#/components/schemas/intel_asn'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/intel_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - properties:
                      asn:
                        $ref: '#/components/schemas/intel_asn'
                      count:
                        $ref: '#/components/schemas/intel_count'
                      ip_count_total:
                        type: integer
                      page:
                        $ref: '#/components/schemas/intel_page'
                      per_page:
                        $ref: '#/components/schemas/intel_per_page'
                      subnets:
                        example:
                          - 192.0.2.0/24
                          - 2001:DB8::/32
                        items:
                          type: string
                        type: array
                    type: object
                  - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Get ASN Subnets response failure
        "200":
          content:
            application/json:
              schema:
                properties:
                  asn:
                    $ref: '#/components/schemas/intel_asn'
                  count:
                    $ref: '#/components/schemas/intel_count'
                  ip_count_total:
                    type: integer
                  page:
                    $ref: '#/components/schemas/intel_page'
                  per_page:
                    $ref: '#/components/schemas/intel_per_page'
                  subnets:
                    example:
                      - 192.0.2.0/24
                      - 2001:DB8::/32
                    items:
                      type: string
                    type: array
                type: object
          description: Get ASN Subnets response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get ASN Subnets
      tags:
        - ASN Intelligence
  /accounts/{account_id}/intel/attack-surface-report/{issue_id}/dismiss:
    put:
      operationId: archive-security-center-insight
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/security-center_identifier'
        - in: path
          name: issue_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                dismiss:
                  default: true
                  type: boolean
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_api-response-common-failure'
          description: Client Error
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/security-center_api-response-single'
          description: OK
      security:
        - api_email: []
          api_key: []
        - api_token: []
      summary: APIs.io Engineering Platform Archive Security Center Insight
      tags:
        - Security Center Insights
  /accounts/{account_id}/intel/attack-surface-report/issue-types:
    get:
      operationId: get-security-center-issue-types
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/security-center_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_api-response-common-failure'
          description: Client Error
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/security-center_api-response-common'
                  - properties:
                      result:
                        anyOf:
                          - items:
                              type: string
                            type: array
          description: OK
      security:
        - api_email: []
          api_key: []
        - api_token: []
      summary: APIs.io Engineering Platform Get Security Center Issues Types
      tags:
        - Security Center Insights
  /accounts/{account_id}/intel/attack-surface-report/issues:
    get:
      operationId: get-security-center-issues
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/security-center_identifier'
        - in: query
          name: dismissed
          schema:
            $ref: '#/components/schemas/security-center_dismissed'
        - in: query
          name: issue_class
          schema:
            $ref: '#/components/schemas/security-center_issueClasses'
        - in: query
          name: issue_type
          schema:
            $ref: '#/components/schemas/security-center_issueTypes'
        - in: query
          name: product
          schema:
            $ref: '#/components/schemas/security-center_products'
        - in: query
          name: severity
          schema:
            $ref: '#/components/schemas/security-center_severityQueryParam'
        - in: query
          name: subject
          schema:
            $ref: '#/components/schemas/security-center_subjects'
        - in: query
          name: issue_class~neq
          schema:
            $ref: '#/components/schemas/security-center_issueClasses'
        - in: query
          name: issue_type~neq
          schema:
            $ref: '#/components/schemas/security-center_issueTypes'
        - in: query
          name: product~neq
          schema:
            $ref: '#/components/schemas/security-center_products'
        - in: query
          name: severity~neq
          schema:
            $ref: '#/components/schemas/security-center_severityQueryParam'
        - in: query
          name: subject~neq
          schema:
            $ref: '#/components/schemas/security-center_subjects'
        - in: query
          name: page
          schema:
            allOf:
              - $ref: '#/components/schemas/security-center_page'
            default: 1
        - in: query
          name: per_page
          schema:
            allOf:
              - $ref: '#/components/schemas/security-center_perPage'
            default: 25
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_api-response-common-failure'
          description: Client Error
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/security-center_api-response-common'
                  - properties:
                      result:
                        anyOf:
                          - properties:
                              count:
                                $ref: '#/components/schemas/security-center_count'
                              issues:
                                items:
                                  $ref: '#/components/schemas/security-center_issue'
                                type: array
                              page:
                                $ref: '#/components/schemas/security-center_page'
                              per_page:
                                $ref: '#/components/schemas/security-center_perPage'
                            type: object
          description: OK
      security:
        - api_email: []
          api_key: []
        - api_token: []
      summary: APIs.io Engineering Platform Get Security Center Issues
      tags:
        - Security Center Insights
  /accounts/{account_id}/intel/attack-surface-report/issues/class:
    get:
      operationId: get-security-center-issue-counts-by-class
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/security-center_identifier'
        - in: query
          name: dismissed
          schema:
            $ref: '#/components/schemas/security-center_dismissed'
        - in: query
          name: issue_class
          schema:
            $ref: '#/components/schemas/security-center_issueClasses'
        - in: query
          name: issue_type
          schema:
            $ref: '#/components/schemas/security-center_issueTypes'
        - in: query
          name: product
          schema:
            $ref: '#/components/schemas/security-center_products'
        - in: query
          name: severity
          schema:
            $ref: '#/components/schemas/security-center_severityQueryParam'
        - in: query
          name: subject
          schema:
            $ref: '#/components/schemas/security-center_subjects'
        - in: query
          name: issue_class~neq
          schema:
            $ref: '#/components/schemas/security-center_issueClasses'
        - in: query
          name: issue_type~neq
          schema:
            $ref: '#/components/schemas/security-center_issueTypes'
        - in: query
          name: product~neq
          schema:
            $ref: '#/components/schemas/security-center_products'
        - in: query
          name: severity~neq
          schema:
            $ref: '#/components/schemas/security-center_severityQueryParam'
        - in: query
          name: subject~neq
          schema:
            $ref: '#/components/schemas/security-center_subjects'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_api-response-common-failure'
          description: Client Error
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_valueCountsResponse'
          description: OK
      security:
        - api_email: []
          api_key: []
        - api_token: []
      summary: APIs.io Engineering Platform Get Security Center Issue Counts by Class
      tags:
        - Security Center Insights
  /accounts/{account_id}/intel/attack-surface-report/issues/severity:
    get:
      operationId: get-security-center-issue-counts-by-severity
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/security-center_identifier'
        - in: query
          name: dismissed
          schema:
            $ref: '#/components/schemas/security-center_dismissed'
        - in: query
          name: issue_class
          schema:
            $ref: '#/components/schemas/security-center_issueClasses'
        - in: query
          name: issue_type
          schema:
            $ref: '#/components/schemas/security-center_issueTypes'
        - in: query
          name: product
          schema:
            $ref: '#/components/schemas/security-center_products'
        - in: query
          name: severity
          schema:
            $ref: '#/components/schemas/security-center_severityQueryParam'
        - in: query
          name: subject
          schema:
            $ref: '#/components/schemas/security-center_subjects'
        - in: query
          name: issue_class~neq
          schema:
            $ref: '#/components/schemas/security-center_issueClasses'
        - in: query
          name: issue_type~neq
          schema:
            $ref: '#/components/schemas/security-center_issueTypes'
        - in: query
          name: product~neq
          schema:
            $ref: '#/components/schemas/security-center_products'
        - in: query
          name: severity~neq
          schema:
            $ref: '#/components/schemas/security-center_severityQueryParam'
        - in: query
          name: subject~neq
          schema:
            $ref: '#/components/schemas/security-center_subjects'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_api-response-common-failure'
          description: Client Error
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_valueCountsResponse'
          description: OK
      security:
        - api_email: []
          api_key: []
        - api_token: []
      summary: APIs.io Engineering Platform Get Security Center Issue Counts by Severity
      tags:
        - Security Center Insights
  /accounts/{account_id}/intel/attack-surface-report/issues/type:
    get:
      operationId: get-security-center-issue-counts-by-type
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/security-center_identifier'
        - in: query
          name: dismissed
          schema:
            $ref: '#/components/schemas/security-center_dismissed'
        - in: query
          name: issue_class
          schema:
            $ref: '#/components/schemas/security-center_issueClasses'
        - in: query
          name: issue_type
          schema:
            $ref: '#/components/schemas/security-center_issueTypes'
        - in: query
          name: product
          schema:
            $ref: '#/components/schemas/security-center_products'
        - in: query
          name: severity
          schema:
            $ref: '#/components/schemas/security-center_severityQueryParam'
        - in: query
          name: subject
          schema:
            $ref: '#/components/schemas/security-center_subjects'
        - in: query
          name: issue_class~neq
          schema:
            $ref: '#/components/schemas/security-center_issueClasses'
        - in: query
          name: issue_type~neq
          schema:
            $ref: '#/components/schemas/security-center_issueTypes'
        - in: query
          name: product~neq
          schema:
            $ref: '#/components/schemas/security-center_products'
        - in: query
          name: severity~neq
          schema:
            $ref: '#/components/schemas/security-center_severityQueryParam'
        - in: query
          name: subject~neq
          schema:
            $ref: '#/components/schemas/security-center_subjects'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_api-response-common-failure'
          description: Client Error
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_valueCountsResponse'
          description: OK
      security:
        - api_email: []
          api_key: []
        - api_token: []
      summary: APIs.io Engineering Platform Get Security Center Issue Counts by Type
      tags:
        - Security Center Insights
  /accounts/{account_id}/intel/dns:
    get:
      operationId: passive-dns-by-ip-get-passive-dns-by-ip
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/intel_identifier'
        - in: query
          name: start_end_params
          schema:
            $ref: '#/components/schemas/intel_start_end_params'
        - in: query
          name: ipv4
          schema:
            type: string
        - in: query
          name: page
          schema:
            description: Requested page within paginated list of results.
            example: 1
            type: number
        - in: query
          name: per_page
          schema:
            description: Maximum number of results requested.
            example: 20
            type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/intel_components-schemas-single_response'
                  - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Get Passive DNS by IP response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_components-schemas-single_response'
          description: Get Passive DNS by IP response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Passive DNS by IP
      tags:
        - Passive DNS by IP
  /accounts/{account_id}/intel/domain:
    get:
      operationId: domain-intelligence-get-domain-details
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/intel_identifier'
        - in: query
          name: domain
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/intel_single_response'
                  - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Get Domain Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_single_response'
          description: Get Domain Details response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Domain Details
      tags:
        - Domain Intelligence
  /accounts/{account_id}/intel/domain-history:
    get:
      operationId: domain-history-get-domain-history
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/intel_identifier'
        - in: query
          name: domain
          schema:
            example: example.com
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/intel_response'
                  - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Get Domain History response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_response'
          description: Get Domain History response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Domain History
      tags:
        - Domain History
  /accounts/{account_id}/intel/domain/bulk:
    get:
      operationId: domain-intelligence-get-multiple-domain-details
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/intel_identifier'
        - in: query
          name: domain
          schema:
            description: Accepts multiple values, i.e. `?domain=cloudflare.com&domain=example.com`.
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/intel_collection_response'
                  - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Get Multiple Domain Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_collection_response'
          description: Get Multiple Domain Details response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Multiple Domain Details
      tags:
        - Domain Intelligence
  /accounts/{account_id}/intel/indicator-feeds:
    get:
      operationId: custom-indicator-feeds-get-indicator-feeds
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_response'
                  - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_response'
          description: Get indicator feeds response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get indicator feeds owned by this account
      tags:
        - Custom Indicator Feeds
      x-api-token-group:
        - Intel Read
    post:
      operationId: custom-indicator-feeds-create-indicator-feeds
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_create_feed'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-indicator-feeds_create_feed_response'
                  - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds failure response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_create_feed_response'
          description: Create indicator feed response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create new indicator feed
      tags:
        - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator-feeds/{feed_id}:
    get:
      operationId: custom-indicator-feeds-get-indicator-feed-metadata
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_identifier'
        - in: path
          name: feed_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_metadata_response'
                  - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_metadata_response'
          description: Get indicator feed metadata
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get indicator feed metadata
      tags:
        - Custom Indicator Feeds
    put:
      operationId: custom-indicator-feeds-update-indicator-feed-metadata
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_identifier'
        - in: path
          name: feed_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_update_public_field_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-indicator-feeds_update_public_field_response'
                  - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get update public field response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_update_public_field_response'
          description: Get update public field response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update indicator feed metadata
      tags:
        - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator-feeds/{feed_id}/data:
    get:
      operationId: custom-indicator-feeds-get-indicator-feed-data
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_identifier'
        - in: path
          name: feed_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        "200":
          content:
            text/csv:
              schema:
                type: string
          description: Get indicator feed metadata
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get indicator feed data
      tags:
        - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot:
    put:
      operationId: custom-indicator-feeds-update-indicator-feed-data
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_identifier'
        - in: path
          name: feed_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                source:
                  description: The file to upload
                  example: '@/Users/me/test.stix2'
                  type: string
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_update_feed_response'
          description: Get indicator feed metadata
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update indicator feed data
      tags:
        - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator-feeds/permissions/add:
    put:
      operationId: custom-indicator-feeds-add-permission
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_permissions_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-indicator-feeds_permissions_response'
                  - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_permissions_response'
          description: Get indicator feed metadata
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Grant permission to indicator feed
      tags:
        - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator-feeds/permissions/remove:
    put:
      operationId: custom-indicator-feeds-remove-permission
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_permissions_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-indicator-feeds_permissions_response'
                  - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_permissions_response'
          description: Get indicator feed metadata
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Revoke permission to indicator feed
      tags:
        - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator-feeds/permissions/view:
    get:
      operationId: custom-indicator-feeds-view-permissions
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-indicator-feeds_permission_list_item_response'
                  - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_permission_list_item_response'
          description: Get indicator feed metadata
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List indicator feed permissions
      tags:
        - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator_feeds/{feed_id}/download:
    get:
      operationId: custom-indicator-feeds-download-indicator-feed-data
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_identifier'
        - in: path
          name: feed_id
          required: true
          schema:
            $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_update_feed_response'
          description: Get indicator feed metadata
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Download indicator feed data
      tags:
        - Custom Indicator Feeds
  /accounts/{account_id}/intel/ip:
    get:
      operationId: ip-intelligence-get-ip-overview
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/intel_identifier'
        - in: query
          name: ipv4
          schema:
            type: string
        - in: query
          name: ipv6
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/intel_schemas-response'
                  - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Get IP Overview response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_schemas-response'
          description: Get IP Overview response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get IP Overview
      tags:
        - IP Intelligence
  /accounts/{account_id}/intel/ip-list:
    get:
      operationId: ip-list-get-ip-lists
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/intel_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/intel_components-schemas-response'
                  - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Get IP Lists response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_components-schemas-response'
          description: Get IP Lists response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get IP Lists
      tags:
        - IP List
  /accounts/{account_id}/intel/miscategorization:
    post:
      operationId: miscategorization-create-miscategorization
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/intel_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/intel_miscategorization'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/intel_api-response-single'
                  - $ref: '#/components/schemas/intel_api-response-common-failure'
          description: Create Miscategorization response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel_api-response-single'
          description: Create Miscategorization response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Miscategorization
      tags:
        - Miscategorization
  /accounts/{account_id}/intel/sinkholes:
    get:
      operationId: sinkhole-config-get-sinkholes
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/intel-sinkholes_identifier'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel-sinkholes_get_sinkholes_response'
          description: Successful Response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List sinkholes owned by this account
      tags:
        - Sinkhole Config
      x-api-token-group:
        - Intel Read
  /accounts/{account_id}/intel/whois:
    get:
      operationId: whois-record-get-whois-record
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: query
          name: domain
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_schemas-single_response'
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get WHOIS Record response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_schemas-single_response'
          description: Get WHOIS Record response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get WHOIS Record
      tags:
        - WHOIS Record
      x-api-token-group:
        - Intel Read
  /accounts/{account_id}/load_balancers/monitors:
    get:
      description: List configured monitors for an account.
      operationId: account-load-balancer-monitors-list-monitors
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_monitor-response-collection'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: List Monitors response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-collection'
          description: List Monitors response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Monitors
      tags:
        - Account Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
        - 'Load Balancing: Monitors and Pools Read'
    post:
      description: Create a configured monitor.
      operationId: account-load-balancer-monitors-create-monitor
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-editable'
                - required:
                    - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Create Monitor response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
          description: Create Monitor response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create Monitor
      tags:
        - Account Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
  /accounts/{account_id}/load_balancers/monitors/{monitor_id}:
    delete:
      description: Delete a configured monitor.
      operationId: account-load-balancer-monitors-delete-monitor
      parameters:
        - in: path
          name: monitor_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_id_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Delete Monitor response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_id_response'
          description: Delete Monitor response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete Monitor
      tags:
        - Account Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
    get:
      description: List a single configured monitor for an account.
      operationId: account-load-balancer-monitors-monitor-details
      parameters:
        - in: path
          name: monitor_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Monitor Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
          description: Monitor Details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Monitor Details
      tags:
        - Account Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
        - 'Load Balancing: Monitors and Pools Read'
    patch:
      description: Apply changes to an existing monitor, overwriting the supplied properties.
      operationId: account-load-balancer-monitors-patch-monitor
      parameters:
        - in: path
          name: monitor_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-editable'
                - required:
                    - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Patch Monitor response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
          description: Patch Monitor response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Patch Monitor
      tags:
        - Account Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
    put:
      description: Modify a configured monitor.
      operationId: account-load-balancer-monitors-update-monitor
      parameters:
        - in: path
          name: monitor_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-editable'
                - required:
                    - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Update Monitor response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
          description: Update Monitor response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update Monitor
      tags:
        - Account Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
  /accounts/{account_id}/load_balancers/monitors/{monitor_id}/preview:
    post:
      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:
        - in: path
          name: monitor_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-editable'
                - required:
                    - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_preview_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Preview Monitor response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_preview_response'
          description: Preview Monitor response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Preview Monitor
      tags:
        - Account Load Balancer Monitors
  /accounts/{account_id}/load_balancers/monitors/{monitor_id}/references:
    get:
      description: Get the list of resources that reference the provided monitor.
      operationId: account-load-balancer-monitors-list-monitor-references
      parameters:
        - in: path
          name: monitor_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_references_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: List Monitor References response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_references_response'
          description: List Monitor References response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Monitor References
      tags:
        - Account Load Balancer Monitors
  /accounts/{account_id}/load_balancers/pools:
    get:
      description: List configured pools.
      operationId: account-load-balancer-pools-list-pools
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
        - in: query
          name: monitor
          schema:
            description: The ID of the Monitor to use for checking the health of origins within this pool.
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-response_collection'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: List Pools response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-response_collection'
          description: List Pools response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Pools
      tags:
        - Account Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
        - 'Load Balancing: Monitors and Pools Read'
    patch:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                notification_email:
                  $ref: '#/components/schemas/load-balancing_patch_pools_notification_email'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-response_collection'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Patch Pools response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-response_collection'
          description: Patch Pools response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Patch Pools
      tags:
        - Account Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
    post:
      description: Create a new pool.
      operationId: account-load-balancer-pools-create-pool
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                description:
                  $ref: '#/components/schemas/load-balancing_schemas-description'
                enabled:
                  $ref: '#/components/schemas/load-balancing_enabled'
                latitude:
                  $ref: '#/components/schemas/load-balancing_latitude'
                load_shedding:
                  $ref: '#/components/schemas/load-balancing_load_shedding'
                longitude:
                  $ref: '#/components/schemas/load-balancing_longitude'
                minimum_origins:
                  $ref: '#/components/schemas/load-balancing_minimum_origins'
                monitor:
                  $ref: '#/components/schemas/load-balancing_monitor_id'
                name:
                  $ref: '#/components/schemas/load-balancing_name'
                notification_email:
                  $ref: '#/components/schemas/load-balancing_notification_email'
                notification_filter:
                  $ref: '#/components/schemas/load-balancing_notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/load-balancing_origin_steering'
                origins:
                  $ref: '#/components/schemas/load-balancing_origins'
              required:
                - origins
                - name
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-single_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Create Pool response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-single_response'
          description: Create Pool response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create Pool
      tags:
        - Account Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
  /accounts/{account_id}/load_balancers/pools/{pool_id}:
    delete:
      description: Delete a configured pool.
      operationId: account-load-balancer-pools-delete-pool
      parameters:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-id_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Delete Pool response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-id_response'
          description: Delete Pool response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete Pool
      tags:
        - Account Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
    get:
      description: Fetch a single configured pool.
      operationId: account-load-balancer-pools-pool-details
      parameters:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-single_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Pool Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-single_response'
          description: Pool Details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Pool Details
      tags:
        - Account Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
        - 'Load Balancing: Monitors and Pools Read'
    patch:
      description: Apply changes to an existing pool, overwriting the supplied properties.
      operationId: account-load-balancer-pools-patch-pool
      parameters:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                check_regions:
                  $ref: '#/components/schemas/load-balancing_check_regions'
                description:
                  $ref: '#/components/schemas/load-balancing_schemas-description'
                disabled_at:
                  $ref: '#/components/schemas/load-balancing_schemas-disabled_at'
                enabled:
                  $ref: '#/components/schemas/load-balancing_enabled'
                latitude:
                  $ref: '#/components/schemas/load-balancing_latitude'
                load_shedding:
                  $ref: '#/components/schemas/load-balancing_load_shedding'
                longitude:
                  $ref: '#/components/schemas/load-balancing_longitude'
                minimum_origins:
                  $ref: '#/components/schemas/load-balancing_minimum_origins'
                monitor:
                  $ref: '#/components/schemas/load-balancing_monitor_id'
                name:
                  $ref: '#/components/schemas/load-balancing_name'
                notification_email:
                  $ref: '#/components/schemas/load-balancing_notification_email'
                notification_filter:
                  $ref: '#/components/schemas/load-balancing_notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/load-balancing_origin_steering'
                origins:
                  $ref: '#/components/schemas/load-balancing_origins'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-single_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Patch Pool response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-single_response'
          description: Patch Pool response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Patch Pool
      tags:
        - Account Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
    put:
      description: Modify a configured pool.
      operationId: account-load-balancer-pools-update-pool
      parameters:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                check_regions:
                  $ref: '#/components/schemas/load-balancing_check_regions'
                description:
                  $ref: '#/components/schemas/load-balancing_schemas-description'
                disabled_at:
                  $ref: '#/components/schemas/load-balancing_schemas-disabled_at'
                enabled:
                  $ref: '#/components/schemas/load-balancing_enabled'
                latitude:
                  $ref: '#/components/schemas/load-balancing_latitude'
                load_shedding:
                  $ref: '#/components/schemas/load-balancing_load_shedding'
                longitude:
                  $ref: '#/components/schemas/load-balancing_longitude'
                minimum_origins:
                  $ref: '#/components/schemas/load-balancing_minimum_origins'
                monitor:
                  $ref: '#/components/schemas/load-balancing_monitor_id'
                name:
                  $ref: '#/components/schemas/load-balancing_name'
                notification_email:
                  $ref: '#/components/schemas/load-balancing_notification_email'
                notification_filter:
                  $ref: '#/components/schemas/load-balancing_notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/load-balancing_origin_steering'
                origins:
                  $ref: '#/components/schemas/load-balancing_origins'
              required:
                - origins
                - name
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-single_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Update Pool response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-single_response'
          description: Update Pool response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update Pool
      tags:
        - Account Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
  /accounts/{account_id}/load_balancers/pools/{pool_id}/health:
    get:
      description: Fetch the latest pool health status for a single pool.
      operationId: account-load-balancer-pools-pool-health-details
      parameters:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_health_details'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Pool Health Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_health_details'
          description: Pool Health Details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Pool Health Details
      tags:
        - Account Load Balancer Pools
  /accounts/{account_id}/load_balancers/pools/{pool_id}/preview:
    post:
      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:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-editable'
                - required:
                    - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_preview_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Preview Pool response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_preview_response'
          description: Preview Pool response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Preview Pool
      tags:
        - Account Load Balancer Pools
  /accounts/{account_id}/load_balancers/pools/{pool_id}/references:
    get:
      description: Get the list of resources that reference the provided pool.
      operationId: account-load-balancer-pools-list-pool-references
      parameters:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-references_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: List Pool References response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-references_response'
          description: List Pool References response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Pool References
      tags:
        - Account Load Balancer Pools
  /accounts/{account_id}/load_balancers/preview/{preview_id}:
    get:
      description: Get the result of a previous preview operation using the provided preview_id.
      operationId: account-load-balancer-monitors-preview-result
      parameters:
        - in: path
          name: preview_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-preview_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_preview_result_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Preview Result response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_preview_result_response'
          description: Preview Result response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Preview Result
      tags:
        - Account Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Read'
  /accounts/{account_id}/load_balancers/regions:
    get:
      description: List all region mappings.
      operationId: load-balancer-regions-list-regions
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
        - in: query
          name: subdivision_code
          schema:
            $ref: '#/components/schemas/load-balancing_subdivision_code_a2'
        - in: query
          name: subdivision_code_a2
          schema:
            $ref: '#/components/schemas/load-balancing_subdivision_code_a2'
        - in: query
          name: country_code_a2
          schema:
            description: Two-letter alpha-2 country code followed in ISO 3166-1.
            example: US
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_region_components-schemas-response_collection'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: List Regions response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_region_components-schemas-response_collection'
          description: List Regions response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Regions
      tags:
        - Load Balancer Regions
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Read'
  /accounts/{account_id}/load_balancers/regions/{region_id}:
    get:
      description: Get a single region mapping.
      operationId: load-balancer-regions-get-region
      parameters:
        - in: path
          name: region_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_region_code'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_components-schemas-single_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Get Region response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_components-schemas-single_response'
          description: Get Region response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Region
      tags:
        - Load Balancer Regions
  /accounts/{account_id}/load_balancers/search:
    get:
      description: Search for Load Balancing resources.
      operationId: account-load-balancer-search-search-resources
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_components-schemas-identifier'
        - in: query
          name: search_params
          schema:
            $ref: '#/components/schemas/load-balancing_search_params'
        - in: query
          name: page
          schema:
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 25
            maximum: 1000
            minimum: 1
            type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/load-balancing_api-response-collection'
                      - $ref: '#/components/schemas/load-balancing_search_result'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Search Resources response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_api-response-collection'
                  - $ref: '#/components/schemas/load-balancing_search_result'
          description: Search Resources response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Search Resources
      tags:
        - Account Load Balancer Search
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Read'
  /accounts/{account_id}/logpush/datasets/{dataset_id}/fields:
    get:
      description: Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions.
      operationId: get-accounts-account_id-logpush-datasets-dataset_id-fields
      parameters:
        - example: gateway_dns
          in: path
          name: dataset_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_dataset'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: List fields response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_logpush_field_response_collection'
          description: List fields response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List fields
      tags:
        - Logpush Jobs for an Account
      x-api-token-group:
        - Logs Write
        - Logs Read
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/datasets/{dataset_id}/jobs:
    get:
      description: Lists Logpush jobs for an account for a dataset.
      operationId: get-accounts-account_id-logpush-datasets-dataset_id-jobs
      parameters:
        - example: gateway_dns
          in: path
          name: dataset_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_dataset'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: List Logpush jobs for a dataset response failure
        "200":
          content:
            application/json:
              example:
                errors: []
                messages: []
                result:
                  - dataset: gateway_dns
                    destination_conf: s3://mybucket/logs?region=us-west-2
                    enabled: false
                    error_message:
                    id: 1
                    kind: ""
                    last_complete:
                    last_error:
                    max_upload_bytes: 5e+06
                    max_upload_interval_seconds: 30
                    max_upload_records: 1000
                    name: example.com
                    output_options:
                      CVE-2021-4428: false
                      batch_prefix: ""
                      batch_suffix: ""
                      field_delimiter: ','
                      field_names:
                        - Datetime
                        - DstIP
                        - SrcIP
                      output_type: ndjson
                      record_delimiter: ""
                      record_prefix: '{'
                      record_suffix: |
                        }
                      record_template: ""
                      sample_rate: 1
                      timestamp_format: unixnano
                success: true
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_collection'
          description: List Logpush jobs for a dataset response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Logpush jobs for a dataset
      tags:
        - Logpush Jobs for an Account
      x-api-token-group:
        - Logs Write
        - Logs Read
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/jobs:
    get:
      description: Lists Logpush jobs for an account.
      operationId: get-accounts-account_id-logpush-jobs
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: List Logpush jobs response failure
        "200":
          content:
            application/json:
              example:
                errors: []
                messages: []
                result:
                  - dataset: gateway_dns
                    destination_conf: s3://mybucket/logs?region=us-west-2
                    enabled: false
                    error_message:
                    id: 1
                    kind: ""
                    last_complete:
                    last_error:
                    max_upload_bytes: 5e+06
                    max_upload_interval_seconds: 30
                    max_upload_records: 1000
                    name: example.com
                    output_options:
                      CVE-2021-4428: false
                      batch_prefix: ""
                      batch_suffix: ""
                      field_delimiter: ','
                      field_names:
                        - Datetime
                        - DstIP
                        - SrcIP
                      output_type: ndjson
                      record_delimiter: ""
                      record_prefix: '{'
                      record_suffix: |
                        }
                      record_template: ""
                      sample_rate: 1
                      timestamp_format: unixnano
                success: true
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_collection'
          description: List Logpush jobs response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Logpush jobs
      tags:
        - Logpush Jobs for an Account
      x-api-token-group:
        - Logs Write
        - Logs Read
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new Logpush job for an account.
      operationId: post-accounts-account_id-logpush-jobs
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json:
            example:
              dataset: gateway_dns
              destination_conf: s3://mybucket/logs?region=us-west-2
              enabled: false
              kind: ""
              max_upload_bytes: 5e+06
              max_upload_interval_seconds: 30
              max_upload_records: 1000
              name: example.com
              output_options:
                CVE-2021-4428: false
                batch_prefix: ""
                batch_suffix: ""
                field_delimiter: ','
                field_names:
                  - Datetime
                  - DstIP
                  - SrcIP
                output_type: ndjson
                record_delimiter: ""
                record_prefix: '{'
                record_suffix: |
                  }
                record_template: ""
                sample_rate: 1
                timestamp_format: unixnano
              ownership_challenge": "00000000000000000000"
            schema:
              properties:
                dataset:
                  $ref: '#/components/schemas/logpush_dataset'
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
                enabled:
                  $ref: '#/components/schemas/logpush_enabled'
                frequency:
                  $ref: '#/components/schemas/logpush_frequency'
                kind:
                  $ref: '#/components/schemas/logpush_kind'
                logpull_options:
                  $ref: '#/components/schemas/logpush_logpull_options'
                max_upload_bytes:
                  $ref: '#/components/schemas/logpush_max_upload_bytes'
                max_upload_interval_seconds:
                  $ref: '#/components/schemas/logpush_max_upload_interval_seconds'
                max_upload_records:
                  $ref: '#/components/schemas/logpush_max_upload_records'
                name:
                  $ref: '#/components/schemas/logpush_name'
                output_options:
                  $ref: '#/components/schemas/logpush_output_options'
                ownership_challenge:
                  $ref: '#/components/schemas/logpush_ownership_challenge'
              required:
                - destination_conf
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Create Logpush job response failure
        "200":
          content:
            application/json:
              example:
                errors: []
                messages: []
                result:
                  dataset: gateway_dns
                  destination_conf: s3://mybucket/logs?region=us-west-2
                  enabled: false
                  error_message:
                  id: 1
                  kind: ""
                  last_complete:
                  last_error:
                  max_upload_bytes: 5e+06
                  max_upload_interval_seconds: 30
                  max_upload_records: 1000
                  name: example.com
                  output_options:
                    CVE-2021-4428: false
                    batch_prefix: ""
                    batch_suffix: ""
                    field_delimiter: ','
                    field_names:
                      - Datetime
                      - DstIP
                      - SrcIP
                    output_type: ndjson
                    record_delimiter: ""
                    record_prefix: '{'
                    record_suffix: |
                      }
                    record_template: ""
                    sample_rate: 1
                    timestamp_format: unixnano
                success: true
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_single'
          description: Create Logpush job response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create Logpush job
      tags:
        - Logpush Jobs for an Account
      x-api-token-group:
        - Logs Write
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/jobs/{job_id}:
    delete:
      description: Deletes a Logpush job.
      operationId: delete-accounts-account_id-logpush-jobs-job_id
      parameters:
        - in: path
          name: job_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Delete Logpush job response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common'
                  - properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/logpush_id'
                        type: object
          description: Delete Logpush job response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete Logpush job
      tags:
        - Logpush Jobs for an Account
      x-api-token-group:
        - Logs Write
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Gets the details of a Logpush job.
      operationId: get-accounts-account_id-logpush-jobs-job_id
      parameters:
        - in: path
          name: job_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Get Logpush job details response failure
        "200":
          content:
            application/json:
              example:
                errors: []
                messages: []
                result:
                  dataset: gateway_dns
                  destination_conf: s3://mybucket/logs?region=us-west-2
                  enabled: false
                  error_message:
                  id: 1
                  kind: ""
                  last_complete:
                  last_error:
                  max_upload_bytes: 5e+06
                  max_upload_interval_seconds: 30
                  max_upload_records: 1000
                  name: example.com
                  output_options:
                    CVE-2021-4428: false
                    batch_prefix: ""
                    batch_suffix: ""
                    field_delimiter: ','
                    field_names:
                      - Datetime
                      - DstIP
                      - SrcIP
                    output_type: ndjson
                    record_delimiter: ""
                    record_prefix: '{'
                    record_suffix: |
                      }
                    record_template: ""
                    sample_rate: 1
                    timestamp_format: unixnano
                success: true
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_single'
          description: Get Logpush job details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Logpush job details
      tags:
        - Logpush Jobs for an Account
      x-api-token-group:
        - Logs Write
        - Logs Read
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Updates a Logpush job.
      operationId: put-accounts-account_id-logpush-jobs-job_id
      parameters:
        - in: path
          name: job_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json:
            example:
              destination_conf: s3://mybucket/logs?region=us-west-2
              enabled: false
              kind: ""
              max_upload_bytes: 5e+06
              max_upload_interval_seconds: 30
              max_upload_records: 1000
              output_options:
                CVE-2021-4428: false
                batch_prefix: ""
                batch_suffix: ""
                field_delimiter: ','
                field_names:
                  - Datetime
                  - DstIP
                  - SrcIP
                output_type: ndjson
                record_delimiter: ""
                record_prefix: '{'
                record_suffix: |
                  }
                record_template: ""
                sample_rate: 1
                timestamp_format: unixnano
              ownership_challenge": "00000000000000000000"
            schema:
              properties:
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
                enabled:
                  $ref: '#/components/schemas/logpush_enabled'
                frequency:
                  $ref: '#/components/schemas/logpush_frequency'
                kind:
                  $ref: '#/components/schemas/logpush_kind'
                logpull_options:
                  $ref: '#/components/schemas/logpush_logpull_options'
                max_upload_bytes:
                  $ref: '#/components/schemas/logpush_max_upload_bytes'
                max_upload_interval_seconds:
                  $ref: '#/components/schemas/logpush_max_upload_interval_seconds'
                max_upload_records:
                  $ref: '#/components/schemas/logpush_max_upload_records'
                output_options:
                  $ref: '#/components/schemas/logpush_output_options'
                ownership_challenge:
                  $ref: '#/components/schemas/logpush_ownership_challenge'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Update Logpush job response failure
        "200":
          content:
            application/json:
              example:
                errors: []
                messages: []
                result:
                  dataset: gateway_dns
                  destination_conf: s3://mybucket/logs?region=us-west-2
                  enabled: false
                  error_message:
                  id: 1
                  kind: ""
                  last_complete:
                  last_error:
                  max_upload_bytes: 5e+06
                  max_upload_interval_seconds: 30
                  max_upload_records: 1000
                  name: example.com
                  output_options:
                    CVE-2021-4428: false
                    batch_prefix: ""
                    batch_suffix: ""
                    field_delimiter: ','
                    field_names:
                      - Datetime
                      - DstIP
                      - SrcIP
                    output_type: ndjson
                    record_delimiter: ""
                    record_prefix: '{'
                    record_suffix: |
                      }
                    record_template: ""
                    sample_rate: 1
                    timestamp_format: unixnano
                success: true
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_single'
          description: Update Logpush job response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update Logpush job
      tags:
        - Logpush Jobs for an Account
      x-api-token-group:
        - Logs Write
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/ownership:
    post:
      description: Gets a new ownership challenge sent to your destination.
      operationId: post-accounts-account_id-logpush-ownership
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
              required:
                - destination_conf
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Get ownership challenge response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_get_ownership_response'
          description: Get ownership challenge response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get ownership challenge
      tags:
        - Logpush Jobs for an Account
      x-api-token-group:
        - Logs Write
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/ownership/validate:
    post:
      description: Validates ownership challenge of the destination.
      operationId: post-accounts-account_id-logpush-ownership-validate
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
                ownership_challenge:
                  $ref: '#/components/schemas/logpush_ownership_challenge'
              required:
                - destination_conf
                - ownership_challenge
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Validate ownership challenge response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_validate_ownership_response'
          description: Validate ownership challenge response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Validate ownership challenge
      tags:
        - Logpush Jobs for an Account
      x-api-token-group:
        - Logs Write
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/validate/destination/exists:
    post:
      description: Checks if there is an existing job with a destination.
      operationId: delete-accounts-account_id-logpush-validate-destination-exists
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
              required:
                - destination_conf
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Check destination exists response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_destination_exists_response'
          description: Check destination exists response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Check destination exists
      tags:
        - Logpush Jobs for an Account
      x-api-token-group:
        - Logs Write
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/validate/origin:
    post:
      description: Validates logpull origin with logpull_options.
      operationId: post-accounts-account_id-logpush-validate-origin
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                logpull_options:
                  $ref: '#/components/schemas/logpush_logpull_options'
              required:
                - logpull_options
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Validate origin response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_validate_response'
          description: Validate origin response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Validate origin
      tags:
        - Logpush Jobs for an Account
      x-api-token-group:
        - Logs Write
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logs/control/cmb/config:
    delete:
      description: Deletes CMB config.
      operationId: delete-accounts-account_id-logs-control-cmb-config
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logcontrol_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logcontrol_api-response-common-failure'
          description: Delete CMB config response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logcontrol_api-response-common'
                  - properties:
                      result:
                        enum:
                          - 
                        nullable: true
                        type: object
          description: Delete CMB config response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete CMB config
      tags:
        - Logcontrol CMB Config for an Account
      x-api-token-group:
        - Logs Write
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
    get:
      description: Gets CMB config.
      operationId: get-accounts-account_id-logs-control-cmb-config
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logcontrol_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logcontrol_api-response-common-failure'
          description: Get CMB config response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logcontrol_cmb_config_response_single'
          description: Get CMB config response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get CMB config
      tags:
        - Logcontrol CMB Config for an Account
      x-api-token-group:
        - Logs Write
        - Logs Read
      x-cfPermissionsRequired:
        enum:
          - '#logs:read'
          - '#analytics:read'
    post:
      description: Updates CMB config.
      operationId: post-accounts-account_id-logs-control-cmb-config
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/logcontrol_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/logcontrol_cmb_config'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/logcontrol_api-response-common-failure'
          description: Update CMB config response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logcontrol_cmb_config_response_single'
          description: Update CMB config response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update CMB config
      tags:
        - Logcontrol CMB Config for an Account
      x-api-token-group:
        - Logs Write
      x-cfPermissionsRequired:
        enum:
          - '#logs:edit'
  /accounts/{account_id}/magic/apps:
    get:
      description: Lists Apps associated with an account.
      operationId: magic-account-apps-list-apps
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List Apps response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_apps_collection_response'
          description: List Apps response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Apps
      tags:
        - Magic Account Apps
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new App for an account
      operationId: magic-account-apps-add-app
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_app_add_single_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Account App response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_single_response'
          description: Create Account App response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a new App
      tags:
        - Magic Account Apps
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/apps/{account_app_id}:
    delete:
      description: Deletes specific Account App.
      operationId: magic-account-apps-delete-app
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_app_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete App response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_single_response'
          description: Delete App response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Account App
      tags:
        - Magic Account Apps
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Updates an Account App
      operationId: magic-account-apps-update-app
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_app_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_app_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update App response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_single_response'
          description: Update App response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an App
      tags:
        - Magic Account Apps
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/cf_interconnects:
    get:
      description: Lists interconnects associated with an account.
      operationId: magic-interconnects-list-interconnects
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_components-schemas-tunnels_collection_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List interconnects response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_components-schemas-tunnels_collection_response'
          description: List interconnects response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List interconnects
      tags:
        - Magic Interconnects
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              required:
                - id
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_components-schemas-modified_tunnels_collection_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update multiple interconnects response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_components-schemas-modified_tunnels_collection_response'
          description: Update multiple interconnects response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update multiple interconnects
      tags:
        - Magic Interconnects
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id}:
    get:
      description: Lists details for a specific interconnect.
      operationId: magic-interconnects-list-interconnect-details
      parameters:
        - in: path
          name: cf_interconnect_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_components-schemas-tunnel_single_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List interconnect Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_components-schemas-tunnel_single_response'
          description: List interconnect Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List interconnect Details
      tags:
        - Magic Interconnects
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      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:
        - in: path
          name: cf_interconnect_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_components-schemas-tunnel_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_components-schemas-tunnel_modified_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update interconnect response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_components-schemas-tunnel_modified_response'
          description: Update interconnect response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update interconnect
      tags:
        - Magic Interconnects
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/connectors:
    get:
      operationId: mconn-connector-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mconn_account_id'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_customer_connector_list_response'
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Internal Server Error
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Connectors
      tags:
        - Magic Connectors
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/connectors/{connector_id}:
    get:
      operationId: mconn-connector-fetch
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mconn_account_id'
        - in: path
          name: connector_id
          required: true
          schema:
            $ref: '#/components/schemas/mconn_uuid'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_customer_connector_fetch_response'
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Internal Server Error
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Fetch Connector
      tags:
        - Magic Connectors
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      operationId: mconn-connector-update
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mconn_account_id'
        - in: path
          name: connector_id
          required: true
          schema:
            $ref: '#/components/schemas/mconn_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mconn_customer_connector_update_request'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_customer_connector_update_response'
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Internal Server Error
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update Connector
      tags:
        - Magic Connectors
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      operationId: mconn-connector-replace
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mconn_account_id'
        - in: path
          name: connector_id
          required: true
          schema:
            $ref: '#/components/schemas/mconn_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mconn_customer_connector_update_request'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_customer_connector_update_response'
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mconn_bad_response'
          description: Internal Server Error
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Replace Connector
      tags:
        - Magic Connectors
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/gre_tunnels:
    get:
      description: Lists GRE tunnels associated with an account.
      operationId: magic-gre-tunnels-list-gre-tunnels
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_tunnels_collection_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List GRE tunnels response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_tunnels_collection_response'
          description: List GRE tunnels response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List GRE tunnels
      tags:
        - Magic GRE Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              required:
                - name
                - customer_gre_endpoint
                - cloudflare_gre_endpoint
                - interface_address
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_tunnels_collection_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create GRE tunnels response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_tunnels_collection_response'
          description: Create GRE tunnels response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create GRE tunnels
      tags:
        - Magic GRE Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              required:
                - id
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_modified_tunnels_collection_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update multiple GRE tunnels response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_modified_tunnels_collection_response'
          description: Update multiple GRE tunnels response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update multiple GRE tunnels
      tags:
        - Magic GRE Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}:
    delete:
      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:
        - in: path
          name: gre_tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_tunnel_deleted_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete GRE Tunnel response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_tunnel_deleted_response'
          description: Delete GRE Tunnel response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete GRE Tunnel
      tags:
        - Magic GRE Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Lists informtion for a specific GRE tunnel.
      operationId: magic-gre-tunnels-list-gre-tunnel-details
      parameters:
        - in: path
          name: gre_tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_tunnel_single_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List GRE Tunnel Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_tunnel_single_response'
          description: List GRE Tunnel Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List GRE Tunnel Details
      tags:
        - Magic GRE Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      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:
        - in: path
          name: gre_tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_tunnel_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_tunnel_modified_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update GRE Tunnel response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_tunnel_modified_response'
          description: Update GRE Tunnel response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update GRE Tunnel
      tags:
        - Magic GRE Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/ipsec_tunnels:
    get:
      description: Lists IPsec tunnels associated with an account.
      operationId: magic-ipsec-tunnels-list-ipsec-tunnels
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_schemas-tunnels_collection_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List IPsec tunnels response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_schemas-tunnels_collection_response'
          description: List IPsec tunnels response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List IPsec tunnels
      tags:
        - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      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-ipsec-tunnels-create-ipsec-tunnels
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_schemas-tunnel_add_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_schemas-tunnels_collection_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create IPsec tunnels response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_schemas-tunnels_collection_response'
          description: Create IPsec tunnels response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create IPsec tunnels
      tags:
        - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      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-ipsec-tunnels-update-multiple-ipsec-tunnels
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              required:
                - id
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_schemas-modified_tunnels_collection_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update multiple IPsec tunnels response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_schemas-modified_tunnels_collection_response'
          description: Update multiple IPsec tunnels response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update multiple IPsec tunnels
      tags:
        - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}:
    delete:
      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-ipsec-tunnels-delete-ipsec-tunnel
      parameters:
        - in: path
          name: ipsec_tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_schemas-tunnel_deleted_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete IPsec Tunnel response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_schemas-tunnel_deleted_response'
          description: Delete IPsec Tunnel response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete IPsec Tunnel
      tags:
        - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Lists details for a specific IPsec tunnel.
      operationId: magic-ipsec-tunnels-list-ipsec-tunnel-details
      parameters:
        - in: path
          name: ipsec_tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_schemas-tunnel_single_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List IPsec tunnel details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_schemas-tunnel_single_response'
          description: List IPsec tunnel details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List IPsec tunnel details
      tags:
        - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      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-ipsec-tunnels-update-ipsec-tunnel
      parameters:
        - in: path
          name: ipsec_tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_schemas-tunnel_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_schemas-tunnel_modified_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update IPsec Tunnel response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_schemas-tunnel_modified_response'
          description: Update IPsec Tunnel response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update IPsec Tunnel
      tags:
        - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}/psk_generate:
    post:
      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-ipsec-tunnels-generate-pre-shared-key-(-psk)-for-ipsec-tunnels
      parameters:
        - in: path
          name: ipsec_tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_psk_generation_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Generate Pre Shared Key (PSK) for IPsec tunnels response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_psk_generation_response'
          description: Generate Pre Shared Key (PSK) for IPsec tunnels response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Generate Pre Shared Key (PSK) for IPsec tunnels
      tags:
        - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/routes:
    delete:
      description: Delete multiple Magic static routes.
      operationId: magic-static-routes-delete-many-routes
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_route_delete_many_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_multiple_route_delete_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete Many Routes response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_multiple_route_delete_response'
          description: Delete Many Routes response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Many Routes
      tags:
        - Magic Static Routes
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: List all Magic static routes.
      operationId: magic-static-routes-list-routes
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_routes_collection_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List Routes response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_routes_collection_response'
          description: List Routes response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Routes
      tags:
        - Magic Static Routes
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              required:
                - prefix
                - nexthop
                - priority
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_routes_collection_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Routes response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_routes_collection_response'
          description: Create Routes response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Routes
      tags:
        - Magic Static Routes
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_route_update_many_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_multiple_route_modified_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Many Routes response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_multiple_route_modified_response'
          description: Update Many Routes response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Many Routes
      tags:
        - Magic Static Routes
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/routes/{route_id}:
    delete:
      description: Disable and remove a specific Magic static route.
      operationId: magic-static-routes-delete-route
      parameters:
        - in: path
          name: route_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_route_deleted_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete Route response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_route_deleted_response'
          description: Delete Route response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Route
      tags:
        - Magic Static Routes
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get a specific Magic static route.
      operationId: magic-static-routes-route-details
      parameters:
        - in: path
          name: route_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_route_single_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Route Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_route_single_response'
          description: Route Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Route Details
      tags:
        - Magic Static Routes
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      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:
        - in: path
          name: route_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_route_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic_route_modified_response'
                  - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Route response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_route_modified_response'
          description: Update Route response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Route
      tags:
        - Magic Static Routes
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites:
    get:
      description: Lists Sites associated with an account. Use connector_identifier query param to return sites where connector_identifier matches either site.ConnectorID or site.SecondaryConnectorID.
      operationId: magic-sites-list-sites
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: query
          name: connector_identifier
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List Sites response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_sites_collection_response'
          description: List Sites response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Sites
      tags:
        - Magic Sites
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new Site
      operationId: magic-sites-create-site
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_sites_add_single_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Site response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_site_single_response'
          description: Create Site response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a new Site
      tags:
        - Magic Sites
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}:
    delete:
      description: Remove a specific Site.
      operationId: magic-sites-delete-site
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete Site response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_site_deleted_response'
          description: Delete Site response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Site
      tags:
        - Magic Sites
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get a specific Site.
      operationId: magic-sites-site-details
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Site Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_site_single_response'
          description: Site Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Site Details
      tags:
        - Magic Sites
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      description: Patch a specific Site.
      operationId: magic-sites-patch-site
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_site_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Patch Site response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_site_modified_response'
          description: Patch Site response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch Site
      tags:
        - Magic Sites
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Update a specific Site.
      operationId: magic-sites-update-site
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_site_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Site response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_site_modified_response'
          description: Update Site response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Site
      tags:
        - Magic Sites
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}/acls:
    get:
      description: Lists Site ACLs associated with an account.
      operationId: magic-site-acls-list-acls
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List Site ACLs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_acls_collection_response'
          description: List Site ACLs response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Site ACLs
      tags:
        - Magic Site ACLs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new Site ACL.
      operationId: magic-site-acls-create-acl
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_acls_add_single_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Site ACL response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_acl_single_response'
          description: Create Site ACL response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a new Site ACL
      tags:
        - Magic Site ACLs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}:
    delete:
      description: Remove a specific Site ACL.
      operationId: magic-site-acls-delete-acl
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: acl_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete Site ACL response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_acl_deleted_response'
          description: Delete Site ACL response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Site ACL
      tags:
        - Magic Site ACLs
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get a specific Site ACL.
      operationId: magic-site-acls-acl-details
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: acl_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Site ACL Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_acl_single_response'
          description: Site ACL Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Site ACL Details
      tags:
        - Magic Site ACLs
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      description: Patch a specific Site ACL.
      operationId: magic-site-acls-patch-acl
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: acl_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_acl_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Patch Site ACL response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_acl_modified_response'
          description: Patch Site ACL response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch Site ACL
      tags:
        - Magic Site ACLs
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Update a specific Site ACL.
      operationId: magic-site-acls-update-acl
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: acl_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_acl_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Site ACL response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_acl_modified_response'
          description: Update Site ACL response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Site ACL
      tags:
        - Magic Site ACLs
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}/app_configs:
    get:
      description: Lists App Configs associated with a site.
      operationId: magic-site-app-configs-list-app-configs
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List App Configs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_configs_collection_response'
          description: List App Configs response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List App Configs
      tags:
        - Magic Site App Configs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new App Config for a site
      operationId: magic-site-app-configs-add-app-config
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_app_config_add_single_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Site App Config response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_config_single_response'
          description: Create Site App Config response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a new App Config
      tags:
        - Magic Site App Configs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}/app_configs/{app_config_id}:
    delete:
      description: Deletes specific App Config associated with a site.
      operationId: magic-site-app-configs-delete-app-config
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: app_config_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete App Config response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_config_single_response'
          description: Delete App Config response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete App Config
      tags:
        - Magic Site App Configs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Updates an App Config for a site
      operationId: magic-site-app-configs-update-app-config
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: app_config_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_app_config_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Site App Config response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_config_single_response'
          description: Update Site App Config response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an App Config
      tags:
        - Magic Site App Configs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}/lans:
    get:
      description: Lists Site LANs associated with an account.
      operationId: magic-site-lans-list-lans
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List Site LANs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_lans_collection_response'
          description: List Site LANs response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Site LANs
      tags:
        - Magic Site LANs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new Site LAN. If the site is in high availability mode, static_addressing is required along with secondary and virtual address.
      operationId: magic-site-lans-create-lan
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_lans_add_single_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Site LAN response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_lans_collection_response'
          description: Create Site LAN response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a new Site LAN
      tags:
        - Magic Site LANs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}:
    delete:
      description: Remove a specific Site LAN.
      operationId: magic-site-lans-delete-lan
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: lan_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete Site LAN response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_lan_deleted_response'
          description: Delete Site LAN response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Site LAN
      tags:
        - Magic Site LANs
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get a specific Site LAN.
      operationId: magic-site-lans-lan-details
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: lan_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Site LAN Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_lan_single_response'
          description: Site LAN Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Site LAN Details
      tags:
        - Magic Site LANs
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      description: Patch a specific Site LAN.
      operationId: magic-site-lans-patch-lan
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: lan_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_lan_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Patch Site LAN response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_lan_modified_response'
          description: Patch Site LAN response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch Site LAN
      tags:
        - Magic Site LANs
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Update a specific Site LAN.
      operationId: magic-site-lans-update-lan
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: lan_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_lan_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Site LAN response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_lan_modified_response'
          description: Update Site LAN response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Site LAN
      tags:
        - Magic Site LANs
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}/wans:
    get:
      description: Lists Site WANs associated with an account.
      operationId: magic-site-wans-list-wans
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List Site WANs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_wans_collection_response'
          description: List Site WANs response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Site WANs
      tags:
        - Magic Site WANs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new Site WAN.
      operationId: magic-site-wans-create-wan
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_wans_add_single_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Site WAN response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_wans_collection_response'
          description: Create Site WAN response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a new Site WAN
      tags:
        - Magic Site WANs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}:
    delete:
      description: Remove a specific Site WAN.
      operationId: magic-site-wans-delete-wan
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: wan_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete Site WAN response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_wan_deleted_response'
          description: Delete Site WAN response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Site WAN
      tags:
        - Magic Site WANs
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get a specific Site WAN.
      operationId: magic-site-wans-wan-details
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: wan_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Site WAN Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_wan_single_response'
          description: Site WAN Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Site WAN Details
      tags:
        - Magic Site WANs
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      description: Patch a specific Site WAN.
      operationId: magic-site-wans-patch-wan
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: wan_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_wan_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Patch Site WAN response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_wan_modified_response'
          description: Patch Site WAN response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch Site WAN
      tags:
        - Magic Site WANs
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Update a specific Site WAN.
      operationId: magic-site-wans-update-wan
      parameters:
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
        - in: path
          name: wan_id
          required: true
          schema:
            $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_wan_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Site WAN response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_wan_modified_response'
          description: Update Site WAN response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Site WAN
      tags:
        - Magic Site WANs
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/members:
    get:
      description: List all members of an account.
      operationId: account-members-list-members
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
        - in: query
          name: order
          schema:
            description: Field to order results by.
            enum:
              - user.first_name
              - user.last_name
              - user.email
              - status
            example: status
        - in: query
          name: status
          schema:
            description: A member's status in the account.
            enum:
              - accepted
              - pending
              - rejected
            example: accepted
            type: string
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 20
            description: Maximum number of results per page.
            maximum: 50
            minimum: 5
            type: number
        - in: query
          name: direction
          schema:
            description: Direction to order results.
            enum:
              - asc
              - desc
            example: desc
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Members response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_collection_member_response_with_policies'
          description: List Members response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Members
      tags:
        - Account Members
      x-api-token-group:
        - Account Settings Write
        - Account Settings Read
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Add a user to the list of members for this account.
      operationId: account-members-add-member
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/iam_create-member-with-roles'
                - $ref: '#/components/schemas/iam_create-member-with-policies'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Add Member response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_member_response_with_policies'
          description: Add Member response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Add Member
      tags:
        - Account Members
      x-api-token-group:
        - Account Settings Write
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/members/{member_id}:
    delete:
      description: Remove a member from an account.
      operationId: account-members-remove-member
      parameters:
        - in: path
          name: member_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Remove Member response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-single-id'
          description: Remove Member response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Remove Member
      tags:
        - Account Members
      x-api-token-group:
        - Account Settings Write
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Get information about a specific member of an account.
      operationId: account-members-member-details
      parameters:
        - in: path
          name: member_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Member Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_member_response_with_policies'
          description: Member Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Member Details
      tags:
        - Account Members
      x-api-token-group:
        - Account Settings Write
        - Account Settings Read
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Modify an account member.
      operationId: account-members-update-member
      parameters:
        - in: path
          name: member_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/iam_update-member-with-roles'
                - $ref: '#/components/schemas/iam_update-member-with-policies'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Update Member response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_member_response_with_policies'
          description: Update Member response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Member
      tags:
        - Account Members
      x-api-token-group:
        - Account Settings Write
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/mnm/config:
    delete:
      description: Delete an existing network monitoring configuration.
      operationId: magic-network-monitoring-configuration-delete-account-configuration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Delete account configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
          description: Delete account configuration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete account configuration
      tags:
        - Magic Network Monitoring Configuration
      x-api-token-group:
        - Magic Network Monitoring Admin
    get:
      description: Lists default sampling, router IPs and warp devices for account.
      operationId: magic-network-monitoring-configuration-list-account-configuration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: List account configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
          description: List account configuration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List account configuration
      tags:
        - Magic Network Monitoring Configuration
      x-api-token-group:
        - Magic Network Monitoring Admin
        - Magic Network Monitoring Config Write
        - Magic Network Monitoring Config Read
    patch:
      description: Update fields in an existing network monitoring configuration.
      operationId: magic-network-monitoring-configuration-update-account-configuration-fields
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                default_sampling:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_default_sampling'
                name:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_name'
                router_ips:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_router_ips'
                warp_devices:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_warp_devices'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Update account configuration fields response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
          description: Update account configuration fields response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update account configuration fields
      tags:
        - Magic Network Monitoring Configuration
      x-api-token-group:
        - Magic Network Monitoring Admin
        - Magic Network Monitoring Config Write
    post:
      description: Create a new network monitoring configuration.
      operationId: magic-network-monitoring-configuration-create-account-configuration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                default_sampling:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_default_sampling'
                name:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_name'
                router_ips:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_router_ips'
                warp_devices:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_warp_devices'
              required:
                - name
                - default_sampling
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Create account configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
          description: Create account configuration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create account configuration
      tags:
        - Magic Network Monitoring Configuration
      x-api-token-group:
        - Magic Network Monitoring Admin
    put:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                default_sampling:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_default_sampling'
                name:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_name'
                router_ips:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_router_ips'
                warp_devices:
                  $ref: '#/components/schemas/magic-visibility_mnm_config_warp_devices'
              required:
                - name
                - default_sampling
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Update an entire account configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
          description: Update an entire account configuration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an entire account configuration
      tags:
        - Magic Network Monitoring Configuration
      x-api-token-group:
        - Magic Network Monitoring Admin
        - Magic Network Monitoring Config Write
  /accounts/{account_id}/mnm/config/full:
    get:
      description: Lists default sampling, router IPs, warp devices, and rules for account.
      operationId: magic-network-monitoring-configuration-list-rules-and-account-configuration
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: List rules and account configuration response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
          description: List rules and account configuration response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List rules and account configuration
      tags:
        - Magic Network Monitoring Configuration
      x-api-token-group:
        - Magic Network Monitoring Admin
        - Magic Network Monitoring Config Write
        - Magic Network Monitoring Config Read
  /accounts/{account_id}/mnm/rules:
    get:
      description: Lists network monitoring rules for account.
      operationId: magic-network-monitoring-rules-list-rules
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_rules_collection_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: List rules response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_rules_collection_response'
          description: List rules response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List rules
      tags:
        - Magic Network Monitoring Rules
      x-api-token-group:
        - Magic Network Monitoring Admin
        - Magic Network Monitoring Config Write
        - Magic Network Monitoring Config Read
    post:
      description: Create network monitoring rules for account. Currently only supports creating a single rule per API request.
      operationId: magic-network-monitoring-rules-create-rules
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                automatic_advertisement:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_automatic_advertisement'
                bandwidth:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_bandwidth_threshold'
                duration:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_duration'
                name:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_name'
                packet_threshold:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_packet_threshold'
                prefixes:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_ip_prefixes'
              required:
                - duration
                - name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Create rules response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
          description: Create rules response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create rules
      tags:
        - Magic Network Monitoring Rules
      x-api-token-group:
        - Magic Network Monitoring Admin
        - Magic Network Monitoring Config Write
    put:
      description: Update network monitoring rules for account.
      operationId: magic-network-monitoring-rules-update-rules
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                automatic_advertisement:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_automatic_advertisement'
                bandwidth:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_bandwidth_threshold'
                duration:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_duration'
                id:
                  $ref: '#/components/schemas/magic-visibility_rule_identifier'
                name:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_name'
                packet_threshold:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_packet_threshold'
                prefixes:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_ip_prefixes'
              required:
                - ID
                - duration
                - name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Update rules response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
          description: Update rules response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update rules
      tags:
        - Magic Network Monitoring Rules
      x-api-token-group:
        - Magic Network Monitoring Admin
        - Magic Network Monitoring Config Write
  /accounts/{account_id}/mnm/rules/{rule_id}:
    delete:
      description: Delete a network monitoring rule for account.
      operationId: magic-network-monitoring-rules-delete-rule
      parameters:
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_rule_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Delete rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
          description: Delete rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete rule
      tags:
        - Magic Network Monitoring Rules
      x-api-token-group:
        - Magic Network Monitoring Admin
        - Magic Network Monitoring Config Write
    get:
      description: List a single network monitoring rule for account.
      operationId: magic-network-monitoring-rules-get-rule
      parameters:
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_rule_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Get rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
          description: Get rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get rule
      tags:
        - Magic Network Monitoring Rules
      x-api-token-group:
        - Magic Network Monitoring Admin
        - Magic Network Monitoring Config Write
        - Magic Network Monitoring Config Read
    patch:
      description: Update a network monitoring rule for account.
      operationId: magic-network-monitoring-rules-update-rule
      parameters:
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_rule_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                automatic_advertisement:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_automatic_advertisement'
                bandwidth:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_bandwidth_threshold'
                duration:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_duration'
                name:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_name'
                packet_threshold:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_packet_threshold'
                prefixes:
                  $ref: '#/components/schemas/magic-visibility_mnm_rule_ip_prefixes'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Update rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
          description: Update rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update rule
      tags:
        - Magic Network Monitoring Rules
      x-api-token-group:
        - Magic Network Monitoring Admin
        - Magic Network Monitoring Config Write
  /accounts/{account_id}/mnm/rules/{rule_id}/advertisement:
    patch:
      description: Update advertisement for rule.
      operationId: magic-network-monitoring-rules-update-advertisement-for-rule
      parameters:
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_rule_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/magic-visibility_mnm_rule_advertisement_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Update advertisement for rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_mnm_rule_advertisement_single_response'
          description: Update advertisement for rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update advertisement for rule
      tags:
        - Magic Network Monitoring Rules
      x-api-token-group:
        - Magic Network Monitoring Admin
        - Magic Network Monitoring Config Write
  /accounts/{account_id}/mtls_certificates:
    get:
      description: Lists all mTLS certificates.
      operationId: m-tls-certificate-management-list-m-tls-certificates
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection'
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: List mTLS certificates response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection'
          description: List mTLS certificates response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List mTLS certificates
      tags:
        - mTLS Certificate Management
      x-api-token-group:
        - 'Account: SSL and Certificates Read'
        - 'Account: SSL and Certificates Write'
      x-cfPermissionsRequired:
        enum:
          - '#ssl:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Upload a certificate that you want to use with mTLS-enabled Cloudflare services.
      operationId: m-tls-certificate-management-upload-m-tls-certificate
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                ca:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_ca'
                certificates:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificates'
                name:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-name'
                private_key:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-private_key'
              required:
                - certificates
                - ca
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single_post'
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: Upload mTLS certificate response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single_post'
          description: Upload mTLS certificate response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Upload mTLS certificate
      tags:
        - mTLS Certificate Management
      x-api-token-group:
        - 'Account: SSL and Certificates Write'
      x-cfPermissionsRequired:
        enum:
          - '#ssl:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}:
    delete:
      description: Deletes the mTLS certificate unless the certificate is in use by one or more Cloudflare services.
      operationId: m-tls-certificate-management-delete-m-tls-certificate
      parameters:
        - in: path
          name: mtls_certificate_id
          required: true
          schema:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single'
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: Delete mTLS certificate response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single'
          description: Delete mTLS certificate response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete mTLS certificate
      tags:
        - mTLS Certificate Management
      x-api-token-group:
        - 'Account: SSL and Certificates Write'
      x-cfPermissionsRequired:
        enum:
          - '#ssl:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Fetches a single mTLS certificate.
      operationId: m-tls-certificate-management-get-m-tls-certificate
      parameters:
        - in: path
          name: mtls_certificate_id
          required: true
          schema:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single'
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: Get mTLS certificate response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single'
          description: Get mTLS certificate response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get mTLS certificate
      tags:
        - mTLS Certificate Management
      x-api-token-group:
        - 'Account: SSL and Certificates Read'
        - 'Account: SSL and Certificates Write'
      x-cfPermissionsRequired:
        enum:
          - '#ssl:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}/associations:
    get:
      description: Lists all active associations between the certificate and Cloudflare services.
      operationId: m-tls-certificate-management-list-m-tls-certificate-associations
      parameters:
        - in: path
          name: mtls_certificate_id
          required: true
          schema:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_association_response_collection'
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: List mTLS certificate associations response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_association_response_collection'
          description: List mTLS certificate associations response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List mTLS certificate associations
      tags:
        - mTLS Certificate Management
      x-api-token-group:
        - 'Account: SSL and Certificates Read'
        - 'Account: SSL and Certificates Write'
      x-cfPermissionsRequired:
        enum:
          - '#ssl:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/pages/projects:
    get:
      description: Fetch a list of all user projects.
      operationId: pages-project-get-projects
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_projects-response'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Get projects response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_projects-response'
          description: Get projects response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get projects
      tags:
        - Pages Project
    post:
      description: Create a new project.
      operationId: pages-project-create-project
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pages_project-object'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_project-response'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Create project response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_project-response'
          description: Create project response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create project
      tags:
        - Pages Project
  /accounts/{account_id}/pages/projects/{project_name}:
    delete:
      description: Delete a project by name.
      operationId: pages-project-delete-project
      parameters:
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - example:
                      errors: []
                      messages: []
                      result:
                      success: true
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Delete project response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_api-response-common'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
          description: Delete project response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete project
      tags:
        - Pages Project
    get:
      description: Fetch a project by name.
      operationId: pages-project-get-project
      parameters:
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_project-response'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Get project response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_project-response'
          description: Get project response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get project
      tags:
        - Pages Project
    patch:
      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:
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pages_project-patch'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_project-response'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Update project response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_project-response'
          description: Update project response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update project
      tags:
        - Pages Project
  /accounts/{account_id}/pages/projects/{project_name}/deployments:
    get:
      description: Fetch a list of project deployments.
      operationId: pages-deployment-get-deployments
      parameters:
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
        - in: query
          name: env
          schema:
            description: What type of deployments to fetch.
            enum:
              - production
              - preview
            example: preview
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_deployment-list-response'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Get deployments response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_deployment-list-response'
          description: Get deployments response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get deployments
      tags:
        - Pages Deployment
    post:
      description: Start a new deployment from production. The repository and account must have already been authorized on the Cloudflare Pages dashboard.
      operationId: pages-deployment-create-deployment
      parameters:
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                branch:
                  description: The branch to build the new deployment from. The `HEAD` of the branch will be used. If omitted, the production branch will be used by default.
                  example: staging
                  type: string
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_deployment-new-deployment'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Create deployment response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_deployment-new-deployment'
          description: Create deployment response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create deployment
      tags:
        - Pages Deployment
  /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}:
    delete:
      description: Delete a deployment.
      operationId: pages-deployment-delete-deployment
      parameters:
        - in: path
          name: deployment_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - example:
                      errors: []
                      messages: []
                      result:
                      success: true
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Delete deployment response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_api-response-common'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
          description: Delete deployment response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete deployment
      tags:
        - Pages Deployment
    get:
      description: Fetch information about a deployment.
      operationId: pages-deployment-get-deployment-info
      parameters:
        - in: path
          name: deployment_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_deployment-response-details'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Get deployment info response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_deployment-response-details'
          description: Get deployment info response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get deployment info
      tags:
        - Pages Deployment
  /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/history/logs:
    get:
      description: Fetch deployment logs for a project.
      operationId: pages-deployment-get-deployment-logs
      parameters:
        - in: path
          name: deployment_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_deployment-response-logs'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Get deployment logs response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_deployment-response-logs'
          description: Get deployment logs response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get deployment logs
      tags:
        - Pages Deployment
  /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/retry:
    post:
      description: Retry a previous deployment.
      operationId: pages-deployment-retry-deployment
      parameters:
        - in: path
          name: deployment_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_deployment-new-deployment'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Retry deployment response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_deployment-new-deployment'
          description: Retry deployment response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Retry deployment
      tags:
        - Pages Deployment
  /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/rollback:
    post:
      description: Rollback the production deployment to a previous deployment. You can only rollback to succesful builds on production.
      operationId: pages-deployment-rollback-deployment
      parameters:
        - in: path
          name: deployment_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_deployment-response-details'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Rollback deployment response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_deployment-response-details'
          description: Rollback deployment response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Rollback deployment
      tags:
        - Pages Deployment
  /accounts/{account_id}/pages/projects/{project_name}/domains:
    get:
      description: Fetch a list of all domains associated with a Pages project.
      operationId: pages-domains-get-domains
      parameters:
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_domain-response-collection'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Get domains response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_domain-response-collection'
          description: Get domains response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get domains
      tags:
        - Pages Domains
    post:
      description: Add a new domain for the Pages project.
      operationId: pages-domains-add-domain
      parameters:
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pages_domains-post'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_domain-response-single'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Add domain response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_domain-response-single'
          description: Add domain response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Add domain
      tags:
        - Pages Domains
  /accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}:
    delete:
      description: Delete a Pages project's domain.
      operationId: pages-domains-delete-domain
      parameters:
        - in: path
          name: domain_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_domain_name'
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4xx:
          content:
            application/json:
              schema:
                allOf:
                  - example:
                      errors: []
                      messages: []
                      result:
                      success: true
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Delete domain response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_api-response-common'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
          description: Delete domain response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete domain
      tags:
        - Pages Domains
    get:
      description: Fetch a single domain.
      operationId: pages-domains-get-domain
      parameters:
        - in: path
          name: domain_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_domain_name'
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_domain-response-single'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Get domain response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_domain-response-single'
          description: Get domain response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get domain
      tags:
        - Pages Domains
    patch:
      description: Retry the validation status of a single domain.
      operationId: pages-domains-patch-domain
      parameters:
        - in: path
          name: domain_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_domain_name'
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_domain-response-single'
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Patch domain response failure.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_domain-response-single'
          description: Patch domain response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch domain
      tags:
        - Pages Domains
  /accounts/{account_id}/pages/projects/{project_name}/purge_build_cache:
    post:
      description: Purge all cached build artifacts for a Pages project
      operationId: pages-purge-build-cache
      parameters:
        - in: path
          name: project_name
          required: true
          schema:
            $ref: '#/components/schemas/pages_project_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/pages_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Purge build cache failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/pages_api-response-common'
                  - properties:
                      result:
                        nullable: true
                        type: object
                    type: object
          description: Purge build cache response.
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Purge build cache
      tags:
        - Pages Build Cache
  /accounts/{account_id}/pcaps:
    get:
      description: Lists all packet capture requests for an account.
      operationId: magic-pcap-collection-list-packet-capture-requests
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_identifier'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_pcaps_collection_response'
          description: List packet capture requests response
        default:
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/magic-visibility_pcaps_collection_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: List packet capture requests response failure
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List packet capture requests
      tags:
        - Magic PCAP Collection
      x-api-token-group:
        - Magic Firewall Packet Captures - Write PCAPs API
        - Magic Firewall Packet Captures - Read PCAPs API
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Create new PCAP request for account.
      operationId: magic-pcap-collection-create-pcap-request
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic-visibility_pcaps_request_pcap'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_pcaps_single_response'
          description: Create PCAP request response
        default:
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/magic-visibility_pcaps_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Create PCAP request response failure
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create PCAP request
      tags:
        - Magic PCAP Collection
      x-api-token-group:
        - Magic Firewall Packet Captures - Write PCAPs API
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/pcaps/{pcap_id}:
    get:
      description: Get information for a PCAP request by id.
      operationId: magic-pcap-collection-get-pcap-request
      parameters:
        - in: path
          name: pcap_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_identifier'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_pcaps_single_response'
          description: Get PCAP request response
        default:
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/magic-visibility_pcaps_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Get PCAP request response failure
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get PCAP request
      tags:
        - Magic PCAP Collection
      x-api-token-group:
        - Magic Firewall Packet Captures - Write PCAPs API
        - Magic Firewall Packet Captures - Read PCAPs API
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/pcaps/{pcap_id}/download:
    get:
      description: Download PCAP information into a file. Response is a binary PCAP file.
      operationId: magic-pcap-collection-download-simple-pcap
      parameters:
        - in: path
          name: pcap_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_identifier'
      responses:
        "200":
          content:
            application/vnd.tcpdump.pcap: {}
          description: Download Simple PCAP response
        default:
          content:
            application/json: {}
          description: Download Simple PCAP response failure
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Download Simple PCAP
      tags:
        - Magic PCAP Collection
      x-api-token-group:
        - Magic Firewall Packet Captures - Write PCAPs API
        - Magic Firewall Packet Captures - Read PCAPs API
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/pcaps/ownership:
    get:
      description: List all buckets configured for use with PCAPs API.
      operationId: magic-pcap-collection-list-pca-ps-bucket-ownership
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_identifier'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_pcaps_ownership_collection'
          description: List PCAPs Bucket Ownership response
        default:
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/magic-visibility_pcaps_ownership_collection'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: List PCAPs Bucket Ownership response failure
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List PCAPs Bucket Ownership
      tags:
        - Magic PCAP Collection
      x-api-token-group:
        - Magic Firewall Packet Captures - Write PCAPs API
        - Magic Firewall Packet Captures - Read PCAPs API
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Adds an AWS or GCP bucket to use with full packet captures.
      operationId: magic-pcap-collection-add-buckets-for-full-packet-captures
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic-visibility_pcaps_ownership_request'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_pcaps_ownership_single_response'
          description: Add buckets for full packet captures response
        default:
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/magic-visibility_pcaps_ownership_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Add buckets for full packet captures response failure
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Add buckets for full packet captures
      tags:
        - Magic PCAP Collection
      x-api-token-group:
        - Magic Firewall Packet Captures - Write PCAPs API
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/pcaps/ownership/{ownership_id}:
    delete:
      description: Deletes buckets added to the packet captures API.
      operationId: magic-pcap-collection-delete-buckets-for-full-packet-captures
      parameters:
        - in: path
          name: ownership_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_identifier'
      responses:
        "204":
          description: Delete buckets for full packet captures response
        default:
          content:
            application/json: {}
          description: Delete buckets for full packet captures response failure
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete buckets for full packet captures
      tags:
        - Magic PCAP Collection
      x-api-token-group:
        - Magic Firewall Packet Captures - Write PCAPs API
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/pcaps/ownership/validate:
    post:
      description: Validates buckets added to the packet captures API.
      operationId: magic-pcap-collection-validate-buckets-for-full-packet-captures
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/magic-visibility_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic-visibility_pcaps_ownership_validate_request'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic-visibility_pcaps_ownership_single_response'
          description: Validate buckets for full packet captures response
        default:
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/magic-visibility_pcaps_ownership_single_response'
                  - $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
          description: Validate buckets for full packet captures response failure
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Validate buckets for full packet captures
      tags:
        - Magic PCAP Collection
      x-api-token-group:
        - Magic Firewall Packet Captures - Write PCAPs API
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/queues:
    get:
      description: Returns the queues owned by an account.
      operationId: queue-v2-list-queues
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/mq_api-response-collection'
                      - properties:
                          errors: {}
                      - properties:
                          messages: {}
                      - properties:
                          result_info:
                            properties:
                              count:
                                example: 1
                              page:
                                example: 1
                              per_page:
                                example: 100
                              total_count:
                                example: 1
                              total_pages:
                                example: 1
                            type: object
                      - properties:
                          result:
                            items:
                              $ref: '#/components/schemas/mq_queue'
                            type: array
                        required:
                          - queue_id
                          - queue_name
                          - created_on
                          - modified_on
                          - producers_total_count
                          - producers
                          - consumers_total_count
                          - consumers
                        type: object
                  - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: List Queues response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      errors: {}
                  - properties:
                      messages: {}
                  - properties:
                      result_info:
                        properties:
                          count:
                            example: 1
                          page:
                            example: 1
                          per_page:
                            example: 100
                          total_count:
                            example: 1
                          total_pages:
                            example: 1
                        type: object
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/mq_queue'
                        type: array
                    required:
                      - queue_id
                      - queue_name
                      - created_on
                      - modified_on
                      - producers_total_count
                      - producers
                      - consumers_total_count
                      - consumers
                    type: object
          description: List Queues response.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Queues
      tags:
        - Queue
      x-api-token-group:
        - Queues Write
        - Queues Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.queue.list
    post:
      description: Creates a new queue.
      operationId: queue-v2-create-queue
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                queue_name: example-queue
              properties:
                queue_name:
                  type: string
              required:
                - queue_name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/mq_api-response-collection'
                      - properties:
                          result:
                            allOf:
                              - $ref: '#/components/schemas/mq_queue_created'
                            type: object
                        required:
                          - queue_id
                          - queue_name
                          - created_on
                          - modified_on
                        type: object
                  - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Create Queue response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                          - $ref: '#/components/schemas/mq_queue_created'
                        type: object
                    required:
                      - queue_id
                      - queue_name
                      - created_on
                      - modified_on
                    type: object
          description: Create Queue response.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create Queue
      tags:
        - Queue
      x-api-token-group:
        - Queues Write
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.queue.create
  /accounts/{account_id}/queues/{queue_id}:
    delete:
      description: Deletes a queue.
      operationId: queue-v2-delete-queue
      parameters:
        - in: path
          name: queue_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/mq_api-response-collection'
                      - properties:
                          result: {}
                  - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Delete Queue response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result: {}
          description: Delete Queue response.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete Queue
      tags:
        - Queue
      x-api-token-group:
        - Queues Write
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.queue.delete
    get:
      description: Get information about a specific queue.
      operationId: queue-v2-queue-details
      parameters:
        - in: path
          name: queue_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/mq_api-response-collection'
                      - properties:
                          result:
                            allOf:
                              - $ref: '#/components/schemas/mq_queue'
                            type: object
                        required:
                          - queue_id
                          - queue_name
                          - created_on
                          - modified_on
                        type: object
                  - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Queue Details response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                          - $ref: '#/components/schemas/mq_queue'
                        type: object
                    required:
                      - queue_id
                      - queue_name
                      - created_on
                      - modified_on
                    type: object
          description: Queue Details response.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Queue Details
      tags:
        - Queue
      x-api-token-group:
        - Queues Write
        - Queues Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.queue.read
    put:
      description: Updates a queue.
      operationId: queue-v2-update-queue
      parameters:
        - in: path
          name: queue_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                queue_name: renamed-example-queue
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/mq_api-response-collection'
                      - properties:
                          result:
                            allOf:
                              - $ref: '#/components/schemas/mq_queue_updated'
                            type: object
                        required:
                          - queue_id
                          - queue_name
                          - created_on
                          - modified_on
                        type: object
                  - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Update Queue response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                          - $ref: '#/components/schemas/mq_queue_updated'
                        type: object
                    required:
                      - queue_id
                      - queue_name
                      - created_on
                      - modified_on
                    type: object
          description: Update Queue response.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update Queue
      tags:
        - Queue
      x-api-token-group:
        - Queues Write
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.queue.update
  /accounts/{account_id}/queues/{queue_id}/consumers:
    get:
      description: Returns the consumers for a queue.
      operationId: queue-v2-list-queue-consumers
      parameters:
        - in: path
          name: queue_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/mq_api-response-collection'
                      - properties:
                          errors: {}
                      - properties:
                          messages: {}
                      - properties:
                          result_info:
                            properties:
                              count:
                                example: 1
                              page:
                                example: 1
                              per_page:
                                example: 100
                              total_count:
                                example: 1
                              total_pages:
                                example: 1
                            type: object
                      - properties:
                          result:
                            items:
                              $ref: '#/components/schemas/mq_consumer'
                            type: array
                        required:
                          - queue_name
                          - created_on
                          - settings
                        type: object
                  - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: List Queue Consumers response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      errors: {}
                  - properties:
                      messages: {}
                  - properties:
                      result_info:
                        properties:
                          count:
                            example: 1
                          page:
                            example: 1
                          per_page:
                            example: 100
                          total_count:
                            example: 1
                          total_pages:
                            example: 1
                        type: object
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/mq_consumer'
                        type: array
                    required:
                      - queue_name
                      - created_on
                      - settings
                    type: object
          description: List Queue Consumers response.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Queue Consumers
      tags:
        - Queue
      x-api-token-group:
        - Queues Write
        - Queues Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.queue.list
    post:
      description: Creates a new consumer for a queue.
      operationId: queue-v2-create-queue-consumer
      parameters:
        - in: path
          name: queue_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      requestBody:
        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
                type: worker
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/mq_api-response-collection'
                      - properties:
                          result:
                            allOf:
                              - $ref: '#/components/schemas/mq_consumer_created'
                            type: object
                        required:
                          - queue_name
                          - script_name
                          - settings
                          - dead_letter_queue
                          - created_on
                        type: object
                  - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Create Queue Consumer response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                          - $ref: '#/components/schemas/mq_consumer_created'
                        type: object
                    required:
                      - queue_name
                      - script_name
                      - settings
                      - dead_letter_queue
                      - created_on
                    type: object
          description: Create Queue Consumer response.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create Queue Consumer
      tags:
        - Queue
      x-api-token-group:
        - Queues Write
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.queue.create
  /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}:
    delete:
      description: Deletes the consumer for a queue.
      operationId: queue-v2-delete-queue-consumer
      parameters:
        - in: path
          name: consumer_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: queue_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/mq_api-response-collection'
                      - properties:
                          result: {}
                  - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Delete Queue Consumer response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result: {}
          description: Delete Queue Consumer response.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete Queue Consumer
      tags:
        - Queue
      x-api-token-group:
        - Queues Write
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.queue.delete
    put:
      description: Updates the consumer for a queue, or creates one if it does not exist.
      operationId: queue-v2-update-queue-consumer
      parameters:
        - in: path
          name: consumer_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: queue_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                dead_letter_queue: updated-example-dlq
                environment: production
                script_name: example-consumer
                settings:
                  batch_size: 100
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/mq_api-response-collection'
                      - properties:
                          result:
                            allOf:
                              - $ref: '#/components/schemas/mq_consumer_updated'
                            type: object
                        required:
                          - queue_name
                          - script_name
                          - settings
                          - dead_letter_queue
                          - created_on
                        type: object
                  - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Update Queue Consumer response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                          - $ref: '#/components/schemas/mq_consumer_updated'
                        type: object
                    required:
                      - queue_name
                      - script_name
                      - settings
                      - dead_letter_queue
                      - created_on
                    type: object
          description: Update Queue Consumer response.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update Queue Consumer
      tags:
        - Queue
      x-api-token-group:
        - Queues Write
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.queue.update
  /accounts/{account_id}/queues/{queue_id}/messages/ack:
    post:
      description: Acknowledge + Retry messages from a Queue.
      operationId: queue-v2-messages-ack
      parameters:
        - in: path
          name: queue_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                acks:
                  items:
                    properties:
                      lease_id:
                        description: Lease ID for a message to acknowledge.
                        example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0
                        type: string
                    type: object
                  type: array
                retries:
                  items:
                    properties:
                      delay_seconds:
                        description: The number of seconds to delay before making the message available for another attempt.
                        example: 10
                        type: number
                      lease_id:
                        description: Lease ID for a message to retry.
                        example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0
                        type: string
                    type: object
                  type: array
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/mq_api-response-collection'
                      - properties:
                          result: {}
                  - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Acknoweldge Queue Messages response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        properties:
                          ackCount:
                            description: The number of messages that were succesfully acknowledged.
                            example: 5
                            type: number
                          retryCount:
                            description: The number of messages that were succesfully retried.
                            example: 5
                            type: number
                          warnings:
                            items:
                              type: string
                            type: array
                        type: object
          description: Acknoweldge Queue Messages response.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Acknowledge + Retry Queue Messages
      tags:
        - Queue
      x-api-token-group:
        - Queues Write
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.queue.update
  /accounts/{account_id}/queues/{queue_id}/messages/pull:
    post:
      description: Pull a batch of messages from a Queue.
      operationId: queue-v2-messages-pull
      parameters:
        - in: path
          name: queue_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                batch_size:
                  $ref: '#/components/schemas/mq_batch_size'
                visibility_timeout:
                  $ref: '#/components/schemas/mq_visibility_timeout'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/mq_api-response-collection'
                      - properties:
                          result: {}
                  - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Pull Queue Messages response failure.
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/mq_queue_message'
                        type: array
          description: Pull Queue Messages response.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Pull Queue Messages
      tags:
        - Queue
      x-api-token-group:
        - Queues Write
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.queue.update
  /accounts/{account_id}/r2/buckets:
    get:
      description: Lists all R2 buckets on your account
      operationId: r2-list-buckets
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
        - in: query
          name: name_contains
          schema:
            description: Bucket names to filter by. Only buckets with this phrase in their name will be returned.
            example: my-bucket
            type: string
        - in: query
          name: start_after
          schema:
            description: Bucket name to start searching after. Buckets are ordered lexicographically.
            example: my-bucket
            type: string
        - in: query
          name: per_page
          schema:
            default: 20
            description: Maximum number of buckets to return in a single call
            maximum: 1000
            minimum: 1
            type: number
        - in: query
          name: order
          schema:
            description: Field to order buckets by
            enum:
              - name
            type: string
        - in: query
          name: direction
          schema:
            description: Direction to order buckets
            enum:
              - asc
              - desc
            example: desc
            type: string
        - in: query
          name: cursor
          schema:
            description: Pagination cursor received during the last List Buckets call. R2 buckets are paginated using cursors instead of page numbers.
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: List Buckets response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response_list'
                  - properties:
                      result:
                        properties:
                          buckets:
                            items:
                              $ref: '#/components/schemas/r2_bucket'
                            type: array
                        type: object
                    type: object
          description: List Buckets response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform List Buckets
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.list
    post:
      description: Creates a new R2 bucket.
      operationId: r2-create-bucket
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example: '{"name": "example-bucket"}'
              properties:
                locationHint:
                  $ref: '#/components/schemas/r2_bucket_location'
                name:
                  $ref: '#/components/schemas/r2_bucket_name'
                storageClass:
                  $ref: '#/components/schemas/r2_storage_class'
              required:
                - name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: Create Bucket response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response'
                  - properties:
                      result:
                        $ref: '#/components/schemas/r2_bucket'
                    type: object
          description: Create Bucket response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Create Bucket
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.create
  /accounts/{account_id}/r2/buckets/{bucket_name}:
    delete:
      description: Deletes an existing R2 bucket.
      operationId: r2-delete-bucket
      parameters:
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_bucket_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: Delete Bucket response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response'
          description: Delete Bucket response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Delete Bucket
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.delete
    get:
      description: Gets metadata for an existing R2 bucket.
      operationId: r2-get-bucket
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_bucket_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: Get Bucket response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response'
                  - properties:
                      result:
                        $ref: '#/components/schemas/r2_bucket'
                    type: object
          description: Get Bucket response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Get Bucket
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.read
  /accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom:
    get:
      description: Gets a list of all custom domains registered with an existing R2 bucket.
      operationId: r2-list-custom-domains
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_bucket_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: List Custom Domains response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response'
                  - properties:
                      result:
                        $ref: '#/components/schemas/r2_list_custom_domains_response'
                    type: object
          description: List Custom Domains response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform List Custom Domains of Bucket
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.read
    post:
      description: Register a new custom domain for an existing R2 bucket.
      operationId: r2-add-custom-domain
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_bucket_name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/r2_add_custom_domain_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: Add Custom Domain response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response'
                  - properties:
                      result:
                        $ref: '#/components/schemas/r2_add_custom_domain_response'
                    type: object
          description: Add Custom Domain response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Attach Custom Domain To Bucket
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.write
  /accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom/{domain_name}:
    delete:
      description: Remove custom domain registration from an existing R2 bucket
      operationId: r2-delete-custom-domain
      parameters:
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_bucket_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
        - in: path
          name: domain_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_domain_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: Delete Custom Domain response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response'
                  - properties:
                      result:
                        $ref: '#/components/schemas/r2_remove_custom_domain_response'
                    type: object
          description: Delete Custom Domain response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Remove Custom Domain From Bucket
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.delete
    put:
      description: Edit the configuration for a custom domain on an existing R2 bucket.
      operationId: r2-edit-custom-domain-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_bucket_name'
        - in: path
          name: domain_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_domain_name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/r2_edit_custom_domain_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: Edit Custom Domain Configuration response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response'
                  - properties:
                      result:
                        allOf:
                          - $ref: '#/components/schemas/r2_edit_custom_domain_response'
                    type: object
          description: Edit Custom Domain Configuration response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Configure Custom Domain Settings
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.write
  /accounts/{account_id}/r2/buckets/{bucket_name}/domains/managed:
    get:
      description: Gets state of public access over the bucket's R2-managed (r2.dev) domain.
      operationId: r2-get-bucket-public-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_bucket_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: Get Managed Subdomain response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response'
                  - properties:
                      result:
                        $ref: '#/components/schemas/r2_managed_domain_response'
                    type: object
          description: Get Managed Subdomain response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Get r2.dev Domain of Bucket
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.read
    put:
      description: Updates state of public access over the bucket's R2-managed (r2.dev) domain.
      operationId: r2-put-bucket-public-policy
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_bucket_name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/r2_edit_managed_domain_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: Update Managed Subdomain response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response'
                  - properties:
                      result:
                        $ref: '#/components/schemas/r2_managed_domain_response'
                    type: object
          description: Update Managed Subdomain response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Update r2.dev Domain of Bucket
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.write
  /accounts/{account_id}/r2/buckets/{bucket_name}/sippy:
    delete:
      description: Disables Sippy on this bucket
      operationId: r2-delete-bucket-sippy-config
      parameters:
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_bucket_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: Delete Sippy Configuration response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response'
                  - properties:
                      result:
                        properties:
                          enabled:
                            enum:
                              - false
                            type: boolean
                        type: object
                    type: object
          description: Delete Sippy Configuration response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Disable Sippy
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.delete
    get:
      description: Gets configuration for Sippy for an existing R2 bucket.
      operationId: r2-get-bucket-sippy-config
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_bucket_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: Get Sippy Configuration response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response'
                  - properties:
                      result:
                        $ref: '#/components/schemas/r2_sippy'
                    type: object
          description: Get Sippy Configuration response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Get Sippy Configuration
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.read
    put:
      description: Sets configuration for Sippy for an existing R2 bucket.
      operationId: r2-put-bucket-sippy-config
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
        - in: path
          name: bucket_name
          required: true
          schema:
            $ref: '#/components/schemas/r2_bucket_name'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/r2_enable_sippy_aws'
                - $ref: '#/components/schemas/r2_enable_sippy_gcs'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: Get Sippy Configuration response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response'
                  - properties:
                      result:
                        $ref: '#/components/schemas/r2_sippy'
                    type: object
          description: Set Sippy Configuration response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Enable Sippy
      tags:
        - R2 Bucket
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.r2.bucket.write
  /accounts/{account_id}/r2/temp-access-credentials:
    post:
      description: Creates temporary access credentials on a bucket that can be optionally scoped to prefixes or objects.
      operationId: r2-create-temp-access-credentials
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/r2_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/r2_temp_access_creds_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2_v4_response_failure'
          description: Create temporary access credentials response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/r2_v4_response'
                  - properties:
                      result:
                        $ref: '#/components/schemas/r2_temp_access_creds_response'
                    type: object
          description: Create temporary access credentials response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Create Temporary Access Credentials
      tags:
        - R2 Bucket
  /accounts/{account_id}/registrar/domains:
    get:
      description: List domains handled by Registrar.
      operationId: registrar-domains-list-domains
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/registrar-api_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/registrar-api_domain_response_collection'
                  - $ref: '#/components/schemas/registrar-api_api-response-common-failure'
          description: List domains response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/registrar-api_domain_response_collection'
          description: List domains response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List domains
      tags:
        - Registrar Domains
  /accounts/{account_id}/registrar/domains/{domain_name}:
    get:
      description: Show individual domain.
      operationId: registrar-domains-get-domain
      parameters:
        - in: path
          name: domain_name
          required: true
          schema:
            $ref: '#/components/schemas/registrar-api_domain_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/registrar-api_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/registrar-api_domain_response_single'
                  - $ref: '#/components/schemas/registrar-api_api-response-common-failure'
          description: Get domain response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/registrar-api_domain_response_single'
          description: Get domain response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get domain
      tags:
        - Registrar Domains
    put:
      description: Update individual domain.
      operationId: registrar-domains-update-domain
      parameters:
        - in: path
          name: domain_name
          required: true
          schema:
            $ref: '#/components/schemas/registrar-api_domain_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/registrar-api_identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/registrar-api_domain_update_properties'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/registrar-api_domain_response_single'
                  - $ref: '#/components/schemas/registrar-api_api-response-common-failure'
          description: Update domain response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/registrar-api_domain_response_single'
          description: Update domain response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update domain
      tags:
        - Registrar Domains
  /accounts/{account_id}/request-tracer/trace:
    post:
      operationId: account-request-tracer-request-trace
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/request-tracer_identifier'
      requestBody:
        content:
          application/json:
            example:
              body:
                base64: c29tZV9yZXF1ZXN0X2JvZHk=
              context:
                geoloc:
                  city: London
                skip_challenge: true
              cookies:
                cookie_name_1: cookie_value_1
                cookie_name_2: cookie_value_2
              headers:
                header_name_1: header_value_1
                header_name_2: header_value_2
              method: PUT
              protocol: HTTP/1.1
              url: https://some.zone/some_path
            schema:
              properties:
                body:
                  properties:
                    base64:
                      description: Base64 encoded request body
                      example: c29tZV9yZXF1ZXN0X2JvZHk=
                      type: string
                    json:
                      description: Arbitrary json as request body
                      type: object
                    plain_text:
                      description: Request body as plain text
                      type: string
                  type: object
                context:
                  description: Additional request parameters
                  properties:
                    bot_score:
                      description: Bot score used for evaluating tracing request processing
                      type: integer
                    geoloc:
                      description: Geodata for tracing request
                      properties:
                        city:
                          example: London
                          type: string
                        continent:
                          type: string
                        is_eu_country:
                          type: boolean
                        iso_code:
                          type: string
                        latitude:
                          type: number
                        longitude:
                          type: number
                        postal_code:
                          type: string
                        region_code:
                          type: string
                        subdivision_2_iso_code:
                          type: string
                        timezone:
                          type: string
                      type: object
                    skip_challenge:
                      description: 'Whether to skip any challenges for tracing request (e.g.: captcha)'
                      example: true
                      type: boolean
                    threat_score:
                      description: Threat score used for evaluating tracing request processing
                      type: integer
                  type: object
                cookies:
                  additionalProperties:
                    type: string
                  description: Cookies added to tracing request
                  example:
                    cookie_name_1: cookie_value_1
                    cookie_name_2: cookie_value_2
                  type: object
                headers:
                  additionalProperties:
                    type: string
                  description: Headers added to tracing request
                  example:
                    header_name_1: header_value_1
                    header_name_2: header_value_2
                  type: object
                method:
                  description: HTTP Method of tracing request
                  example: PUT
                  type: string
                protocol:
                  description: HTTP Protocol of tracing request
                  example: HTTP/1.1
                  type: string
                skip_response:
                  description: Skip sending the request to the Origin server after all rules evaluation
                  type: boolean
                url:
                  description: URL to which perform tracing request
                  example: https://some.zone/some_path
                  type: string
              required:
                - url
                - method
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/request-tracer_api-response-common-failure'
          description: Request Trace response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/request-tracer_api-response-common'
                  - properties:
                      result:
                        description: Trace result with an origin status code
                        properties:
                          status_code:
                            description: HTTP Status code of zone response
                            type: integer
                          trace:
                            $ref: '#/components/schemas/request-tracer_trace'
                        type: object
                    type: object
                type: object
          description: Request Trace response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Request Trace
      tags:
        - Account Request Tracer
      x-api-token-group:
        - Allow Request Tracer Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/roles:
    get:
      description: Get all available roles for an account.
      operationId: account-roles-list-roles
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Roles response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_collection_role_response'
          description: List Roles response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Roles
      tags:
        - Account Roles
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
  /accounts/{account_id}/roles/{role_id}:
    get:
      description: Get information about a specific role for an account.
      operationId: account-roles-role-details
      parameters:
        - in: path
          name: role_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_role_components-schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Role Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_role_response'
          description: Role Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Role Details
      tags:
        - Account Roles
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
  /accounts/{account_id}/rules/lists:
    get:
      description: Fetches all lists in the account.
      operationId: lists-get-lists
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/lists_lists-response-collection'
                  - $ref: '#/components/schemas/lists_api-response-common-failure'
          description: Get lists response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_lists-response-collection'
          description: Get lists response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get lists
      tags:
        - Lists
      x-api-token-group:
        - Account Rule Lists Write
        - Account Rule Lists Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Creates a new list of the specified type.
      operationId: lists-create-a-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                description:
                  $ref: '#/components/schemas/lists_description'
                kind:
                  $ref: '#/components/schemas/lists_kind'
                name:
                  $ref: '#/components/schemas/lists_name'
              required:
                - name
                - kind
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/lists_list-response-collection'
                  - $ref: '#/components/schemas/lists_api-response-common-failure'
          description: Create a list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_list-response-collection'
          description: Create a list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a list
      tags:
        - Lists
      x-api-token-group:
        - Account Rule Lists Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rules/lists/{list_id}:
    delete:
      description: Deletes a specific list and all its items.
      operationId: lists-delete-a-list
      parameters:
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_list_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/lists_list-delete-response-collection'
                  - $ref: '#/components/schemas/lists_api-response-common-failure'
          description: Delete a list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_list-delete-response-collection'
          description: Delete a list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a list
      tags:
        - Lists
      x-api-token-group:
        - Account Rule Lists Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Fetches the details of a list.
      operationId: lists-get-a-list
      parameters:
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_list_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/lists_list-response-collection'
                  - $ref: '#/components/schemas/lists_api-response-common-failure'
          description: Get a list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_list-response-collection'
          description: Get a list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a list
      tags:
        - Lists
      x-api-token-group:
        - Account Rule Lists Write
        - Account Rule Lists Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Updates the description of a list.
      operationId: lists-update-a-list
      parameters:
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_list_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                description:
                  $ref: '#/components/schemas/lists_description'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/lists_list-response-collection'
                  - $ref: '#/components/schemas/lists_api-response-common-failure'
          description: Update a list response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_list-response-collection'
          description: Update a list response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a list
      tags:
        - Lists
      x-api-token-group:
        - Account Rule Lists Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rules/lists/{list_id}/items:
    delete:
      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](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`.
      operationId: lists-delete-list-items
      parameters:
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_list_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                items:
                  items:
                    properties:
                      id:
                        $ref: '#/components/schemas/lists_item_id'
                  minItems: 1
                  type: array
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/lists_lists-async-response'
                  - $ref: '#/components/schemas/lists_api-response-common-failure'
          description: Delete list items response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_lists-async-response'
          description: Delete list items response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete list items
      tags:
        - Lists
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Fetches all the items in the list.
      operationId: lists-get-list-items
      parameters:
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_list_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_identifier'
        - in: query
          name: cursor
          schema:
            description: The pagination cursor. An opaque string token indicating the position from which to continue when requesting the next/previous set of records. Cursor values are provided under `result_info.cursors` in the response. You should make no assumptions about a cursor's content or length.
            example: zzz
            type: string
        - in: query
          name: per_page
          schema:
            description: Amount of results to include in each paginated response. A non-negative 32 bit integer.
            maximum: 500
            minimum: 1
            type: integer
        - in: query
          name: search
          schema:
            description: 'A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.'
            example: 1.1.1.
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/lists_items-list-response-collection'
                  - $ref: '#/components/schemas/lists_api-response-common-failure'
          description: Get list items response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_items-list-response-collection'
          description: Get list items response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get list items
      tags:
        - Lists
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: |-
        Appends new items to the list.

        This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`.
      operationId: lists-create-list-items
      parameters:
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_list_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/lists_items-update-request-collection'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/lists_lists-async-response'
                  - $ref: '#/components/schemas/lists_api-response-common-failure'
          description: Create list items response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_lists-async-response'
          description: Create list items response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create list items
      tags:
        - Lists
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      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](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`.
      operationId: lists-update-all-list-items
      parameters:
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_list_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/lists_items-update-request-collection'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/lists_lists-async-response'
                  - $ref: '#/components/schemas/lists_api-response-common-failure'
          description: Update all list items response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_lists-async-response'
          description: Update all list items response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update all list items
      tags:
        - Lists
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets:
    get:
      description: Fetches all rulesets at the account level.
      operationId: listAccountRulesets
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Rulesets'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List account rulesets
      tags:
        - Account Rulesets
      x-api-token-group:
        - Account WAF Read
        - Account Rulesets Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Creates a ruleset at the account level.
      operationId: createAccountRuleset
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      requestBody:
        $ref: '#/components/requestBodies/rulesets_CreateRuleset'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create an account ruleset
      tags:
        - Account Rulesets
      x-api-token-group:
        - Mass URL Redirects Write
        - Magic Firewall Write
        - L4 DDoS Managed Ruleset Write
        - Transform Rules Write
        - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/{ruleset_id}:
    delete:
      description: Deletes all versions of an existing account ruleset.
      operationId: deleteAccountRuleset
      parameters:
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetId'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "204":
          $ref: '#/components/responses/rulesets_Empty'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an account ruleset
      tags:
        - Account Rulesets
      x-api-token-group:
        - Mass URL Redirects Write
        - Magic Firewall Write
        - L4 DDoS Managed Ruleset Write
        - Transform Rules Write
        - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Fetches the latest version of an account ruleset.
      operationId: getAccountRuleset
      parameters:
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetId'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an account ruleset
      tags:
        - Account Rulesets
      x-api-token-group:
        - Mass URL Redirects Write
        - Mass URL Redirects Read
        - Magic Firewall Write
        - Magic Firewall Read
        - L4 DDoS Managed Ruleset Write
        - L4 DDoS Managed Ruleset Read
        - Transform Rules Write
        - Transform Rules Read
        - Select Configuration Write
        - Select Configuration Read
        - Account WAF Read
        - Account Rulesets Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Updates an account ruleset, creating a new version.
      operationId: updateAccountRuleset
      parameters:
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetId'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      requestBody:
        $ref: '#/components/requestBodies/rulesets_UpdateRuleset'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an account ruleset
      tags:
        - Account Rulesets
      x-api-token-group:
        - Mass URL Redirects Write
        - Magic Firewall Write
        - L4 DDoS Managed Ruleset Write
        - Transform Rules Write
        - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/{ruleset_id}/rules:
    post:
      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 by default.
      operationId: createAccountRulesetRule
      parameters:
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetId'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      requestBody:
        $ref: '#/components/requestBodies/rulesets_Rule'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create an account ruleset rule
      tags:
        - Account Rulesets
      x-api-token-group:
        - Mass URL Redirects Write
        - Magic Firewall Write
        - L4 DDoS Managed Ruleset Write
        - Transform Rules Write
        - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}:
    delete:
      description: Deletes an existing rule from an account ruleset.
      operationId: deleteAccountRulesetRule
      parameters:
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RuleId'
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetId'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an account ruleset rule
      tags:
        - Account Rulesets
      x-api-token-group:
        - Mass URL Redirects Write
        - Magic Firewall Write
        - L4 DDoS Managed Ruleset Write
        - Transform Rules Write
        - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    patch:
      description: Updates an existing rule in an account ruleset.
      operationId: updateAccountRulesetRule
      parameters:
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RuleId'
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetId'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      requestBody:
        $ref: '#/components/requestBodies/rulesets_Rule'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an account ruleset rule
      tags:
        - Account Rulesets
      x-api-token-group:
        - Mass URL Redirects Write
        - Magic Firewall Write
        - L4 DDoS Managed Ruleset Write
        - Transform Rules Write
        - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/{ruleset_id}/versions:
    get:
      description: Fetches the versions of an account ruleset.
      operationId: listAccountRulesetVersions
      parameters:
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetId'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Rulesets'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List an account ruleset's versions
      tags:
        - Account Rulesets
      x-api-token-group:
        - Mass URL Redirects Write
        - Mass URL Redirects Read
        - Magic Firewall Write
        - Magic Firewall Read
        - L4 DDoS Managed Ruleset Write
        - L4 DDoS Managed Ruleset Read
        - Transform Rules Write
        - Transform Rules Read
        - Select Configuration Write
        - Select Configuration Read
        - Account WAF Read
        - Account Rulesets Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}:
    delete:
      description: Deletes an existing version of an account ruleset.
      operationId: deleteAccountRulesetVersion
      parameters:
        - in: path
          name: ruleset_version
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetVersion'
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetId'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "204":
          $ref: '#/components/responses/rulesets_Empty'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an account ruleset version
      tags:
        - Account Rulesets
      x-api-token-group:
        - Mass URL Redirects Write
        - Magic Firewall Write
        - L4 DDoS Managed Ruleset Write
        - Transform Rules Write
        - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Fetches a specific version of an account ruleset.
      operationId: getAccountRulesetVersion
      parameters:
        - in: path
          name: ruleset_version
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetVersion'
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetId'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an account ruleset version
      tags:
        - Account Rulesets
      x-api-token-group:
        - Mass URL Redirects Write
        - Mass URL Redirects Read
        - Magic Firewall Write
        - Magic Firewall Read
        - L4 DDoS Managed Ruleset Write
        - L4 DDoS Managed Ruleset Read
        - Transform Rules Write
        - Transform Rules Read
        - Select Configuration Write
        - Select Configuration Read
        - Account WAF Read
        - Account Rulesets Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}:
    get:
      description: Fetches the rules of a managed account ruleset version for a given tag.
      operationId: listAccountRulesetVersionRulesByTag
      parameters:
        - in: path
          name: rule_tag
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RuleCategory'
        - in: path
          name: ruleset_version
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetVersion'
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetId'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List an account ruleset version's rules by tag
      tags:
        - Account Rulesets
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint:
    get:
      description: Fetches the latest version of the account entry point ruleset for a given phase.
      operationId: getAccountEntrypointRuleset
      parameters:
        - in: path
          name: ruleset_phase
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetPhase'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an account entry point ruleset
      tags:
        - Account Rulesets
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Updates an account entry point ruleset, creating a new version.
      operationId: updateAccountEntrypointRuleset
      parameters:
        - in: path
          name: ruleset_phase
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetPhase'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      requestBody:
        $ref: '#/components/requestBodies/rulesets_UpdateEntrypointRuleset'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an account entry point ruleset
      tags:
        - Account Rulesets
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions:
    get:
      description: Fetches the versions of an account entry point ruleset.
      operationId: listAccountEntrypointRulesetVersions
      parameters:
        - in: path
          name: ruleset_phase
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetPhase'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Rulesets'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List an account entry point ruleset's versions
      tags:
        - Account Rulesets
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}:
    get:
      description: Fetches a specific version of an account entry point ruleset.
      operationId: getAccountEntrypointRulesetVersion
      parameters:
        - in: path
          name: ruleset_version
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetVersion'
        - in: path
          name: ruleset_phase
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_RulesetPhase'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        "200":
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
        - api_token: []
        - api_email: []
          api_key: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an account entry point ruleset version
      tags:
        - Account Rulesets
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rum/site_info:
    post:
      description: Creates a new Web Analytics site.
      operationId: web-analytics-create-site
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rum_create-site-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_site-response-single'
          description: Created Web Analytics site
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create a Web Analytics site
      tags:
        - Web Analytics
      x-api-token-group:
        - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rum/site_info/{site_id}:
    delete:
      description: Deletes an existing Web Analytics site.
      operationId: web-analytics-delete-site
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_site-tag-response-single'
          description: Deleted Web Analytics site identifier
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete a Web Analytics site
      tags:
        - Web Analytics
      x-api-token-group:
        - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Retrieves a Web Analytics site.
      operationId: web-analytics-get-site
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_site-response-single'
          description: Web Analytics site
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get a Web Analytics site
      tags:
        - Web Analytics
      x-api-token-group:
        - Account Settings Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Updates an existing Web Analytics site.
      operationId: web-analytics-update-site
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
        - in: path
          name: site_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rum_create-site-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_site-response-single'
          description: Updated Web Analytics site
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update a Web Analytics site
      tags:
        - Web Analytics
      x-api-token-group:
        - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rum/site_info/list:
    get:
      description: Lists all Web Analytics sites of an account.
      operationId: web-analytics-list-sites
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
        - in: query
          name: per_page
          schema:
            $ref: '#/components/schemas/rum_per_page'
        - in: query
          name: page
          schema:
            $ref: '#/components/schemas/rum_page'
        - in: query
          name: order_by
          schema:
            $ref: '#/components/schemas/rum_order_by'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_sites-response-collection'
          description: List of Web Analytics sites
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Web Analytics sites
      tags:
        - Web Analytics
      x-api-token-group:
        - Account Settings Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rum/v2/{ruleset_id}/rule:
    post:
      description: Creates a new rule in a Web Analytics ruleset.
      operationId: web-analytics-create-rule
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_ruleset_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rum_create-rule-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_rule-response-single'
          description: Created Web Analytics rule
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create a Web Analytics rule
      tags:
        - Web Analytics
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
  /accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}:
    delete:
      description: Deletes an existing rule from a Web Analytics ruleset.
      operationId: web-analytics-delete-rule
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_ruleset_identifier'
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_rule_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_rule-id-response-single'
          description: Deleted Web Analytics rule identifier
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete a Web Analytics rule
      tags:
        - Web Analytics
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
    put:
      description: Updates a rule in a Web Analytics ruleset.
      operationId: web-analytics-update-rule
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_ruleset_identifier'
        - in: path
          name: rule_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_rule_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rum_create-rule-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_rule-response-single'
          description: Updated Web Analytics rule
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update a Web Analytics rule
      tags:
        - Web Analytics
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
  /accounts/{account_id}/rum/v2/{ruleset_id}/rules:
    get:
      description: Lists all the rules in a Web Analytics ruleset.
      operationId: web-analytics-list-rules
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_ruleset_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_rules-response-collection'
          description: List of Web Analytics rules in the ruleset
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List rules in Web Analytics ruleset
      tags:
        - Web Analytics
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Modifies one or more rules in a Web Analytics ruleset with a single request.
      operationId: web-analytics-modify-rules
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_identifier'
        - in: path
          name: ruleset_id
          required: true
          schema:
            $ref: '#/components/schemas/rum_ruleset_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rum_modify-rules-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_api-response-common-failure'
          description: Failure response
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rum_rules-response-collection'
          description: List of modified Web Analytics rules
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update Web Analytics rules
      tags:
        - Web Analytics
      x-api-token-group:
        - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
  /accounts/{account_id}/secondary_dns/acls:
    get:
      description: List ACLs.
      operationId: secondary-dns-(-acl)-list-ac-ls
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_components-schemas-response_collection'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: List ACLs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_components-schemas-response_collection'
          description: List ACLs response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List ACLs
      tags:
        - Secondary DNS (ACL)
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Create ACL.
      operationId: secondary-dns-(-acl)-create-acl
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                ip_range:
                  $ref: '#/components/schemas/secondary-dns_ip_range'
                name:
                  $ref: '#/components/schemas/secondary-dns_acl_components-schemas-name'
              required:
                - name
                - ip_range
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Create ACL response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
          description: Create ACL response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create ACL
      tags:
        - Secondary DNS (ACL)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/secondary_dns/acls/{acl_id}:
    delete:
      description: Delete ACL.
      operationId: secondary-dns-(-acl)-delete-acl
      parameters:
        - in: path
          name: acl_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_components-schemas-id_response'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Delete ACL response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_components-schemas-id_response'
          description: Delete ACL response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete ACL
      tags:
        - Secondary DNS (ACL)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get ACL.
      operationId: secondary-dns-(-acl)-acl-details
      parameters:
        - in: path
          name: acl_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: ACL Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
          description: ACL Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform ACL Details
      tags:
        - Secondary DNS (ACL)
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Modify ACL.
      operationId: secondary-dns-(-acl)-update-acl
      parameters:
        - in: path
          name: acl_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/secondary-dns_acl'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Update ACL response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
          description: Update ACL response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update ACL
      tags:
        - Secondary DNS (ACL)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/secondary_dns/peers:
    get:
      description: List Peers.
      operationId: secondary-dns-(-peer)-list-peers
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_schemas-response_collection'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: List Peers response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_schemas-response_collection'
          description: List Peers response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Peers
      tags:
        - Secondary DNS (Peer)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:read'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Create Peer.
      operationId: secondary-dns-(-peer)-create-peer
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/secondary-dns_components-schemas-name'
              required:
                - name
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_schemas-single_response'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Create Peer response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_schemas-single_response'
          description: Create Peer response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Peer
      tags:
        - Secondary DNS (Peer)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/secondary_dns/peers/{peer_id}:
    delete:
      description: Delete Peer.
      operationId: secondary-dns-(-peer)-delete-peer
      parameters:
        - in: path
          name: peer_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_components-schemas-id_response'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Delete Peer response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_components-schemas-id_response'
          description: Delete Peer response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Peer
      tags:
        - Secondary DNS (Peer)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get Peer.
      operationId: secondary-dns-(-peer)-peer-details
      parameters:
        - in: path
          name: peer_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_schemas-single_response'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Peer Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_schemas-single_response'
          description: Peer Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Peer Details
      tags:
        - Secondary DNS (Peer)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:read'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Modify Peer.
      operationId: secondary-dns-(-peer)-update-peer
      parameters:
        - in: path
          name: peer_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/secondary-dns_peer'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_schemas-single_response'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Update Peer response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_schemas-single_response'
          description: Update Peer response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Peer
      tags:
        - Secondary DNS (Peer)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/secondary_dns/tsigs:
    get:
      description: List TSIGs.
      operationId: secondary-dns-(-tsig)-list-tsi-gs
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_response_collection'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: List TSIGs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_response_collection'
          description: List TSIGs response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List TSIGs
      tags:
        - Secondary DNS (TSIG)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:read'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Create TSIG.
      operationId: secondary-dns-(-tsig)-create-tsig
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/secondary-dns_tsig'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_single_response'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Create TSIG response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_single_response'
          description: Create TSIG response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create TSIG
      tags:
        - Secondary DNS (TSIG)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/secondary_dns/tsigs/{tsig_id}:
    delete:
      description: Delete TSIG.
      operationId: secondary-dns-(-tsig)-delete-tsig
      parameters:
        - in: path
          name: tsig_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_schemas-id_response'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Delete TSIG response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_schemas-id_response'
          description: Delete TSIG response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete TSIG
      tags:
        - Secondary DNS (TSIG)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get TSIG.
      operationId: secondary-dns-(-tsig)-tsig-details
      parameters:
        - in: path
          name: tsig_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_single_response'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: TSIG Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_single_response'
          description: TSIG Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform TSIG Details
      tags:
        - Secondary DNS (TSIG)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:read'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Modify TSIG.
      operationId: secondary-dns-(-tsig)-update-tsig
      parameters:
        - in: path
          name: tsig_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/secondary-dns_tsig'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/secondary-dns_single_response'
                  - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Update TSIG response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_single_response'
          description: Update TSIG response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update TSIG
      tags:
        - Secondary DNS (TSIG)
      x-cfPermissionsRequired:
        enum:
          - '#dns_records:edit'
          - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/storage/analytics:
    get:
      description: Retrieves Workers KV request metrics for the given account.
      operationId: workers-kv-request-analytics-query-request-analytics
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
        - in: query
          name: query
          schema:
            allOf:
              - $ref: '#/components/schemas/workers-kv_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
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/workers-kv_api-response-common'
                      - properties:
                          result:
                            $ref: '#/components/schemas/workers-kv_result'
                        type: object
                  - $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Query Request Analytics response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers-kv_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/workers-kv_schemas-result'
                    type: object
          description: Query Request Analytics response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Query Request Analytics
      tags:
        - Workers KV Request Analytics
      x-api-token-group:
        - Workers KV Storage Write
        - Workers KV Storage Read
  /accounts/{account_id}/storage/analytics/stored:
    get:
      description: Retrieves Workers KV stored data metrics for the given account.
      operationId: workers-kv-stored-data-analytics-query-stored-data-analytics
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
        - in: query
          name: query
          schema:
            allOf:
              - $ref: '#/components/schemas/workers-kv_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
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/workers-kv_api-response-common'
                      - properties:
                          result:
                            $ref: '#/components/schemas/workers-kv_result'
                        type: object
                  - $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Query Stored Data Analytics response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers-kv_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/workers-kv_components-schemas-result'
                    type: object
          description: Query Stored Data Analytics response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Query Stored Data Analytics
      tags:
        - Workers KV Stored Data Analytics
      x-api-token-group:
        - Workers KV Storage Write
        - Workers KV Storage Read
  /accounts/{account_id}/storage/kv/namespaces:
    get:
      description: Returns the namespaces owned by an account.
      operationId: workers-kv-namespace-list-namespaces
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 20
            description: Maximum number of results per page.
            maximum: 100
            minimum: 5
            type: number
        - in: query
          name: order
          schema:
            description: Field to order results by.
            enum:
              - id
              - title
            example: id
        - in: query
          name: direction
          schema:
            description: Direction to order namespaces.
            enum:
              - asc
              - desc
            example: asc
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: List Namespaces response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers-kv_api-response-collection'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/workers-kv_namespace'
                        type: array
                    type: object
          description: List Namespaces response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Namespaces
      tags:
        - Workers KV Namespace
      x-api-token-group:
        - Workers KV Storage Write
        - Workers KV Storage Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.namespace.list
    post:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers-kv_create_rename_namespace_body'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Create a Namespace response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers-kv_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/workers-kv_namespace'
                    type: object
          description: Create a Namespace response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a Namespace
      tags:
        - Workers KV Namespace
      x-api-token-group:
        - Workers KV Storage Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.namespace.create
  /accounts/{account_id}/storage/kv/namespaces/{namespace_id}:
    delete:
      description: Deletes the namespace corresponding to the given ID.
      operationId: workers-kv-namespace-remove-a-namespace
      parameters:
        - in: path
          name: namespace_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_namespace_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Remove a Namespace response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-no-result'
          description: Remove a Namespace response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Remove a Namespace
      tags:
        - Workers KV Namespace
      x-api-token-group:
        - Workers KV Storage Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.namespace.delete
    get:
      description: Get the namespace corresponding to the given ID.
      operationId: workers-kv-namespace-get-a-namespace
      parameters:
        - in: path
          name: namespace_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_namespace_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Get a Namespace response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers-kv_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/workers-kv_namespace'
                    type: object
          description: Get a Namespace response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a Namespace
      tags:
        - Workers KV Namespace
      x-api-token-group:
        - Workers KV Storage Write
        - Workers KV Storage Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.namespace.read
    put:
      description: Modifies a namespace's title.
      operationId: workers-kv-namespace-rename-a-namespace
      parameters:
        - in: path
          name: namespace_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_namespace_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers-kv_create_rename_namespace_body'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Rename a Namespace response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-no-result'
          description: Rename a Namespace response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Rename a Namespace
      tags:
        - Workers KV Namespace
      x-api-token-group:
        - Workers KV Storage Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.namespace.delete
  /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk:
    delete:
      deprecated: true
      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-deprecated
      parameters:
        - in: path
          name: namespace_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_namespace_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers-kv_bulk_delete'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Delete multiple key-value pairs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-no-result'
          description: Delete multiple key-value pairs response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete multiple key-value pairs
      tags:
        - Workers KV Namespace
      x-api-token-group:
        - Workers KV Storage Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.key.delete
    put:
      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:
        - in: path
          name: namespace_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_namespace_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers-kv_bulk_write'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Write multiple key-value pairs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-no-result'
          description: Write multiple key-value pairs response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Write multiple key-value pairs
      tags:
        - Workers KV Namespace
      x-api-token-group:
        - Workers KV Storage Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.key.update
  /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/delete:
    post:
      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:
        - in: path
          name: namespace_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_namespace_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers-kv_bulk_delete'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Delete multiple key-value pairs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-no-result'
          description: Delete multiple key-value pairs response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete multiple key-value pairs
      tags:
        - Workers KV Namespace
      x-api-token-group:
        - Workers KV Storage Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.key.delete
  /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/keys:
    get:
      description: Lists a namespace's keys.
      operationId: workers-kv-namespace-list-a-namespace'-s-keys
      parameters:
        - in: path
          name: namespace_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_namespace_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
        - in: query
          name: limit
          schema:
            default: 1000
            description: The number of keys to return. The cursor attribute may be used to iterate over the next batch of keys if there are more than the limit.
            maximum: 1000
            minimum: 10
            type: number
        - in: query
          name: prefix
          schema:
            description: A string prefix used to filter down which keys will be returned. Exact matches and any key names that begin with the prefix will be returned.
            example: My-Prefix
            type: string
        - in: query
          name: cursor
          schema:
            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
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: List a Namespace's Keys response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers-kv_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/workers-kv_key'
                        type: array
                      result_info:
                        properties:
                          count:
                            description: Total results returned based on your list parameters.
                            example: 1
                            type: number
                          cursor:
                            $ref: '#/components/schemas/workers-kv_cursor'
          description: List a Namespace's Keys response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List a Namespace's Keys
      tags:
        - Workers KV Namespace
      x-api-token-group:
        - Workers KV Storage Write
        - Workers KV Storage Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.key.list
  /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/metadata/{key_name}:
    get:
      description: Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name.
      operationId: workers-kv-namespace-read-the-metadata-for-a-key
      parameters:
        - in: path
          name: key_name
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_key_name'
        - in: path
          name: namespace_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_namespace_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Read the metadata for a key response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers-kv_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/workers-kv_list_metadata'
          description: Read the metadata for a key response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Read the metadata for a key
      tags:
        - Workers KV Namespace
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.key.read
  /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}:
    delete:
      description: Remove a KV pair from the namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name.
      operationId: workers-kv-namespace-delete-key-value-pair
      parameters:
        - in: path
          name: key_name
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_key_name'
        - in: path
          name: namespace_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_namespace_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Delete key-value pair response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-no-result'
          description: Delete key-value pair response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete key-value pair
      tags:
        - Workers KV Namespace
      x-api-token-group:
        - Workers KV Storage Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.key.delete
    get:
      description: Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) 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:
        - in: path
          name: key_name
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_key_name'
        - in: path
          name: namespace_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_namespace_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Read key-value pair response failure
        "200":
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/workers-kv_value'
          description: Read key-value pair response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Read key-value pair
      tags:
        - Workers KV Namespace
      x-api-token-group:
        - Workers KV Storage Write
        - Workers KV Storage Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.key.read
    put:
      description: Write a value identified by a key. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) 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:
        - in: path
          name: key_name
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_key_name'
        - in: path
          name: namespace_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_namespace_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers-kv_identifier'
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/workers-kv_value'
          multipart/form-data:
            schema:
              properties:
                metadata:
                  $ref: '#/components/schemas/workers-kv_metadata'
                value:
                  $ref: '#/components/schemas/workers-kv_value'
              required:
                - value
                - metadata
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-failure'
          description: Write key-value pair with metadata response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers-kv_api-response-common-no-result'
          description: Write key-value pair with metadata response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Write key-value pair with metadata
      tags:
        - Workers KV Namespace
      x-api-token-group:
        - Workers KV Storage Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.storage.kv.key.update
  /accounts/{account_id}/stream:
    get:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
        - in: query
          name: status
          schema:
            $ref: '#/components/schemas/stream_media_state'
        - in: query
          name: creator
          schema:
            $ref: '#/components/schemas/stream_creator'
        - in: query
          name: type
          schema:
            $ref: '#/components/schemas/stream_type'
        - in: query
          name: asc
          schema:
            $ref: '#/components/schemas/stream_asc'
        - in: query
          name: search
          schema:
            $ref: '#/components/schemas/stream_search'
        - in: query
          name: start
          schema:
            $ref: '#/components/schemas/stream_start'
        - in: query
          name: end
          schema:
            $ref: '#/components/schemas/stream_end'
        - in: query
          name: include_counts
          schema:
            $ref: '#/components/schemas/stream_include_counts'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: List videos response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_video_response_collection'
          description: List videos response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List videos
      tags:
        - Stream Videos
      x-api-token-group:
        - Stream Write
        - Stream Read
    post:
      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:
        - in: header
          name: Tus-Resumable
          required: true
          schema:
            $ref: '#/components/schemas/stream_tus_resumable'
        - in: header
          name: Upload-Creator
          schema:
            $ref: '#/components/schemas/stream_creator'
        - in: header
          name: Upload-Length
          required: true
          schema:
            $ref: '#/components/schemas/stream_upload_length'
        - in: header
          name: Upload-Metadata
          schema:
            $ref: '#/components/schemas/stream_upload_metadata'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json: {}
          description: Initiate video uploads using TUS response failure
        "200":
          content:
            application/json: {}
          description: Initiate video uploads using TUS response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Initiate video uploads using TUS
      tags:
        - Stream Videos
      x-api-token-group:
        - Stream Write
  /accounts/{account_id}/stream/{identifier}:
    delete:
      description: Deletes a video and its copies from Cloudflare Stream.
      operationId: stream-videos-delete-video
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json: {}
          description: Delete video response failure
        "200":
          content:
            application/json: {}
          description: Delete video response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete video
      tags:
        - Stream Videos
      x-api-token-group:
        - Stream Write
    get:
      description: Fetches details for a single video.
      operationId: stream-videos-retrieve-video-details
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Retrieve video details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_video_response_single'
          description: Retrieve video details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Retrieve video details
      tags:
        - Stream Videos
      x-api-token-group:
        - Stream Write
        - Stream Read
    post:
      description: Edit details for a single video.
      operationId: stream-videos-update-video-details
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_video_update'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Edit video details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_video_response_single'
          description: Edit video details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Edit video details
      tags:
        - Stream Videos
  /accounts/{account_id}/stream/{identifier}/audio:
    get:
      description: Lists additional audio tracks on a video. Note this API will not return information for audio attached to the video upload.
      operationId: list-audio-tracks
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Lists additional audio tracks on a video response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_listAudioTrackResponse'
          description: Lists additional audio tracks on a video
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List additional audio tracks on a video
      tags:
        - Stream Audio Tracks
  /accounts/{account_id}/stream/{identifier}/audio/{audio_identifier}:
    delete:
      description: Deletes additional audio tracks on a video. Deleting a default audio track is not allowed. You must assign another audio track as default prior to deletion.
      operationId: delete-audio-tracks
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: audio_identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_audio_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_deleted_response'
          description: Deletes additional audio tracks on a video response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_deleted_response'
          description: Deletes additional audio tracks on a video
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete additional audio tracks on a video
      tags:
        - Stream Audio Tracks
    patch:
      description: Edits additional audio tracks on a video. Editing the default status of an audio track to `true` will mark all other audio tracks on the video default status to `false`.
      operationId: edit-audio-tracks
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: audio_identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_audio_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_editAudioTrack'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Edits additional audio tracks on a video response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_addAudioTrackResponse'
          description: Edits additional audio tracks on a video
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Edit additional audio tracks on a video
      tags:
        - Stream Audio Tracks
  /accounts/{account_id}/stream/{identifier}/audio/copy:
    post:
      description: Adds an additional audio track to a video using the provided audio track URL.
      operationId: add-audio-track
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_copyAudioTrack'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Add audio tracks to a video response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_addAudioTrackResponse'
          description: Add audio tracks to a video
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Add audio tracks to a video
      tags:
        - Stream Audio Tracks
  /accounts/{account_id}/stream/{identifier}/captions:
    get:
      description: Lists the available captions or subtitles for a specific video.
      operationId: stream-subtitles/-captions-list-captions-or-subtitles
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: List captions or subtitles response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_language_response_collection'
          description: List captions or subtitles response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List captions or subtitles
      tags:
        - Stream Subtitles/Captions
  /accounts/{account_id}/stream/{identifier}/captions/{language}:
    delete:
      description: Removes the captions or subtitles from a video.
      operationId: stream-subtitles/-captions-delete-captions-or-subtitles
      parameters:
        - in: path
          name: language
          required: true
          schema:
            $ref: '#/components/schemas/stream_language'
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Delete captions or subtitles response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/stream_api-response-common'
                  - properties:
                      result:
                        example: ""
                        type: string
          description: Delete captions or subtitles response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete captions or subtitles
      tags:
        - Stream Subtitles/Captions
    get:
      description: Lists the captions or subtitles for provided language.
      operationId: stream-subtitles/-captions-get-caption-or-subtitle-for-language
      parameters:
        - in: path
          name: language
          required: true
          schema:
            $ref: '#/components/schemas/stream_language'
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: List captions or subtitles response for a provided language
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_language_response_single'
          description: List captions or subtitles response for a provided language
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List captions or subtitles for a provided language
      tags:
        - Stream Subtitles/Captions
    put:
      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:
        - in: path
          name: language
          required: true
          schema:
            $ref: '#/components/schemas/stream_language'
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/stream_caption_basic_upload'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Upload captions or subtitles response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_language_response_single'
          description: Upload captions or subtitles response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Upload captions or subtitles
      tags:
        - Stream Subtitles/Captions
  /accounts/{account_id}/stream/{identifier}/captions/{language}/generate:
    post:
      description: Generate captions or subtitles for provided language via AI.
      operationId: stream-subtitles/-captions-generate-caption-or-subtitle-for-language
      parameters:
        - in: path
          name: language
          required: true
          schema:
            $ref: '#/components/schemas/stream_language'
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Generate captions or subtitles response for a provided language
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_language_response_single'
          description: Generate captions or subtitles response for a provided language
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Generate captions or subtitles for a provided language via AI
      tags:
        - Stream Subtitles/Captions
  /accounts/{account_id}/stream/{identifier}/captions/{language}/vtt:
    get:
      description: Return WebVTT captions for a provided language.
      operationId: stream-subtitles/-captions-get-vtt-caption-or-subtitle
      parameters:
        - in: path
          name: language
          required: true
          schema:
            $ref: '#/components/schemas/stream_language'
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Return WebVTT caption or subtitle response failure
        "200":
          content:
            text/vtt:
              schema:
                example: |
                  'WEBVTT
                   00:00:00.000 --> 00:00:02.480
                   This is example response'
                type: string
          description: Return WebVTT caption or subtitle response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Return WebVTT captions for a provided language
      tags:
        - Stream Subtitles/Captions
  /accounts/{account_id}/stream/{identifier}/downloads:
    delete:
      description: Delete the downloads for a video.
      operationId: stream-m-p-4-downloads-delete-downloads
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Delete downloads response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_deleted_response'
          description: Delete downloads response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete downloads
      tags:
        - Stream MP4 Downloads
    get:
      description: Lists the downloads created for a video.
      operationId: stream-m-p-4-downloads-list-downloads
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: List downloads response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_downloads_response'
          description: List downloads response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List downloads
      tags:
        - Stream MP4 Downloads
    post:
      description: Creates a download for a video when a video is ready to view.
      operationId: stream-m-p-4-downloads-create-downloads
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Create downloads response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_downloads_response'
          description: Create downloads response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create downloads
      tags:
        - Stream MP4 Downloads
  /accounts/{account_id}/stream/{identifier}/embed:
    get:
      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:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Retreieve embed Code HTML response failure
        "200":
          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>
          description: Retreieve embed Code HTML response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Retrieve embed Code HTML
      tags:
        - Stream Videos
  /accounts/{account_id}/stream/{identifier}/token:
    post:
      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-videos
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_signed_token_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Create signed URL tokens for videos response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_signed_token_response'
          description: Create signed URL tokens for videos response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create signed URL tokens for videos
      tags:
        - Stream Videos
  /accounts/{account_id}/stream/clip:
    post:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_videoClipStandard'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Clip videos given a start and end time response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_clipResponseSingle'
          description: Clip videos given a start and end time response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Clip videos given a start and end time
      tags:
        - Stream Video Clipping
  /accounts/{account_id}/stream/copy:
    post:
      description: Uploads a video to Stream from a provided URL.
      operationId: stream-videos-upload-videos-from-a-url
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
        - in: header
          name: Upload-Creator
          schema:
            $ref: '#/components/schemas/stream_creator'
        - in: header
          name: Upload-Metadata
          schema:
            $ref: '#/components/schemas/stream_upload_metadata'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_video_copy_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Upload videos from a URL response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_video_response_single'
          description: Upload videos from a URL response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Upload videos from a URL
      tags:
        - Stream Videos
  /accounts/{account_id}/stream/direct_upload:
    post:
      description: Creates a direct upload that allows video uploads without an API key.
      operationId: stream-videos-upload-videos-via-direct-upload-ur-ls
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
        - in: header
          name: Upload-Creator
          schema:
            $ref: '#/components/schemas/stream_creator'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_direct_upload_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Upload videos via direct upload URLs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_direct_upload_response'
          description: Upload videos via direct upload URLs response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Upload videos via direct upload URLs
      tags:
        - Stream Videos
  /accounts/{account_id}/stream/keys:
    get:
      description: Lists the video ID and creation date and time when a signing key was created.
      operationId: stream-signing-keys-list-signing-keys
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: List signing keys response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_key_response_collection'
          description: List signing keys response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List signing keys
      tags:
        - Stream Signing Keys
      x-api-token-group:
        - Stream Write
        - Stream Read
    post:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Create signing keys response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_key_generation_response'
          description: Create signing keys response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create signing keys
      tags:
        - Stream Signing Keys
      x-api-token-group:
        - Stream Write
  /accounts/{account_id}/stream/keys/{identifier}:
    delete:
      description: Deletes signing keys and revokes all signed URLs generated with the key.
      operationId: stream-signing-keys-delete-signing-keys
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Delete signing keys response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_deleted_response'
          description: Delete signing keys response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete signing keys
      tags:
        - Stream Signing Keys
      x-api-token-group:
        - Stream Write
  /accounts/{account_id}/stream/live_inputs:
    get:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
        - in: query
          name: include_counts
          schema:
            $ref: '#/components/schemas/stream_include_counts'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: List live inputs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_live_input_response_collection'
          description: List live inputs response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List live inputs
      tags:
        - Stream Live Inputs
      x-api-token-group:
        - Stream Write
        - Stream Read
    post:
      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:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_create_input_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Create a live input response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_live_input_response_single'
          description: Create a live input response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create a live input
      tags:
        - Stream Live Inputs
      x-api-token-group:
        - Stream Write
  /accounts/{account_id}/stream/live_inputs/{live_input_identifier}:
    delete:
      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:
        - in: path
          name: live_input_identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_live_input_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json: {}
          description: Delete a live input response failure
        "200":
          content:
            application/json: {}
          description: Delete a live input response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete a live input
      tags:
        - Stream Live Inputs
      x-api-token-group:
        - Stream Write
    get:
      description: Retrieves details of an existing live input.
      operationId: stream-live-inputs-retrieve-a-live-input
      parameters:
        - in: path
          name: live_input_identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_live_input_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Retrieve a live input response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_live_input_response_single'
          description: Retrieve a live input response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Retrieve a live input
      tags:
        - Stream Live Inputs
      x-api-token-group:
        - Stream Write
        - Stream Read
    put:
      description: Updates a specified live input.
      operationId: stream-live-inputs-update-a-live-input
      parameters:
        - in: path
          name: live_input_identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_live_input_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_update_input_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Update a live input response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_live_input_response_single'
          description: Update a live input response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update a live input
      tags:
        - Stream Live Inputs
      x-api-token-group:
        - Stream Write
  /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs:
    get:
      description: Retrieves all outputs associated with a specified live input.
      operationId: stream-live-inputs-list-all-outputs-associated-with-a-specified-live-input
      parameters:
        - in: path
          name: live_input_identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_live_input_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: List all outputs associated with a specified live input response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_output_response_collection'
          description: List all outputs associated with a specified live input response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List all outputs associated with a specified live input
      tags:
        - Stream Live Inputs
    post:
      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:
        - in: path
          name: live_input_identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_live_input_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_create_output_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Create a new output, connected to a live input response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_output_response_single'
          description: Create a new output, connected to a live input response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create a new output, connected to a live input
      tags:
        - Stream Live Inputs
  /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}:
    delete:
      description: Deletes an output and removes it from the associated live input.
      operationId: stream-live-inputs-delete-an-output
      parameters:
        - in: path
          name: output_identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_output_identifier'
        - in: path
          name: live_input_identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_live_input_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json: {}
          description: Delete an output response failure
        "200":
          content:
            application/json: {}
          description: Delete an output response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete an output
      tags:
        - Stream Live Inputs
    put:
      description: Updates the state of an output.
      operationId: stream-live-inputs-update-an-output
      parameters:
        - in: path
          name: output_identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_output_identifier'
        - in: path
          name: live_input_identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_live_input_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_update_output_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Update an output response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_output_response_single'
          description: Update an output response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update an output
      tags:
        - Stream Live Inputs
  /accounts/{account_id}/stream/storage-usage:
    get:
      description: Returns information about an account's storage use.
      operationId: stream-videos-storage-usage
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
        - in: query
          name: creator
          schema:
            $ref: '#/components/schemas/stream_creator'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Returns information about an account's storage use response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_storage_use_response'
          description: Returns information about an account's storage use response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Storage use
      tags:
        - Stream Videos
  /accounts/{account_id}/stream/watermarks:
    get:
      description: Lists all watermark profiles for an account.
      operationId: stream-watermark-profile-list-watermark-profiles
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: List watermark profiles response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_watermark_response_collection'
          description: List watermark profiles response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List watermark profiles
      tags:
        - Stream Watermark Profile
      x-api-token-group:
        - Stream Write
        - Stream Read
    post:
      description: Creates watermark profiles using a single `HTTP POST multipart/form-data` request.
      operationId: stream-watermark-profile-create-watermark-profiles-via-basic-upload
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/stream_watermark_basic_upload'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Create watermark profiles via basic upload response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_watermark_response_single'
          description: Create watermark profiles via basic upload response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create watermark profiles via basic upload
      tags:
        - Stream Watermark Profile
      x-api-token-group:
        - Stream Write
  /accounts/{account_id}/stream/watermarks/{identifier}:
    delete:
      description: Deletes a watermark profile.
      operationId: stream-watermark-profile-delete-watermark-profiles
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_watermark_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Delete watermark profiles response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/stream_api-response-single'
                  - properties:
                      result:
                        example: ""
                        type: string
          description: Delete watermark profiles response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete watermark profiles
      tags:
        - Stream Watermark Profile
      x-api-token-group:
        - Stream Write
    get:
      description: Retrieves details for a single watermark profile.
      operationId: stream-watermark-profile-watermark-profile-details
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/stream_watermark_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Watermark profile details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_watermark_response_single'
          description: Watermark profile details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Watermark profile details
      tags:
        - Stream Watermark Profile
      x-api-token-group:
        - Stream Write
        - Stream Read
  /accounts/{account_id}/stream/webhook:
    delete:
      description: Deletes a webhook.
      operationId: stream-webhook-delete-webhooks
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Delete webhooks response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_deleted_response'
          description: Delete webhooks response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete webhooks
      tags:
        - Stream Webhook
      x-api-token-group:
        - Stream Write
    get:
      description: Retrieves a list of webhooks.
      operationId: stream-webhook-view-webhooks
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: View webhooks response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_webhook_response_single'
          description: View webhooks response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform View webhooks
      tags:
        - Stream Webhook
      x-api-token-group:
        - Stream Write
        - Stream Read
    put:
      description: Creates a webhook notification.
      operationId: stream-webhook-create-webhooks
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/stream_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stream_webhook_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_api-response-common-failure'
          description: Create webhooks response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_webhook_response_single'
          description: Create webhooks response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create webhooks
      tags:
        - Stream Webhook
      x-api-token-group:
        - Stream Write
  /accounts/{account_id}/subscriptions:
    get:
      description: Lists all of an account's subscriptions.
      operationId: account-subscriptions-list-subscriptions
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/bill-subs-api_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/bill-subs-api_account_subscription_response_collection'
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: List Subscriptions response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_account_subscription_response_collection'
          description: List Subscriptions response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Subscriptions
      tags:
        - Account Subscriptions
      x-api-token-group:
        - Billing Write
        - Billing Read
      x-cfPermissionsRequired:
        enum:
          - '#billing:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Creates an account subscription.
      operationId: account-subscriptions-create-subscription
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/bill-subs-api_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bill-subs-api_subscription-v2'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/bill-subs-api_account_subscription_response_single'
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Create Subscription response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_account_subscription_response_single'
          description: Create Subscription response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create Subscription
      tags:
        - Account Subscriptions
      x-api-token-group:
        - Billing Write
      x-cfPermissionsRequired:
        enum:
          - '#billing:read'
          - '#billing:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/subscriptions/{subscription_identifier}:
    delete:
      description: Deletes an account's subscription.
      operationId: account-subscriptions-delete-subscription
      parameters:
        - in: path
          name: subscription_identifier
          required: true
          schema:
            $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/bill-subs-api_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/bill-subs-api_api-response-single'
                      - properties:
                          result:
                            properties:
                              subscription_id:
                                $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
                            type: object
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Delete Subscription response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/bill-subs-api_api-response-single'
                  - properties:
                      result:
                        properties:
                          subscription_id:
                            $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
                        type: object
          description: Delete Subscription response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete Subscription
      tags:
        - Account Subscriptions
      x-api-token-group:
        - Billing Write
      x-cfPermissionsRequired:
        enum:
          - '#billing:edit'
    put:
      description: Updates an account subscription.
      operationId: account-subscriptions-update-subscription
      parameters:
        - in: path
          name: subscription_identifier
          required: true
          schema:
            $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/bill-subs-api_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bill-subs-api_subscription-v2'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/bill-subs-api_account_subscription_response_single'
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Update Subscription response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_account_subscription_response_single'
          description: Update Subscription response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update Subscription
      tags:
        - Account Subscriptions
      x-api-token-group:
        - Billing Write
      x-cfPermissionsRequired:
        enum:
          - '#billing:read'
          - '#billing:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/teamnet/routes:
    get:
      description: Lists and filters private network routes in an account.
      operationId: tunnel-route-list-tunnel-routes
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: query
          name: comment
          schema:
            $ref: '#/components/schemas/tunnel_comment'
        - in: query
          name: is_deleted
          schema:
            description: If `true`, only include deleted routes. If `false`, exclude deleted routes. If empty, all routes will be included.
            type: boolean
        - in: query
          name: network_subset
          schema:
            allOf:
              - $ref: '#/components/schemas/tunnel_ip_network'
            description: If set, only list routes that are contained within this IP range.
        - in: query
          name: network_superset
          schema:
            allOf:
              - $ref: '#/components/schemas/tunnel_ip_network'
            description: If set, only list routes that contain this IP range.
        - in: query
          name: existed_at
          schema:
            $ref: '#/components/schemas/tunnel_existed_at'
        - in: query
          name: tunnel_id
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
        - in: query
          name: route_id
          schema:
            $ref: '#/components/schemas/tunnel_route_id'
        - in: query
          name: tun_types
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_types'
        - in: query
          name: virtual_network_id
          schema:
            $ref: '#/components/schemas/tunnel_virtual_network_id'
        - in: query
          name: per_page
          schema:
            $ref: '#/components/schemas/tunnel_per_page'
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_teamnet_response_collection'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: List tunnel routes response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_teamnet_response_collection'
          description: List tunnel routes response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform List tunnel routes
      tags:
        - Tunnel Routing
      x-api-token-group:
        - Cloudflare One Networks Write
        - Cloudflare One Networks Read
        - Argo Tunnel Write
        - Argo Tunnel Read
    post:
      description: Routes a private network through a Cloudflare Tunnel.
      operationId: tunnel-route-create-a-tunnel-route
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                comment:
                  $ref: '#/components/schemas/tunnel_comment'
                network:
                  $ref: '#/components/schemas/tunnel_ip_network'
                tunnel_id:
                  $ref: '#/components/schemas/tunnel_tunnel_id'
                virtual_network_id:
                  $ref: '#/components/schemas/tunnel_virtual_network_id'
              required:
                - network
                - tunnel_id
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_route_response_single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Create a tunnel route response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Create a tunnel route response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Create a tunnel route
      tags:
        - Tunnel Routing
      x-api-token-group:
        - Cloudflare One Networks Write
        - Argo Tunnel Write
  /accounts/{account_id}/teamnet/routes/{route_id}:
    delete:
      description: |
        Deletes a private network route from an account.
      operationId: tunnel-route-delete-a-tunnel-route
      parameters:
        - in: path
          name: route_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_route_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_route_response_single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Delete a tunnel route response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Delete a tunnel route response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Delete a tunnel route
      tags:
        - Tunnel Routing
      x-api-token-group:
        - Cloudflare One Networks Write
        - Argo Tunnel Write
    get:
      description: Get a private network route in an account.
      operationId: tunnel-route-get-tunnel-route
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: route_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_route_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_route_response_single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get a tunnel route response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Get a tunnel route response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get tunnel route
      tags:
        - Tunnel Routing
    patch:
      description: Updates an existing private network route in an account. The fields that are meant to be updated should be provided in the body of the request.
      operationId: tunnel-route-update-a-tunnel-route
      parameters:
        - in: path
          name: route_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_route_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                comment:
                  $ref: '#/components/schemas/tunnel_comment'
                network:
                  $ref: '#/components/schemas/tunnel_ip_network'
                tunnel_id:
                  $ref: '#/components/schemas/tunnel_tunnel_id'
                virtual_network_id:
                  $ref: '#/components/schemas/tunnel_virtual_network_id'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_route_response_single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Update a tunnel route response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Update a tunnel route response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Update a tunnel route
      tags:
        - Tunnel Routing
      x-api-token-group:
        - Cloudflare One Networks Write
        - Argo Tunnel Write
  /accounts/{account_id}/teamnet/routes/ip/{ip}:
    get:
      description: Fetches routes that contain the given IP address.
      operationId: tunnel-route-get-tunnel-route-by-ip
      parameters:
        - in: path
          name: ip
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_ip'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: query
          name: virtual_network_id
          schema:
            $ref: '#/components/schemas/tunnel_virtual_network_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_teamnet_response_single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get tunnel route by IP response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_teamnet_response_single'
          description: Get tunnel route by IP response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get tunnel route by IP
      tags:
        - Tunnel Routing
  /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}:
    delete:
      deprecated: true
      description: |
        Deletes a private network route from an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format. If no virtual_network_id is provided it will delete the route from the default vnet. If no tun_type is provided it will fetch the type from the tunnel_id or if that is missing it will assume Cloudflare Tunnel as default. If tunnel_id is provided it will delete the route from that tunnel, otherwise it will delete the route based on the vnet and tun_type.
      operationId: tunnel-route-delete-a-tunnel-route-with-cidr
      parameters:
        - in: path
          name: ip_network_encoded
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_ip_network_encoded'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: query
          name: virtual_network_id
          schema:
            $ref: '#/components/schemas/tunnel_virtual_network_id'
        - in: query
          name: tun_type
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_type'
        - in: query
          name: tunnel_id
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_route_response_single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Delete a tunnel route response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Delete a tunnel route response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Delete a tunnel route (CIDR Endpoint)
      tags:
        - Tunnel Routing
      x-api-token-group:
        - Cloudflare One Networks Write
        - Argo Tunnel Write
      x-cfDeprecation:
        description: This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs.
        display: true
        eol: "2025-09-30"
        id: teamnet_routes_with_cidr_deprecation
    patch:
      deprecated: true
      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-with-cidr
      parameters:
        - in: path
          name: ip_network_encoded
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_ip_network_encoded'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_route_response_single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Update a tunnel route response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Update a tunnel route response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Update a tunnel route (CIDR Endpoint)
      tags:
        - Tunnel Routing
      x-api-token-group:
        - Cloudflare One Networks Write
        - Argo Tunnel Write
      x-cfDeprecation:
        description: This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs.
        display: true
        eol: "2025-09-30"
        id: teamnet_routes_with_cidr_deprecation
    post:
      deprecated: true
      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-with-cidr
      parameters:
        - in: path
          name: ip_network_encoded
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_ip_network_encoded'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                comment:
                  $ref: '#/components/schemas/tunnel_comment'
                tunnel_id:
                  $ref: '#/components/schemas/tunnel_tunnel_id'
                virtual_network_id:
                  $ref: '#/components/schemas/tunnel_virtual_network_id'
              required:
                - tunnel_id
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_route_response_single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Create a tunnel route response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_route_response_single'
          description: Create a tunnel route response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Create a tunnel route (CIDR Endpoint)
      tags:
        - Tunnel Routing
      x-api-token-group:
        - Cloudflare One Networks Write
        - Argo Tunnel Write
      x-cfDeprecation:
        description: This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs.
        display: true
        eol: "2025-09-30"
        id: teamnet_routes_with_cidr_deprecation
  /accounts/{account_id}/teamnet/virtual_networks:
    get:
      description: Lists and filters virtual networks in an account.
      operationId: tunnel-virtual-network-list-virtual-networks
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: query
          name: id
          schema:
            $ref: '#/components/schemas/tunnel_virtual_network_id'
        - in: query
          name: name
          schema:
            $ref: '#/components/schemas/tunnel_virtual_network_name'
        - in: query
          name: is_default
          schema:
            description: If `true`, only include the default virtual network. If `false`, exclude the default virtual network. If empty, all virtual networks will be included.
            type: boolean
        - in: query
          name: is_deleted
          schema:
            description: If `true`, only include deleted virtual networks. If `false`, exclude deleted virtual networks. If empty, all virtual networks will be included.
            type: boolean
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_vnet_response_collection'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: List virtual networks response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_vnet_response_collection'
          description: List virtual networks response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform List virtual networks
      tags:
        - Tunnel Virtual Network
      x-api-token-group:
        - Cloudflare One Networks Write
        - Cloudflare One Networks Read
        - Argo Tunnel Write
        - Argo Tunnel Read
    post:
      description: Adds a new virtual network to an account.
      operationId: tunnel-virtual-network-create-a-virtual-network
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                comment:
                  $ref: '#/components/schemas/tunnel_virtual_network_comment'
                is_default:
                  $ref: '#/components/schemas/tunnel_is_default_network'
                name:
                  $ref: '#/components/schemas/tunnel_virtual_network_name'
              required:
                - name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_vnet_response_single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Create a virtual network response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_vnet_response_single'
          description: Create a virtual network response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Create a virtual network
      tags:
        - Tunnel Virtual Network
      x-api-token-group:
        - Cloudflare One Networks Write
        - Argo Tunnel Write
  /accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}:
    delete:
      description: Deletes an existing virtual network.
      operationId: tunnel-virtual-network-delete
      parameters:
        - in: path
          name: virtual_network_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_virtual_network_id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_vnet_response_single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Delete a virtual network response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_vnet_response_single'
          description: Delete a virtual network response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Delete a virtual network
      tags:
        - Tunnel Virtual Network
      x-api-token-group:
        - Cloudflare One Networks Write
        - Argo Tunnel Write
    get:
      description: Get a virtual network.
      operationId: tunnel-virtual-network-get
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: virtual_network_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_virtual_network_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                comment:
                  $ref: '#/components/schemas/tunnel_virtual_network_comment'
                is_default_network:
                  $ref: '#/components/schemas/tunnel_is_default_network'
                name:
                  $ref: '#/components/schemas/tunnel_virtual_network_name'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_vnet_response_single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: A virtual network response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_vnet_response_single'
          description: A virtual network response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get a virtual network
      tags:
        - Tunnel Virtual Network
    patch:
      description: Updates an existing virtual network.
      operationId: tunnel-virtual-network-update
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: virtual_network_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_virtual_network_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                comment:
                  $ref: '#/components/schemas/tunnel_virtual_network_comment'
                is_default_network:
                  $ref: '#/components/schemas/tunnel_is_default_network'
                name:
                  $ref: '#/components/schemas/tunnel_virtual_network_name'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_vnet_response_single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Update a virtual network response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_vnet_response_single'
          description: Update a virtual network response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Update a virtual network
      tags:
        - Tunnel Virtual Network
      x-api-token-group:
        - Cloudflare One Networks Write
        - Argo Tunnel Write
  /accounts/{account_id}/tunnels:
    get:
      description: Lists and filters all types of Tunnels in an account.
      operationId: cloudflare-tunnel-list-all-tunnels
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: query
          name: name
          schema:
            description: A user-friendly name for the tunnel.
            example: blog
            type: string
        - in: query
          name: is_deleted
          schema:
            description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.
            example: true
            type: boolean
        - in: query
          name: existed_at
          schema:
            $ref: '#/components/schemas/tunnel_existed_at'
        - in: query
          name: uuid
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
        - in: query
          name: was_active_at
          schema:
            example: "2009-11-10T23:00:00Z"
            format: date-time
            type: string
        - in: query
          name: was_inactive_at
          schema:
            example: "2009-11-10T23:00:00Z"
            format: date-time
            type: string
        - in: query
          name: include_prefix
          schema:
            example: vpc1-
            type: string
        - in: query
          name: exclude_prefix
          schema:
            example: vpc1-
            type: string
        - in: query
          name: tun_types
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_types'
        - in: query
          name: status
          schema:
            $ref: '#/components/schemas/tunnel_status'
        - in: query
          name: per_page
          schema:
            $ref: '#/components/schemas/tunnel_per_page'
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel-response-collection'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: List Tunnels response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-collection'
          description: List Tunnels response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform List All Tunnels
      tags:
        - Cloudflare Tunnel
      x-api-token-group:
        - Cloudflare One Connectors Write
        - Cloudflare One Connectors Read
        - Cloudflare One cloudflared Connectors Write
        - Cloudflare One cloudflared Connectors Read
        - Argo Tunnel Write
        - Argo Tunnel Read
  /accounts/{account_id}/vectorize/indexes:
    get:
      deprecated: true
      description: Returns a list of Vectorize Indexes
      operationId: vectorize-(-deprecated)-list-vectorize-indexes
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: List Vectorize Index Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/vectorize_create-index-response'
                        type: array
          description: List Vectorize Index Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Vectorize Indexes (Deprecated)
      tags:
        - Vectorize Beta (Deprecated)
      x-api-token-group:
        - Vectorize Write
        - Vectorize Read
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the GET `/accounts/{account_id}/vectorize/v2/indexes` endpoint.
        display: true
        id: vectorize_list_index_deprecation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.list
    post:
      deprecated: true
      description: Creates and returns a new Vectorize Index.
      operationId: vectorize-(-deprecated)-create-vectorize-index
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_create-index-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Create Vectorize Index Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_create-index-response'
          description: Create Vectorize Index Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Vectorize Index (Deprecated)
      tags:
        - Vectorize Beta (Deprecated)
      x-api-token-group:
        - Vectorize Write
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes` endpoint.
        display: true
        id: vectorize_create_index_deprecation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.create
  /accounts/{account_id}/vectorize/indexes/{index_name}:
    delete:
      deprecated: true
      description: Deletes the specified Vectorize Index.
      operationId: vectorize-(-deprecated)-delete-vectorize-index
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Delete Vectorize Index Failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
          description: Delete Vectorize Index Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Vectorize Index (Deprecated)
      tags:
        - Vectorize Beta (Deprecated)
      x-api-token-group:
        - Vectorize Write
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the DELETE `/accounts/{account_id}/vectorize/v2/indexes/{index_name}` endpoint.
        display: true
        id: vectorize_delete_index_deprecation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.delete
    get:
      deprecated: true
      description: Returns the specified Vectorize Index.
      operationId: vectorize-(-deprecated)-get-vectorize-index
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Get Vectorize Index Failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_create-index-response'
          description: Get Vectorize Index Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Vectorize Index (Deprecated)
      tags:
        - Vectorize Beta (Deprecated)
      x-api-token-group:
        - Vectorize Write
        - Vectorize Read
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the GET `/accounts/{account_id}/vectorize/v2/indexes/{index_name}` endpoint.
        display: true
        id: vectorize_get_index_deprecation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.read
    put:
      deprecated: true
      description: Updates and returns the specified Vectorize Index.
      operationId: vectorize-(-deprecated)-update-vectorize-index
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_update-index-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Update Vectorize Index Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_create-index-response'
          description: Update Vectorize Index Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Vectorize Index (Deprecated)
      tags:
        - Vectorize Beta (Deprecated)
      x-api-token-group:
        - Vectorize Write
      x-cfDeprecation:
        description: This endpoint has been deprecated and will soon be removed.
        display: true
        id: vectorize_update_index_deprecation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.update
  /accounts/{account_id}/vectorize/indexes/{index_name}/delete-by-ids:
    post:
      deprecated: true
      description: Delete a set of vectors from an index by their vector identifiers.
      operationId: vectorize-(-deprecated)-delete-vectors-by-id
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_index-delete-vectors-by-id-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Delete Vector Identifiers Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_index-delete-vectors-by-id-response'
          description: Delete Vector Identifiers Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Vectors By Identifier (Deprecated)
      tags:
        - Vectorize Beta (Deprecated)
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids` endpoint.
        display: true
        id: vectorize_delete_by_ids_deprecation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.update
  /accounts/{account_id}/vectorize/indexes/{index_name}/get-by-ids:
    post:
      deprecated: true
      description: Get a set of vectors from an index by their vector identifiers.
      operationId: vectorize-(-deprecated)-get-vectors-by-id
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_index-get-vectors-by-id-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Get Vectors By Identifier Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_index-get-vectors-by-id-response'
          description: Get Vectors By Identifier Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Vectors By Identifier (Deprecated)
      tags:
        - Vectorize Beta (Deprecated)
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids` endpoint.
        display: true
        id: vectorize_get_by_ids_deprecation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.read
  /accounts/{account_id}/vectorize/indexes/{index_name}/insert:
    post:
      deprecated: true
      description: Inserts vectors into the specified index and returns the count of the vectors successfully inserted.
      operationId: vectorize-(-deprecated)-insert-vector
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/x-ndjson:
            schema:
              description: ndjson file containing vectors to insert.
              example: '@/path/to/vectors.ndjson'
              format: binary
              type: string
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Insert Vectors Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_index-insert-response'
          description: Insert Vectors Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Insert Vectors (Deprecated)
      tags:
        - Vectorize Beta (Deprecated)
      x-api-token-group:
        - Vectorize Write
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert` endpoint.
        display: true
        id: vectorize_insert_deprecation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.update
  /accounts/{account_id}/vectorize/indexes/{index_name}/query:
    post:
      deprecated: true
      description: Finds vectors closest to a given vector in an index.
      operationId: vectorize-(-deprecated)-query-vector
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_index-query-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Query Vectors Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_index-query-response'
          description: Query Vectors Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Query Vectors (Deprecated)
      tags:
        - Vectorize Beta (Deprecated)
      x-api-token-group:
        - Vectorize Write
        - Vectorize Read
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query` endpoint.
        display: true
        id: vectorize_query_deprecation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.read
  /accounts/{account_id}/vectorize/indexes/{index_name}/upsert:
    post:
      deprecated: true
      description: Upserts vectors into the specified index, creating them if they do not exist and returns the count of values and ids successfully inserted.
      operationId: vectorize-(-deprecated)-upsert-vector
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/x-ndjson:
            schema:
              description: ndjson file containing vectors to upsert.
              example: '@/path/to/vectors.ndjson'
              format: binary
              type: string
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Insert Vectors Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_index-upsert-response'
          description: Insert Vectors Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Upsert Vectors (Deprecated)
      tags:
        - Vectorize Beta (Deprecated)
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert` endpoint.
        display: true
        id: vectorize_upsert_deprecation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.update
  /accounts/{account_id}/vectorize/v2/indexes:
    get:
      description: Returns a list of Vectorize Indexes
      operationId: vectorize-list-vectorize-indexes
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: List Vectorize Index Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/vectorize_create-index-response'
                        type: array
          description: List Vectorize Index Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Vectorize Indexes
      tags:
        - Vectorize
      x-api-token-group:
        - Vectorize Write
        - Vectorize Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.list
    post:
      description: Creates and returns a new Vectorize Index.
      operationId: vectorize-create-vectorize-index
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_create-index-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Create Vectorize Index Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_create-index-response'
          description: Create Vectorize Index Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Vectorize Index
      tags:
        - Vectorize
      x-api-token-group:
        - Vectorize Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.create
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}:
    delete:
      description: Deletes the specified Vectorize Index.
      operationId: vectorize-delete-vectorize-index
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Delete Vectorize Index Failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        nullable: true
                        type: object
          description: Delete Vectorize Index Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Vectorize Index
      tags:
        - Vectorize
      x-api-token-group:
        - Vectorize Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.delete
    get:
      description: Returns the specified Vectorize Index.
      operationId: vectorize-get-vectorize-index
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Get Vectorize Index Failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_create-index-response'
          description: Get Vectorize Index Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Vectorize Index
      tags:
        - Vectorize
      x-api-token-group:
        - Vectorize Write
        - Vectorize Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.read
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids:
    post:
      description: Delete a set of vectors from an index by their vector identifiers.
      operationId: vectorize-delete-vectors-by-id
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_index-delete-vectors-by-id-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Delete Vector Identifiers Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_index-delete-vectors-by-id-v2-response'
          description: Delete Vector Identifiers Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Vectors By Identifier
      tags:
        - Vectorize
      x-api-token-group:
        - Vectorize Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.delete
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids:
    post:
      description: Get a set of vectors from an index by their vector identifiers.
      operationId: vectorize-get-vectors-by-id
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_index-get-vectors-by-id-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Get Vectors By Identifier Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_index-get-vectors-by-id-response'
          description: Get Vectors By Identifier Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Vectors By Identifier
      tags:
        - Vectorize
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.read
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/info:
    get:
      description: Get information about a vectorize index.
      operationId: vectorize-index-info
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Get Vectorize Index Info Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_index-info-response'
          description: Get Vectorize Index Info Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Vectorize Index Info
      tags:
        - Vectorize
      x-api-token-group:
        - Vectorize Write
        - Vectorize Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.read
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert:
    post:
      description: Inserts vectors into the specified index and returns a mutation id corresponding to the vectors enqueued for insertion.
      operationId: vectorize-insert-vector
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
        - in: query
          name: unparsable-behavior
          schema:
            description: Behavior for ndjson parse failures.
            enum:
              - error
              - discard
            type: string
      requestBody:
        content:
          application/x-ndjson:
            schema:
              description: ndjson file containing vectors to insert.
              example: '@/path/to/vectors.ndjson'
              format: binary
              type: string
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Insert Vectors Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_index-insert-v2-response'
          description: Insert Vectors Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Insert Vectors
      tags:
        - Vectorize
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.update
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create:
    post:
      description: Enable metadata filtering based on metadata property. Limited to 10 properties.
      operationId: vectorize-create-metadata-index
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_create-metadata-index-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Create Metadata Index Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_create-metadata-index-response'
          description: Create Metadata Index Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Metadata Index
      tags:
        - Vectorize
      x-api-token-group:
        - Vectorize Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.create
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete:
    post:
      description: Allow Vectorize to delete the specified metadata index.
      operationId: vectorize-delete-metadata-index
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_delete-metadata-index-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Delete Metadata Index Failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_delete-metadata-index-response'
          description: Delete Metadata Index Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Metadata Index
      tags:
        - Vectorize
      x-api-token-group:
        - Vectorize Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.delete
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list:
    get:
      description: List Metadata Indexes for the specified Vectorize Index.
      operationId: vectorize-list-metadata-indexes
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: List Metadata Index Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_list-metadata-index-response'
          description: List Metadata Index Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Metadata Indexes
      tags:
        - Vectorize
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.list
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/query:
    post:
      description: Finds vectors closest to a given vector in an index.
      operationId: vectorize-query-vector
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vectorize_index-query-v2-request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Query Vectors Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_index-query-v2-response'
          description: Query Vectors Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Query Vectors
      tags:
        - Vectorize
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.read
  /accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert:
    post:
      description: Upserts vectors into the specified index, creating them if they do not exist and returns a mutation id corresponding to the vectors enqueued for upsertion.
      operationId: vectorize-upsert-vector
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_identifier'
        - in: path
          name: index_name
          required: true
          schema:
            $ref: '#/components/schemas/vectorize_index-name'
        - in: query
          name: unparsable-behavior
          schema:
            description: Behavior for ndjson parse failures.
            enum:
              - error
              - discard
            type: string
      requestBody:
        content:
          application/x-ndjson:
            schema:
              description: ndjson file containing vectors to upsert.
              example: '@/path/to/vectors.ndjson'
              format: binary
              type: string
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/vectorize_api-response-single'
                      - properties:
                          result:
                            nullable: true
                            type: object
                        type: object
                  - $ref: '#/components/schemas/vectorize_api-response-common-failure'
          description: Upsert Vectors Failure Response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/vectorize_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/vectorize_index-upsert-v2-response'
          description: Upsert Vectors Response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Upsert Vectors
      tags:
        - Vectorize
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.vectorize.index.update
  /accounts/{account_id}/warp_connector:
    get:
      description: Lists and filters Warp Connector Tunnels in an account.
      operationId: cloudflare-tunnel-list-warp-connector-tunnels
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: query
          name: name
          schema:
            description: A user-friendly name for the tunnel.
            example: blog
            type: string
        - in: query
          name: is_deleted
          schema:
            description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.
            example: true
            type: boolean
        - in: query
          name: existed_at
          schema:
            $ref: '#/components/schemas/tunnel_existed_at'
        - in: query
          name: uuid
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
        - in: query
          name: was_active_at
          schema:
            example: "2009-11-10T23:00:00Z"
            format: date-time
            type: string
        - in: query
          name: was_inactive_at
          schema:
            example: "2009-11-10T23:00:00Z"
            format: date-time
            type: string
        - in: query
          name: include_prefix
          schema:
            example: vpc1-
            type: string
        - in: query
          name: exclude_prefix
          schema:
            example: vpc1-
            type: string
        - in: query
          name: status
          schema:
            $ref: '#/components/schemas/tunnel_status'
        - in: query
          name: per_page
          schema:
            $ref: '#/components/schemas/tunnel_per_page'
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel-response-collection'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: List Warp Connector Tunnels response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-collection'
          description: List Warp Connector Tunnels response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform List Warp Connector Tunnels
      tags:
        - Cloudflare Tunnel
      x-api-token-group:
        - Cloudflare One Connectors Write
        - Cloudflare One Connectors Read
        - Cloudflare One Warp Connectors Write
        - Cloudflare One Warp Connectors Read
    post:
      description: Creates a new Warp Connector Tunnel in an account.
      operationId: cloudflare-tunnel-create-a-warp-connector-tunnel
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/tunnel_tunnel_name'
              required:
                - name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Create a Warp Connector Tunnel response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Create a Warp Connector Tunnel response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Create a Warp Connector Tunnel
      tags:
        - Cloudflare Tunnel
      x-api-token-group:
        - Cloudflare One Connectors Write
        - Cloudflare One Warp Connectors Write
  /accounts/{account_id}/warp_connector/{tunnel_id}:
    delete:
      description: Deletes a Warp Connector Tunnel from an account.
      operationId: cloudflare-tunnel-delete-a-warp-connector-tunnel
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Delete a Warp Connector Tunnel response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Delete a Warp Connector Tunnel response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Delete a Warp Connector Tunnel
      tags:
        - Cloudflare Tunnel
      x-api-token-group:
        - Cloudflare One Connectors Write
        - Cloudflare One Warp Connectors Write
    get:
      description: Fetches a single Warp Connector Tunnel.
      operationId: cloudflare-tunnel-get-a-warp-connector-tunnel
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get a Warp Connector Tunnel response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Get a Warp Connector Tunnel response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get a Warp Connector Tunnel
      tags:
        - Cloudflare Tunnel
      x-api-token-group:
        - Cloudflare One Connectors Write
        - Cloudflare One Connectors Read
        - Cloudflare One Warp Connectors Write
        - Cloudflare One Warp Connectors Read
    patch:
      description: Updates an existing Warp Connector Tunnel.
      operationId: cloudflare-tunnel-update-a-warp-connector-tunnel
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/tunnel_tunnel_name'
                tunnel_secret:
                  $ref: '#/components/schemas/tunnel_tunnel_secret'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel-response-single'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Update a Warp Connector Tunnel response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel-response-single'
          description: Update a Warp Connector Tunnel response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Update a Warp Connector Tunnel
      tags:
        - Cloudflare Tunnel
      x-api-token-group:
        - Cloudflare One Connectors Write
        - Cloudflare One Warp Connectors Write
  /accounts/{account_id}/warp_connector/{tunnel_id}/token:
    get:
      description: Gets the token used to associate warp device with a specific Warp Connector tunnel.
      operationId: cloudflare-tunnel-get-a-warp-connector-tunnel-token
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
        - in: path
          name: tunnel_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_tunnel_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tunnel_tunnel_response_token'
                  - $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get a Warp Connector Tunnel token response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_tunnel_response_token'
          description: Get a Warp Connector Tunnel token response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get a Warp Connector Tunnel token
      tags:
        - Cloudflare Tunnel
  /accounts/{account_id}/workers/account-settings:
    get:
      description: Fetches Worker account settings for an account.
      operationId: worker-account-settings-fetch-worker-account-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_account-settings-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Fetch Worker Account Settings response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_account-settings-response'
          description: Fetch Worker Account Settings response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Fetch Worker Account Settings
      tags:
        - Worker Account Settings
      x-api-token-group:
        - Cloudflare Zero Trust PII Read
        - DDoS Botnet Feed Write
        - DDoS Botnet Feed Read
        - Workers R2 Storage Write
        - Workers R2 Storage Read
        - DDoS Protection Write
        - DDoS Protection Read
        - Workers Tail Read
        - Workers KV Storage Write
        - Workers KV Storage Read
        - Workers Scripts Write
        - Workers Scripts Read
        - 'Load Balancing: Monitors and Pools Write'
        - 'Load Balancing: Monitors and Pools Read'
        - Account Firewall Access Rules Write
        - Account Firewall Access Rules Read
        - DNS Firewall Write
        - DNS Firewall Read
        - Billing Write
        - Billing Read
        - Account Settings Write
        - Account Settings Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.read
    put:
      description: Creates Worker account settings for an account.
      operationId: worker-account-settings-create-worker-account-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_account-settings'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_account-settings-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Create Worker Account Settings response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_account-settings-response'
          description: Create Worker Account Settings response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Worker Account Settings
      tags:
        - Worker Account Settings
      x-api-token-group:
        - Account Settings Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.update
  /accounts/{account_id}/workers/deployments/by-script/{script_id}:
    get:
      deprecated: true
      operationId: worker-deployments-(-deprecated)-list-deployments
      parameters:
        - in: path
          name: script_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_deployments-list-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Deployments response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_deployments-list-response'
          description: List Deployments response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Deployments
      tags:
        - Worker Deployments (Deprecated)
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfDeprecation:
        description: This endpoint and its related APIs are deprecated in favor of the `/accounts/{account_id}/workers/scripts/{script_name}/versions` equivalent APIs.
        display: true
        id: worker_deployments_deprecation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.deployment.list
  /accounts/{account_id}/workers/deployments/by-script/{script_id}/detail/{deployment_id}:
    get:
      deprecated: true
      operationId: worker-deployments-(-deprecated)-get-deployment-detail
      parameters:
        - in: path
          name: deployment_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_deployment_identifier'
        - in: path
          name: script_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_deployments-single-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Get Deployment Detail response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_deployments-single-response'
          description: Get Deployment Detail response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Deployment Detail
      tags:
        - Worker Deployments (Deprecated)
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfDeprecation:
        description: This endpoint and its related APIs are deprecated in favor of the `/accounts/{account_id}/workers/scripts/{script_name}/versions` equivalent APIs.
        display: true
        id: worker_deployments_deprecation
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.deployment.read
  /accounts/{account_id}/workers/dispatch/namespaces:
    get:
      description: Fetch a list of Workers for Platforms namespaces.
      operationId: namespace-worker-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Failure to get list of Workers for Platforms namespaces.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_namespace-list-response'
          description: Fetch a list of Workers for Platforms namespaces.
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List dispatch namespaces
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    post:
      description: Create a new Workers for Platforms namespace.
      operationId: namespace-worker-create
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  description: The name of the dispatch namespace
                  example: my-dispatch-namespace
                  type: string
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Failure to get list of Workers for Platforms namespaces.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_namespace-single-response'
          description: Fetch a list of Workers for Platforms namespaces.
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create dispatch namespace
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.create
  /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}:
    delete:
      description: Delete a Workers for Platforms namespace.
      operationId: namespace-worker-delete-namespace
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Failure to delete Workers for Platforms namespace.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_namespace-delete-response'
          description: Delete a Workers for Platforms namespace.
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete dispatch namespace
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.delete
    get:
      description: Get a Workers for Platforms namespace.
      operationId: namespace-worker-get-namespace
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Failure to get Workers for Platforms namespace.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_namespace-single-response'
          description: Get a Workers for Platforms namespace.
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get dispatch namespace
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
  /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}:
    delete:
      description: Delete a worker from a Workers for Platforms namespace. This call has no response body on a successful delete.
      operationId: namespace-worker-script-delete-worker
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - description: 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.
          in: query
          name: force
          schema:
            type: boolean
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json: {}
          description: Delete Worker response failure
        "200":
          content:
            application/json: {}
          description: Delete Worker response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Worker
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.delete
    get:
      description: Fetch information about a script uploaded to a Workers for Platforms namespace.
      operationId: namespace-worker-script-worker-details
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Worker Details Failure (Workers for Platforms)
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_namespace-script-response-single'
          description: Worker Details Response (Workers for Platforms)
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Worker Details
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    put:
      description: 'Upload a worker module to a Workers for Platforms namespace. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.'
      operationId: namespace-worker-script-upload-worker-module
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      requestBody:
        $ref: '#/components/requestBodies/workers_script_upload'
      responses:
        4XX:
          $ref: '#/components/responses/workers_4XX'
        "200":
          $ref: '#/components/responses/workers_200'
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Upload Worker Module
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.create
  /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/bindings:
    get:
      description: Fetch script bindings from a script uploaded to a Workers for Platforms namespace.
      operationId: namespace-worker-get-script-bindings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Fetch script bindings failure (Workers for Platforms)
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/workers_bindings'
          description: Fetch script bindings (Workers for Platforms)
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Script Bindings
      tags:
        - Workers for Platforms
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
  /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content:
    get:
      description: Fetch script content from a script uploaded to a Workers for Platforms namespace.
      operationId: namespace-worker-get-script-content
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Get script content failure
        "200":
          content:
            string:
              schema:
                example: |
                  export default {
                    fetch(req) {
                      return new Response("Hello, World!")
                    }
                  }
          description: Get script content
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Script Content
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    put:
      description: Put script content for a script uploaded to a Workers for Platforms namespace.
      operationId: namespace-worker-put-script-content
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part.
          in: header
          name: CF-WORKER-BODY-PART
          schema:
            type: string
        - description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part.
          in: header
          name: CF-WORKER-MAIN-MODULE-PART
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            encoding:
              <any part name>:
                contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream, application/source-map
            schema:
              properties:
                <any part name>:
                  description: A module comprising a Worker script, often a javascript file. Multiple modules may be provided as separate named parts, but at least one module must be present. This should be referenced either in the metadata as `main_module` (esm)/`body_part` (service worker) or as a header `CF-WORKER-MAIN-MODULE-PART` (esm) /`CF-WORKER-BODY-PART` (service worker) by part name. Source maps may also be included using the `application/source-map` content type.
                  items:
                    format: binary
                    type: string
                  type: array
                metadata:
                  description: JSON encoded metadata about the uploaded parts and Worker configuration.
                  properties:
                    body_part:
                      description: Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.
                      example: worker.js
                      type: string
                    main_module:
                      description: Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
                      example: worker.js
                      type: string
                  type: object
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Put script content failure (Workers for Platforms)
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-response-single'
          description: Put script content (Workers for Platforms)
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Put Script Content
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.create
  /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets:
    get:
      description: List secrets from a script uploaded to a Workers for Platforms namespace.
      operationId: namespace-worker-list-script-secrets
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: List script secrets failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/workers_secret-response'
                        type: array
          description: List script secrets
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Script Secrets
      tags:
        - Workers for Platforms
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    put:
      description: Put secrets to a script uploaded to a Workers for Platforms namespace.
      operationId: namespace-worker-put-script-secrets
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_secret'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Fetch script bindings failure (Workers for Platforms)
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/workers_secret-response'
          description: Fetch script bindings (Workers for Platforms)
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Put Script Secrets
      tags:
        - Workers for Platforms
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.edit
  /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets/{secret_name}:
    get:
      description: Get secret from a script uploaded to a Workers for Platforms namespace.
      operationId: namespace-worker-get-script-secrets
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: secret_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_secret_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Get script secret failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/workers_secret-response'
          description: Get script secret
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Script Secret
      tags:
        - Workers for Platforms
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
  /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings:
    get:
      description: Get script settings from a script uploaded to a Workers for Platforms namespace.
      operationId: namespace-worker-get-script-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Fetch script settings failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/workers_script-and-version-settings-item'
          description: Fetch script settings
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Script Settings
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    patch:
      description: Patch script metadata, such as bindings
      operationId: namespace-worker-patch-script-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                settings:
                  $ref: '#/components/schemas/workers_script-and-version-settings-item'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Patch script settings failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/workers_script-and-version-settings-item'
          description: Patch script settings
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch Script Settings
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.create
  /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags:
    get:
      description: Fetch tags from a script uploaded to a Workers for Platforms namespace.
      operationId: namespace-worker-get-script-tags
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Fetch script tags failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-common'
                  - properties:
                      result:
                        example:
                          - free
                          - customer
                        items:
                          $ref: '#/components/schemas/workers_tag'
                        type: array
          description: Fetch script tags
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Script Tags
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    put:
      description: Put script tags for a script uploaded to a Workers for Platforms namespace.
      operationId: namespace-worker-put-script-tags
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_tags'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Fetch script tags failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-common'
                  - properties:
                      result:
                        example:
                          - my-tag
                        items:
                          $ref: '#/components/schemas/workers_tag'
                        type: array
          description: Fetch script tags
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Put Script Tags
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.edit
  /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags/{tag}:
    delete:
      description: Delete script tag for a script uploaded to a Workers for Platforms namespace.
      operationId: namespace-worker-delete-script-tag
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: tag
          required: true
          schema:
            $ref: '#/components/schemas/workers_tag'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Delete script tag failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-common'
                  - properties:
                      result:
                        enum:
                          - 
                        nullable: true
                        type: object
          description: Delete script tag
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Script Tag
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.edit
    put:
      description: Put a single tag on a script uploaded to a Workers for Platforms namespace.
      operationId: namespace-worker-put-script-tag
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: dispatch_namespace
          required: true
          schema:
            $ref: '#/components/schemas/workers_dispatch_namespace_name'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: tag
          required: true
          schema:
            $ref: '#/components/schemas/workers_tag'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Put script tag failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-common'
                  - properties:
                      result:
                        enum:
                          - 
                        nullable: true
                        type: object
          description: Put script tag
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Put Script Tag
      tags:
        - Workers for Platforms
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
  /accounts/{account_id}/workers/domains:
    get:
      description: Lists all Worker Domains for an account.
      operationId: worker-domain-list-domains
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_account_identifier'
        - in: query
          name: zone_name
          schema:
            $ref: '#/components/schemas/workers_zone_name'
        - in: query
          name: service
          schema:
            $ref: '#/components/schemas/workers_schemas-service'
        - in: query
          name: zone_id
          schema:
            $ref: '#/components/schemas/workers_zone_identifier'
        - in: query
          name: hostname
          schema:
            description: Hostname of the Worker Domain.
            example: foo.example.com
            type: string
        - in: query
          name: environment
          schema:
            description: Worker environment associated with the zone and hostname.
            example: production
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_domain-response-collection'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Domains response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_domain-response-collection'
          description: List Domains response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Domains
      tags:
        - Worker Domain
      x-api-token-group:
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.domain.list
    put:
      description: Attaches a Worker to a zone and hostname.
      operationId: worker-domain-attach-to-domain
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                environment:
                  $ref: '#/components/schemas/workers_schemas-environment'
                hostname:
                  $ref: '#/components/schemas/workers_hostname'
                service:
                  $ref: '#/components/schemas/workers_schemas-service'
                zone_id:
                  $ref: '#/components/schemas/workers_zone_identifier'
              required:
                - zone_id
                - hostname
                - service
                - environment
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_domain-response-single'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Attach to Domain response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_domain-response-single'
          description: Attach to Domain response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Attach to Domain
      tags:
        - Worker Domain
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.domain.update
  /accounts/{account_id}/workers/domains/{domain_id}:
    delete:
      description: Detaches a Worker from a zone and hostname.
      operationId: worker-domain-detach-from-domain
      parameters:
        - in: path
          name: domain_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_domain_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json: {}
          description: Detach from Domain response failure
        "200":
          content:
            application/json: {}
          description: Detach from Domain response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Detach from Domain
      tags:
        - Worker Domain
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.domain.delete
    get:
      description: Gets a Worker domain.
      operationId: worker-domain-get-a-domain
      parameters:
        - in: path
          name: domain_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_domain_identifier'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_domain-response-single'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Get a Domain response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_domain-response-single'
          description: Get a Domain response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a Domain
      tags:
        - Worker Domain
      x-api-token-group:
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.domain.read
  /accounts/{account_id}/workers/durable_objects/namespaces:
    get:
      description: Returns the Durable Object namespaces owned by an account.
      operationId: durable-objects-namespace-list-namespaces
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/workers_api-response-collection'
                      - properties:
                          result:
                            items:
                              $ref: '#/components/schemas/workers_namespace'
                            type: array
                        type: object
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Namespaces response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-collection'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/workers_namespace'
                        type: array
                    type: object
          description: List Namespaces response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Namespaces
      tags:
        - Durable Objects Namespace
      x-api-token-group:
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.durable-object.class.list
  /accounts/{account_id}/workers/durable_objects/namespaces/{id}/objects:
    get:
      description: Returns the Durable Objects in a given namespace.
      operationId: durable-objects-namespace-list-objects
      parameters:
        - in: path
          name: id
          required: true
          schema:
            $ref: '#/components/schemas/workers_schemas-id'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: query
          name: limit
          schema:
            default: 1000
            description: The number of objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit.
            maximum: 10000
            minimum: 10
            type: number
        - in: query
          name: cursor
          schema:
            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
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/workers_api-response-collection'
                      - properties:
                          result:
                            items:
                              $ref: '#/components/schemas/workers_object'
                            type: array
                          result_info:
                            properties:
                              count:
                                description: Total results returned based on your list parameters.
                                example: 1
                                type: number
                              cursor:
                                $ref: '#/components/schemas/workers_cursor'
                        type: object
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Objects response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-collection'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/workers_object'
                        type: array
                      result_info:
                        properties:
                          count:
                            description: Total results returned based on your list parameters.
                            example: 1
                            type: number
                          cursor:
                            $ref: '#/components/schemas/workers_cursor'
                    type: object
          description: List Objects response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Objects
      tags:
        - Durable Objects Namespace
      x-api-token-group:
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.durable-object.class.read
  /accounts/{account_id}/workers/scripts:
    get:
      description: Fetch a list of uploaded workers.
      operationId: worker-script-list-workers
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_script-response-collection'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Workers response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-response-collection'
          description: List Workers response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Workers
      tags:
        - Worker Script
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.list
  /accounts/{account_id}/workers/scripts/{script_name}:
    delete:
      description: Delete your worker. This call has no response body on a successful delete.
      operationId: worker-script-delete-worker
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - description: 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.
          in: query
          name: force
          schema:
            type: boolean
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json: {}
          description: Delete Worker response failure
        "200":
          content:
            application/json: {}
          description: Delete Worker response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Worker
      tags:
        - Worker Script
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.delete
    get:
      description: Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.
      operationId: worker-script-download-worker
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            undefined:
              schema:
                example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
          description: Download Worker response failure
        "200":
          content:
            undefined:
              schema:
                example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
          description: Download Worker response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Download Worker
      tags:
        - Worker Script
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    put:
      description: 'Upload a worker module. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.'
      operationId: worker-script-upload-worker-module
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - description: Rollback to provided deployment based on deployment ID. Request body will only parse a "message" part. You can learn more about deployments [here](https://developers.cloudflare.com/workers/platform/deployments/).
          in: query
          name: rollback_to
          schema:
            $ref: '#/components/schemas/workers_uuid'
      requestBody:
        $ref: '#/components/requestBodies/workers_script_upload'
      responses:
        4XX:
          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
                        logpush: false
                        modified_on: "2022-05-20T19:02:56.446492Z"
                        tail_consumers:
                          - environment: production
                            service: my-log-consumer
                        usage_model: bundled
                      success: true
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Upload Worker Module response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_script-response-upload-single'
                  - example:
                      errors: []
                      messages: []
                      result:
                        created_on: "2022-05-05T05:15:11.602148Z"
                        etag: 777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1
                        handlers:
                          - fetch
                        id: this-is_my_script-01
                        logpush: false
                        modified_on: "2022-05-20T19:02:56.446492Z"
                        placement_mode: smart
                        startup_time_ms: 10
                        tail_consumers:
                          - environment: production
                            service: my-log-consumer
                        usage_model: bundled
                      success: true
          description: Upload Worker Module response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Upload Worker Module
      tags:
        - Worker Script
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.create
  /accounts/{account_id}/workers/scripts/{script_name}/content:
    put:
      description: Put script content without touching config or metadata
      operationId: worker-script-put-content
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part.
          in: header
          name: CF-WORKER-BODY-PART
          schema:
            type: string
        - description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part.
          in: header
          name: CF-WORKER-MAIN-MODULE-PART
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            encoding:
              <any part name>:
                contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream, application/source-map
            schema:
              properties:
                <any part name>:
                  description: A module comprising a Worker script, often a javascript file. Multiple modules may be provided as separate named parts, but at least one module must be present. This should be referenced either in the metadata as `main_module` (esm)/`body_part` (service worker) or as a header `CF-WORKER-MAIN-MODULE-PART` (esm) /`CF-WORKER-BODY-PART` (service worker) by part name. Source maps may also be included using the `application/source-map` content type.
                  items:
                    format: binary
                    type: string
                  type: array
                metadata:
                  description: JSON encoded metadata about the uploaded parts and Worker configuration.
                  properties:
                    body_part:
                      description: Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.
                      example: worker.js
                      type: string
                    main_module:
                      description: Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
                      example: worker.js
                      type: string
                  type: object
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Put script content failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-response-single'
          description: Put script content
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Put script content
      tags:
        - Worker Script
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.create
  /accounts/{account_id}/workers/scripts/{script_name}/content/v2:
    get:
      description: Fetch script content only
      operationId: worker-script-get-content
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Fetch script content failure
        "200":
          content:
            string:
              schema:
                example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
          description: Fetch script content
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get script content
      tags:
        - Worker Script
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
  /accounts/{account_id}/workers/scripts/{script_name}/deployments:
    get:
      description: List of Worker Deployments. The first deployment in the list is the latest deployment actively serving traffic.
      operationId: worker-deployments-list-deployments
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_schemas-script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_schemas-deployments-list-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Deployments response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_schemas-deployments-list-response'
          description: List Deployments response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Deployments
      tags:
        - Worker Deployments
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.deployment.list
    post:
      description: Deployments configure how [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions) are deployed to traffic. A deployment can consist of one or two versions of a Worker.
      operationId: worker-deployments-create-deployment
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_schemas-script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - description: If set to true, the deployment will be created even if normally blocked by something such rolling back to an older version when a secret has changed.
          in: query
          name: force
          schema:
            type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_deployments-create-body'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_schemas-deployments-single-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Create Deployment response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_schemas-deployments-single-response'
          description: Create Deployment response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Deployment
      tags:
        - Worker Deployments
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.deployment.edit
  /accounts/{account_id}/workers/scripts/{script_name}/schedules:
    get:
      description: Fetches Cron Triggers for a Worker.
      operationId: worker-cron-trigger-get-cron-triggers
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_cron-trigger-response-collection'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Get Cron Triggers response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_cron-trigger-response-collection'
          description: Get Cron Triggers response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Cron Triggers
      tags:
        - Worker Cron Trigger
      x-api-token-group:
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.cron.trigger.read
    put:
      description: Updates Cron Triggers for a Worker.
      operationId: worker-cron-trigger-update-cron-triggers
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/workers_cron-object'
              type: array
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_cron-trigger-response-collection'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Update Cron Triggers response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_cron-trigger-response-collection'
          description: Update Cron Triggers response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Cron Triggers
      tags:
        - Worker Cron Trigger
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.cron.trigger.update
  /accounts/{account_id}/workers/scripts/{script_name}/script-settings:
    get:
      description: Get script-level settings when using [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions). Includes Logpush and Tail Consumers.
      operationId: worker-script-settings-get-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Fetch script settings failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-settings-response'
          description: Fetch script settings
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Script Settings
      tags:
        - Worker Script
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    patch:
      description: Patch script-level settings when using [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions). Includes Logpush and Tail Consumers.
      operationId: worker-script-settings-patch-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_script-settings-item'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Patch script settings failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-settings-response'
          description: Patch script settings
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch Script Settings
      tags:
        - Worker Script
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.create
  /accounts/{account_id}/workers/scripts/{script_name}/settings:
    get:
      description: Get metadata and config, such as bindings or usage model
      operationId: worker-script-get-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Fetch settings failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-and-version-settings-response'
          description: Fetch settings
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Settings
      tags:
        - Worker Script
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    patch:
      description: Patch metadata or config, such as bindings or usage model
      operationId: worker-script-patch-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                settings:
                  $ref: '#/components/schemas/workers_script-and-version-settings-item'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Patch settings failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-and-version-settings-response'
          description: Patch settings
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch Settings
      tags:
        - Worker Script
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.create
  /accounts/{account_id}/workers/scripts/{script_name}/tails:
    get:
      description: Get list of tails currently deployed on a Worker.
      operationId: worker-tail-logs-list-tails
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_tail-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Tails response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_tail-response'
          description: List Tails response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Tails
      tags:
        - Worker Tail Logs
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    post:
      description: Starts a tail that receives logs and exception from a Worker.
      operationId: worker-tail-logs-start-tail
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_tail-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Start Tail response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_tail-response'
          description: Start Tail response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Start Tail
      tags:
        - Worker Tail Logs
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
          - com.cloudflare.edge.worker.tail.create
  /accounts/{account_id}/workers/scripts/{script_name}/tails/{id}:
    delete:
      description: Deletes a tail from a Worker.
      operationId: worker-tail-logs-delete-tail
      parameters:
        - in: path
          name: id
          required: true
          schema:
            $ref: '#/components/schemas/workers_id'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_api-response-common'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Delete Tail response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Delete Tail response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Tail
      tags:
        - Worker Tail Logs
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
          - com.cloudflare.edge.worker.tail.create
  /accounts/{account_id}/workers/scripts/{script_name}/usage-model:
    get:
      description: Fetches the Usage Model for a given Worker.
      operationId: worker-script-fetch-usage-model
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_usage-model-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Fetch Usage Model response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_usage-model-response'
          description: Fetch Usage Model response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Fetch Usage Model
      tags:
        - Worker Script
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    put:
      description: Updates the Usage Model for a given Worker. Requires a Workers Paid subscription.
      operationId: worker-script-update-usage-model
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_usage-model-object'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_usage-model-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Update Usage Model response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_usage-model-response'
          description: Update Usage Model response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Usage Model
      tags:
        - Worker Script
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.create
  /accounts/{account_id}/workers/scripts/{script_name}/versions:
    get:
      description: List of Worker Versions. The first version in the list is the latest version.
      operationId: worker-versions-list-versions
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_schemas-script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - description: Only return versions that can be used in a deployment. Ignores pagination.
          in: query
          name: deployable
          schema:
            default: false
            type: boolean
        - description: Current page.
          in: query
          name: page
          schema:
            default: 1
            type: integer
        - description: Items per-page.
          in: query
          name: per_page
          schema:
            type: integer
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_versions-list-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Versions response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_versions-list-response'
          description: List Versions response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Versions
      tags:
        - Worker Versions
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.deployment.list
    post:
      description: 'Upload a Worker Version without deploying to Cloudflare''s network. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.'
      operationId: worker-versions-upload-version
      parameters:
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_schemas-script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      requestBody:
        $ref: '#/components/requestBodies/workers_version-post'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_versions-upload-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Upload Version response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_versions-upload-response'
          description: Upload Version response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Upload Version
      tags:
        - Worker Versions
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.deployment.edit
  /accounts/{account_id}/workers/scripts/{script_name}/versions/{version_id}:
    get:
      operationId: worker-versions-get-version-detail
      parameters:
        - in: path
          name: version_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_version_identifier'
        - in: path
          name: script_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_schemas-script_name'
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_versions-single-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Get Version Detail response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_versions-single-response'
          description: Get Version Detail response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Version Detail
      tags:
        - Worker Versions
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.deployment.read
  /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/content:
    get:
      description: Get script content from a worker with an environment
      operationId: worker-environment-get-script-content
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: service_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_service'
        - in: path
          name: environment_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_environment'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Get script content failure
        "200":
          content:
            string:
              schema:
                example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
          description: Get script content
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get script content
      tags:
        - Worker Environment
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    put:
      description: Put script content from a worker with an environment
      operationId: worker-environment-put-script-content
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: service_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_service'
        - in: path
          name: environment_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_environment'
        - description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part.
          in: header
          name: CF-WORKER-BODY-PART
          schema:
            type: string
        - description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part.
          in: header
          name: CF-WORKER-MAIN-MODULE-PART
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            encoding:
              <any part name>:
                contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream, application/source-map
            schema:
              properties:
                <any part name>:
                  description: A module comprising a Worker script, often a javascript file. Multiple modules may be provided as separate named parts, but at least one module must be present. This should be referenced either in the metadata as `main_module` (esm)/`body_part` (service worker) or as a header `CF-WORKER-MAIN-MODULE-PART` (esm) /`CF-WORKER-BODY-PART` (service worker) by part name. Source maps may also be included using the `application/source-map` content type.
                  items:
                    format: binary
                    type: string
                  type: array
                metadata:
                  description: JSON encoded metadata about the uploaded parts and Worker configuration.
                  properties:
                    body_part:
                      description: Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.
                      example: worker.js
                      type: string
                    main_module:
                      description: Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
                      example: worker.js
                      type: string
                  type: object
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Put script content failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-response-single'
          description: Put script content
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Put script content
      tags:
        - Worker Environment
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.create
  /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings:
    get:
      description: Get script settings from a worker with an environment
      operationId: worker-script-environment-get-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: service_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_service'
        - in: path
          name: environment_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_environment'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Fetch script settings failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-settings-response'
          description: Fetch script settings
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Script Settings
      tags:
        - Worker Environment
      x-api-token-group:
        - Workers Tail Read
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.read
    patch:
      description: Patch script metadata, such as bindings
      operationId: worker-script-environment-patch-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
        - in: path
          name: service_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_service'
        - in: path
          name: environment_name
          required: true
          schema:
            $ref: '#/components/schemas/workers_environment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_script-settings-response'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Patch script settings failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_script-settings-response'
          description: Patch script settings
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Patch Script Settings
      tags:
        - Worker Environment
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.script.create
  /accounts/{account_id}/workers/subdomain:
    get:
      description: Returns a Workers subdomain for an account.
      operationId: worker-subdomain-get-subdomain
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_subdomain-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Get Subdomain response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_subdomain-response'
          description: Get Subdomain response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Subdomain
      tags:
        - Worker Subdomain
      x-api-token-group:
        - Workers Scripts Write
        - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.cron.subdomain.read
    put:
      description: Creates a Workers subdomain for an account.
      operationId: worker-subdomain-create-subdomain
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/workers_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_subdomain-object'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/workers_subdomain-response'
                  - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Create Subdomain response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_subdomain-response'
          description: Create Subdomain response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Subdomain
      tags:
        - Worker Subdomain
      x-api-token-group:
        - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.edge.worker.cron.subdomain.create
  /accounts/{account_id}/zerotrust/connectivity_settings:
    get:
      description: Gets the Zero Trust Connectivity Settings for the given account.
      operationId: zero-trust-accounts-get-connectivity-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Get Zero Trust Connectivity Settings response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_zero_trust_connectivity_settings_response'
          description: Get Zero Trust Connectivity Settings response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Get Zero Trust Connectivity Settings
      tags:
        - Zero Trust Connectivity Settings
      x-api-token-group:
        - Teams Report
        - Teams Read
        - Teams Write
    patch:
      description: Updates the Zero Trust Connectivity Settings for the given account.
      operationId: zero-trust-accounts-patch-connectivity-settings
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            $ref: '#/components/schemas/tunnel_account_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                icmp_proxy_enabled:
                  $ref: '#/components/schemas/tunnel_icmp_proxy_enabled'
                offramp_warp_enabled:
                  $ref: '#/components/schemas/tunnel_offramp_warp_enabled'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_api-response-common-failure'
          description: Update Zero Trust Connectivity Settings response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_zero_trust_connectivity_settings_response'
          description: Update Zero Trust Connectivity Settings response
      security:
        - api_email: []
          api_key: []
        - api_token: []
        - user_service_key: []
      summary: APIs.io Engineering Platform Updates the Zero Trust Connectivity Settings
      tags:
        - Zero Trust Connectivity Settings
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/zt_risk_scoring/{user_id}:
    get:
      operationId: dlp-risk-score-summary-get-for-user
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: user_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Failed to get risk events
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-collection'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_RiskEvents'
                    type: object
          description: Risk events
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get risk event/score information for a specific user
      tags:
        - Zero Trust Risk Scoring
  /accounts/{account_id}/zt_risk_scoring/{user_id}/reset:
    post:
      operationId: dlp-risk-score-reset-post
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: user_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Dataset creation failed
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Empty'
                    type: object
          description: Dataset created successfully
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Clear the risk score for a particular user
      tags:
        - Zero Trust Risk Scoring
  /accounts/{account_id}/zt_risk_scoring/behaviors:
    get:
      operationId: dlp-risk-score-behaviors-get
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Failed to get risk scoring behaviors
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Behaviors'
                    type: object
          description: Risk scoring behaviors
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get all behaviors and associated configuration
      tags:
        - Zero Trust Risk Scoring
      x-api-token-group:
        - Teams Read
        - Teams Write
    put:
      operationId: dlp-risk-score-behaviors-put
      parameters:
        - description: Account ID
          in: path
          name: account_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_UpdateBehaviors'
        description: Behaviors
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Dataset creation failed
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_UpdateBehaviors'
                    type: object
          description: Dataset created successfully
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update configuration for risk behaviors
      tags:
        - Zero Trust Risk Scoring
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/zt_risk_scoring/integrations:
    get:
      operationId: dlp-zt-risk-score-integration-list
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: List failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_RiskScoreIntegrationArray'
                    type: object
          description: List response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List all risk score integrations for the account.
      tags:
        - Zero Trust Risk Scoring Integrations
      x-api-token-group:
        - Teams Read
        - Teams Write
    post:
      operationId: dlp-zt-risk-score-integration-create
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_CreateIntegrationBody'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Create failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_RiskScoreIntegration'
                    type: object
          description: Create response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create new risk score integration.
      tags:
        - Zero Trust Risk Scoring Integrations
      x-api-token-group:
        - Teams Write
  /accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}:
    delete:
      operationId: dlp-zt-risk-score-integration-delete
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: integration_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Delete failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_Empty'
                    type: object
          description: Delete response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete a risk score integration.
      tags:
        - Zero Trust Risk Scoring Integrations
    get:
      operationId: dlp-zt-risk-score-integration-get
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: integration_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Get failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_RiskScoreIntegration'
                    type: object
          description: Get response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get risk score integration by id.
      tags:
        - Zero Trust Risk Scoring Integrations
    put:
      description: Overwrite the reference_id, tenant_url, and active values with the ones provided
      operationId: dlp-zt-risk-score-integration-update
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: integration_id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_UpdateIntegrationBody'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Update failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_RiskScoreIntegration'
                    type: object
          description: Update response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update a risk score integration.
      tags:
        - Zero Trust Risk Scoring Integrations
  /accounts/{account_id}/zt_risk_scoring/integrations/reference_id/{reference_id}:
    get:
      operationId: dlp-zt-risk-score-integration-get-by-reference-id
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
        - in: path
          name: reference_id
          required: true
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Get failure response
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_RiskScoreIntegration'
                    type: object
          description: Get response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get risk score integration by reference id.
      tags:
        - Zero Trust Risk Scoring Integrations
  /accounts/{account_id}/zt_risk_scoring/summary:
    get:
      operationId: dlp-risk-score-summary-get
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Failed to get risk scores
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/dlp_api-response-collection'
                  - properties:
                      result:
                        $ref: '#/components/schemas/dlp_RiskSummary'
                    type: object
          description: Risk score for all users in the account
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get risk score info for all users in the account
      tags:
        - Zero Trust Risk Scoring
  /accounts/{account_identifier}/cloudforce-one/requests:
    post:
      operationId: cloudforce-one-request-list
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-list'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Create response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/cloudforce-one_request-list-item'
                        type: array
          description: List requests response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Requests
      tags:
        - Request for Information (RFI)
      x-api-token-group:
        - Cloudforce One Write
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}:
    delete:
      operationId: cloudforce-one-request-delete
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: request_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Delete request response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common'
          description: Delete request response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a Request
      tags:
        - Request for Information (RFI)
    get:
      operationId: cloudforce-one-request-get
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: request_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get request response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_request-item'
          description: Get request response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a Request
      tags:
        - Request for Information (RFI)
    put:
      description: Updating a request alters the request in the Cloudforce One queue. This API may be used to update any attributes of the request after the initial submission. Only fields that you choose to update need to be add to the request body.
      operationId: cloudforce-one-request-update
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: request_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Update request response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_request-item'
          description: Update request response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a Request
      tags:
        - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset:
    post:
      operationId: cloudforce-one-request-asset-list
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: request_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-asset-list'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: List request assets response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/cloudforce-one_request-asset-item'
                        type: array
          description: List request assets response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Request Assets
      tags:
        - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset/{asset_identifer}:
    delete:
      operationId: cloudforce-one-request-asset-delete
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: request_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
        - in: path
          name: asset_identifer
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Delete request asset response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common'
          description: Delete request asset response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a Request Asset
      tags:
        - Request for Information (RFI)
    get:
      operationId: cloudforce-one-request-asset-get
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: request_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
        - in: path
          name: asset_identifer
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get request asset response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/cloudforce-one_request-asset-item'
                        type: array
          description: Get request asset response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a Request Asset
      tags:
        - Request for Information (RFI)
    put:
      operationId: cloudforce-one-request-asset-update
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: request_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
        - in: path
          name: asset_identifer
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-asset-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Update request asset response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_request-asset-item'
          description: Update request asset response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a Request Asset
      tags:
        - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset/new:
    post:
      operationId: cloudforce-one-request-asset-new
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: request_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-asset-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Create request asset response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_request-asset-item'
          description: Create request asset response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a New Request Asset
      tags:
        - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message:
    post:
      operationId: cloudforce-one-request-message-list
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: request_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-message-list'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: List request messages response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/cloudforce-one_request-message-item'
                        type: array
          description: List request messages response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Request Messages
      tags:
        - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/{message_identifer}:
    delete:
      operationId: cloudforce-one-request-message-delete
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: request_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
        - in: path
          name: message_identifer
          required: true
          schema:
            type: integer
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Delete request message response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common'
          description: Delete request message response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a Request Message
      tags:
        - Request for Information (RFI)
    put:
      operationId: cloudforce-one-request-message-update
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: request_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
        - in: path
          name: message_identifer
          required: true
          schema:
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-message-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Update request message response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_request-message-item'
          description: Update request message response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a Request Message
      tags:
        - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/new:
    post:
      operationId: cloudforce-one-request-message-new
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: request_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-message-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Create request message response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_request-message-item'
          description: Create request message response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a New Request Message
      tags:
        - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/constants:
    get:
      operationId: cloudforce-one-request-constants
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get request constants response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_request-constants'
          description: Get request constants response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Request Priority, Status, and TLP constants
      tags:
        - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/new:
    post:
      description: Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided, a default will be assigned.
      operationId: cloudforce-one-request-new
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Create response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_request-item'
          description: Create request response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a New Request
      tags:
        - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/priority:
    post:
      operationId: cloudforce-one-priority-list
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_priority-list'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: List priorities response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/cloudforce-one_priority-item'
                        type: array
          description: List priorities response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Priority Intelligence Requirements
      tags:
        - Priority Intelligence Requirements (PIR)
  /accounts/{account_identifier}/cloudforce-one/requests/priority/{priority_identifer}:
    delete:
      operationId: cloudforce-one-priority-delete
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: priority_identifer
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Delete priority response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common'
          description: Delete priority response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a Priority Intelligence Requirement
      tags:
        - Priority Intelligence Requirements (PIR)
    get:
      operationId: cloudforce-one-priority-get
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: priority_identifer
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get priority response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_request-item'
          description: Get priority response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a Priority Intelligence Requirement
      tags:
        - Priority Intelligence Requirements (PIR)
    put:
      operationId: cloudforce-one-priority-update
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
        - in: path
          name: priority_identifer
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_priority-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Update priority response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_request-item'
          description: Update priority response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update a Priority Intelligence Requirement
      tags:
        - Priority Intelligence Requirements (PIR)
  /accounts/{account_identifier}/cloudforce-one/requests/priority/new:
    post:
      operationId: cloudforce-one-priority-new
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_priority-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Create priority response  failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_priority-item'
          description: Create priority response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a New Priority Intelligence Requirement
      tags:
        - Priority Intelligence Requirements (PIR)
  /accounts/{account_identifier}/cloudforce-one/requests/priority/quota:
    get:
      operationId: cloudforce-one-priority-quota
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get priority quota response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_quota'
          description: Get priority quota response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Priority Intelligence Requirement Quota
      tags:
        - Priority Intelligence Requirements (PIR)
  /accounts/{account_identifier}/cloudforce-one/requests/quota:
    get:
      operationId: cloudforce-one-request-quota
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get request quota response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_quota'
          description: Get request quota response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Request Quota
      tags:
        - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/types:
    get:
      operationId: cloudforce-one-request-types
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/cloudforce-one_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get request types response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cloudforce-one_request-types'
          description: Get request types response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get Request Types
      tags:
        - Request for Information (RFI)
  /accounts/{account_identifier}/custom_pages:
    get:
      description: Fetches all the custom pages at the account level.
      operationId: custom-pages-for-an-account-list-custom-pages
      parameters:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/custom-pages_identifier'
      responses:
        4xx:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-pages_custom_pages_response_collection'
                  - $ref: '#/components/schemas/custom-pages_api-response-common-failure'
          description: List custom pages response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-pages_custom_pages_response_collection'
          description: List custom pages response
      security:
        - api_email: []
          api_key: []
        - api_token: []
      summary: APIs.io Engineering Platform List custom pages
      tags:
        - Custom Pages for an Account
      x-api-token-group:
        - Cloudflare Zero Trust PII Read
        - Account Custom Pages Write
        - Account Custom Pages Read
        - Account Settings Write
        - Account Settings Read
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
  /accounts/{account_identifier}/custom_pages/{identifier}:
    get:
      description: Fetches the details of a custom page.
      operationId: custom-pages-for-an-account-get-a-custom-page
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/custom-pages_identifier'
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/custom-pages_identifier'
      responses:
        4xx:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
                  - $ref: '#/components/schemas/custom-pages_api-response-common-failure'
          description: Get a custom page response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
          description: Get a custom page response
      security:
        - api_email: []
          api_key: []
        - api_token: []
      summary: APIs.io Engineering Platform Get a custom page
      tags:
        - Custom Pages for an Account
      x-cfPermissionsRequired:
        enum:
          - '#organization:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
    put:
      description: Updates the configuration of an existing custom page.
      operationId: custom-pages-for-an-account-update-a-custom-page
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/custom-pages_identifier'
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/custom-pages_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                state:
                  $ref: '#/components/schemas/custom-pages_state'
                url:
                  $ref: '#/components/schemas/custom-pages_url'
              required:
                - url
                - state
        required: true
      responses:
        4xx:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
                  - $ref: '#/components/schemas/custom-pages_api-response-common-failure'
          description: Update a custom page response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
          description: Update a custom page response
      security:
        - api_email: []
          api_key: []
        - api_token: []
      summary: APIs.io Engineering Platform Update a custom page
      tags:
        - Custom Pages for an Account
      x-cfPermissionsRequired:
        enum:
          - '#organization:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
  /accounts/{account_identifier}/firewall/access_rules/rules:
    get:
      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:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/firewall_account_identifier'
        - in: query
          name: mode
          schema:
            $ref: '#/components/schemas/firewall_schemas-mode'
        - in: query
          name: configuration.target
          schema:
            description: The target to search in existing rules.
            enum:
              - ip
              - ip_range
              - asn
              - country
            example: ip
            type: string
        - in: query
          name: configuration.value
          schema:
            description: |-
              The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.
              Notes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.
            example: 198.51.100.4
            type: string
        - in: query
          name: notes
          schema:
            description: |-
              The string to search for in the notes of existing IP Access rules.
              Notes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.
            example: my note
            type: string
        - in: query
          name: match
          schema:
            default: all
            description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
            enum:
              - any
              - all
            type: string
        - in: query
          name: page
          schema:
            description: Requested page within paginated list of results.
            example: 1
            type: number
        - in: query
          name: per_page
          schema:
            description: Maximum number of results requested.
            example: 20
            type: number
        - in: query
          name: order
          schema:
            description: The field used to sort returned rules.
            enum:
              - configuration.target
              - configuration.value
              - mode
            example: mode
            type: string
        - in: query
          name: direction
          schema:
            description: The direction used to sort returned rules.
            enum:
              - asc
              - desc
            example: desc
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/firewall_response_collection'
                  - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: List IP Access rules response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_response_collection'
          description: List IP Access rules response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List IP Access rules
      tags:
        - IP Access Rules for an Account
      x-api-token-group:
        - Account Firewall Access Rules Write
        - Account Firewall Access Rules Read
      x-cfPermissionsRequired:
        enum:
          - '#waf:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      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:
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/firewall_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                configuration:
                  $ref: '#/components/schemas/firewall_configuration'
                mode:
                  $ref: '#/components/schemas/firewall_schemas-mode'
                notes:
                  $ref: '#/components/schemas/firewall_notes'
              required:
                - mode
                - configuration
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/firewall_response_single'
                  - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: Create an IP Access rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_response_single'
          description: Create an IP Access rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create an IP Access rule
      tags:
        - IP Access Rules for an Account
      x-api-token-group:
        - Account Firewall Access Rules Write
      x-cfPermissionsRequired:
        enum:
          - '#waf:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_identifier}/firewall/access_rules/rules/{identifier}:
    delete:
      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:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/firewall_components-schemas-identifier'
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/firewall_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/firewall_api-response-single-id'
                  - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: Delete an IP Access rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_api-response-single-id'
          description: Delete an IP Access rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an IP Access rule
      tags:
        - IP Access Rules for an Account
      x-api-token-group:
        - Account Firewall Access Rules Write
      x-cfPermissionsRequired:
        enum:
          - '#waf:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      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:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/firewall_components-schemas-identifier'
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/firewall_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/firewall_response_single'
                  - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: Get an IP Access rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_response_single'
          description: Get an IP Access rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an IP Access rule
      tags:
        - IP Access Rules for an Account
      x-api-token-group:
        - Account Firewall Access Rules Write
        - Account Firewall Access Rules Read
      x-cfPermissionsRequired:
        enum:
          - '#waf:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    patch:
      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:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/firewall_components-schemas-identifier'
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/firewall_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/firewall_schemas-rule'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/firewall_response_single'
                  - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: Update an IP Access rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_response_single'
          description: Update an IP Access rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an IP Access rule
      tags:
        - IP Access Rules for an Account
      x-api-token-group:
        - Account Firewall Access Rules Write
      x-cfPermissionsRequired:
        enum:
          - '#waf:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_identifier}/rules/lists/{list_id}/items/{item_id}:
    get:
      description: Fetches a list item in the list.
      operationId: lists-get-a-list-item
      parameters:
        - in: path
          name: item_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_item_id'
        - in: path
          name: list_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_list_id'
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/lists_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/lists_item-response-collection'
                  - $ref: '#/components/schemas/lists_api-response-common-failure'
          description: Get a list item response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_item-response-collection'
          description: Get a list item response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a list item
      tags:
        - Lists
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_identifier}/rules/lists/bulk_operations/{operation_id}:
    get:
      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:
        - in: path
          name: operation_id
          required: true
          schema:
            $ref: '#/components/schemas/lists_operation_id'
        - in: path
          name: account_identifier
          required: true
          schema:
            $ref: '#/components/schemas/lists_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/lists_bulk-operation-response-collection'
                  - $ref: '#/components/schemas/lists_api-response-common-failure'
          description: Get bulk operation status response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_bulk-operation-response-collection'
          description: Get bulk operation status response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get bulk operation status
      tags:
        - Lists
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{accountId}/urlscanner/scan:
    get:
      description: Search scans by date and webpages' requests, including full URL (after redirects), hostname, and path. <br/> A successful scan will appear in search results a few minutes after finishing but may take much longer if the system in under load. By default, only successfully completed scans will appear in search results, unless searching by `scanId`. Please take into account that older scans may be removed from the search index at an unspecified time.
      operationId: urlscanner-search-scans
      parameters:
        - description: Account Id
          in: path
          name: accountId
          required: true
          schema:
            description: Account Id
            type: string
        - description: Scan uuid
          in: query
          name: scanId
          schema:
            description: Scan uuid
            format: uuid
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 100
            type: integer
        - description: Pagination cursor to get the next set of results.
          in: query
          name: next_cursor
          schema:
            description: Pagination cursor to get the next set of results.
            type: string
        - description: Filter scans requested after date (inclusive).
          in: query
          name: date_start
          schema:
            description: Filter scans requested after date (inclusive).
            format: date-time
            type: string
        - description: Filter scans requested before date (inclusive).
          in: query
          name: date_end
          schema:
            description: Filter scans requested before date (inclusive).
            format: date-time
            type: string
        - description: Filter scans by URL of _any_ request made by the webpage
          in: query
          name: url
          schema:
            description: Filter scans by URL of _any_ request made by the webpage
            example: https://example.com/?hello
            type: string
        - description: Filter scans by hostname of _any_ request made by the webpage.
          in: query
          name: hostname
          schema:
            description: Filter scans by hostname of _any_ request made by the webpage.
            example: example.com
            type: string
        - description: Filter scans by url path of _any_ request made by the webpage.
          in: query
          name: path
          schema:
            description: Filter scans by url path of _any_ request made by the webpage.
            example: /samples/subresource-integrity/
            type: string
        - description: Filter scans by IP address (IPv4 or IPv6) of _any_ request made by the webpage.
          in: query
          name: ip
          schema:
            description: Filter scans by IP address (IPv4 or IPv6) of _any_ request made by the webpage.
            example: 1.1.1.1
            type: string
        - description: Filter scans by Autonomous System Number (ASN) of _any_ request made by the webpage.
          in: query
          name: asn
          schema:
            description: Filter scans by Autonomous System Number (ASN) of _any_ request made by the webpage.
            example: "13335"
            type: string
        - description: Filter scans by hash of any html/js/css request made by the webpage.
          in: query
          name: hash
          schema:
            description: Filter scans by hash of any html/js/css request made by the webpage.
            type: string
        - description: Filter scans by submitted or scanned URL
          in: query
          name: page_url
          schema:
            description: Filter scans by submitted or scanned URL
            type: string
        - description: Filter scans by main page hostname (domain of effective URL).
          in: query
          name: page_hostname
          schema:
            description: Filter scans by main page hostname (domain of effective URL).
            type: string
        - description: Filter scans by exact match of effective URL path (also supports suffix search).
          in: query
          name: page_path
          schema:
            description: Filter scans by exact match of effective URL path (also supports suffix search).
            type: string
        - description: Filter scans by main page Autonomous System Number (ASN).
          in: query
          name: page_asn
          schema:
            description: Filter scans by main page Autonomous System Number (ASN).
            type: string
        - description: Filter scans by  main page IP address (IPv4 or IPv6).
          in: query
          name: page_ip
          schema:
            description: Filter scans by  main page IP address (IPv4 or IPv6).
            type: string
        - description: Return only scans created by account.
          in: query
          name: account_scans
          schema:
            description: Return only scans created by account.
            type: boolean
        - description: Filter scans by malicious verdict.
          in: query
          name: is_malicious
          schema:
            description: Filter scans by malicious verdict.
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Error
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          example: OK
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    properties:
                      tasks:
                        items:
                          properties:
                            country:
                              description: Alpha-2 country code
                              type: string
                            success:
                              description: Whether scan was successful or not
                              type: boolean
                            time:
                              description: When scan was submitted (UTC)
                              format: date-time
                              type: string
                            url:
                              description: Scan url (after redirects)
                              example: https://www.example.com/
                              type: string
                            uuid:
                              description: Scan id
                              format: uuid
                              type: string
                            visibility:
                              description: Visibility status.
                              example: public
                              type: string
                          required:
                            - uuid
                            - url
                            - success
                            - time
                            - country
                            - visibility
                          type: object
                        type: array
                    required:
                      - tasks
                    type: object
                  success:
                    description: Whether search request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                  - result
                type: object
          description: Search results
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Scan ID is not a valid uuid.
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                type: object
          description: Invalid params.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Search URL scans
      tags:
        - URL Scanner
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.url-scanner.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Submit a URL to scan. You can also set some options, like the visibility level and custom headers. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/.
      operationId: urlscanner-create-scan
      parameters:
        - description: Account Id
          in: path
          name: accountId
          required: true
          schema:
            description: Account Id
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                customHeaders:
                  additionalProperties:
                    type: string
                  description: Set custom headers
                  type: object
                screenshotsResolutions:
                  default:
                    - desktop
                  description: Take multiple screenshots targeting different device types
                  items:
                    default: desktop
                    description: Device resolutions.
                    enum:
                      - desktop
                      - mobile
                      - tablet
                    type: string
                  type: array
                url:
                  example: https://www.example.com
                  type: string
                visibility:
                  default: Public
                  description: The option `Public` means it will be included in listings like recent scans and search results. `Unlisted` means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material.
                  enum:
                    - Public
                    - Unlisted
                  type: string
              required:
                - url
              type: object
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Submission unsuccessful
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          example: Submission successful
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    properties:
                      time:
                        description: Time when url was submitted for scanning.
                        format: date-time
                        type: string
                      url:
                        description: Canonical form of submitted URL. Use this if you want to later search by URL.
                        type: string
                      uuid:
                        description: Scan ID.
                        format: uuid
                        type: string
                      visibility:
                        description: Submitted visibility status.
                        example: Public
                        type: string
                    required:
                      - visibility
                      - uuid
                      - url
                      - time
                    type: object
                  success:
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                  - result
                type: object
          description: Scan request accepted successfully.
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Scan ID is not a valid uuid.
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                type: object
          description: Invalid params.
        "409":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Submission unsuccessful
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    properties:
                      tasks:
                        items:
                          properties:
                            clientLocation:
                              description: Submitter location
                              example: PT
                              type: string
                            clientType:
                              enum:
                                - Site
                                - Automatic
                                - Api
                              type: string
                            effectiveUrl:
                              description: URL of the primary request, after all HTTP redirects
                              example: http://example.com/
                              type: string
                            errors:
                              items:
                                properties:
                                  message:
                                    type: string
                                required:
                                  - message
                                type: object
                              type: array
                            scannedFrom:
                              properties:
                                colo:
                                  description: IATA code of Cloudflare datacenter
                                  example: MAD
                                  type: string
                              required:
                                - colo
                              type: object
                            status:
                              enum:
                                - Queued
                                - InProgress
                                - InPostProcessing
                                - Finished
                              type: string
                            success:
                              example: true
                              type: boolean
                            time:
                              example: "2023-05-03T17:05:04.843Z"
                              type: string
                            timeEnd:
                              example: "2023-05-03T17:05:19.374Z"
                              type: string
                            url:
                              description: Submitted URL
                              example: http://example.com
                              type: string
                            uuid:
                              description: Scan ID
                              example: 2ee568d0-bf70-4827-b922-b7088c0f056f
                              type: string
                            visibility:
                              enum:
                                - Public
                                - Unlisted
                              type: string
                          required:
                            - uuid
                            - url
                            - status
                            - success
                            - errors
                            - time
                            - timeEnd
                            - visibility
                            - clientLocation
                            - clientType
                            - effectiveUrl
                            - scannedFrom
                          type: object
                        type: array
                    required:
                      - tasks
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                  - result
                type: object
          description: 'Scan request denied: hostname was recently scanned.'
        "429":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Submission unsuccessful
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  success:
                    example: true
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                type: object
          description: 'Scan request denied: rate limited.'
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create URL Scan
      tags:
        - URL Scanner
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.url-scanner.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{accountId}/urlscanner/scan/{scanId}:
    get:
      description: Get URL scan by uuid
      operationId: urlscanner-get-scan
      parameters:
        - description: Scan uuid
          in: path
          name: scanId
          required: true
          schema:
            description: Scan uuid
            format: uuid
            type: string
        - description: Account Id
          in: path
          name: accountId
          required: true
          schema:
            description: Account Id
            type: string
        - description: Whether to return full report (scan summary and network log).
          in: query
          name: full
          schema:
            description: Whether to return full report (scan summary and network log).
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Error
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          example: OK
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    properties:
                      scan:
                        properties:
                          asns:
                            description: Dictionary of Autonomous System Numbers where ASN's are the keys
                            properties:
                              asn:
                                description: ASN's contacted
                                properties:
                                  asn:
                                    example: "15133"
                                    type: string
                                  description:
                                    example: EDGECAST
                                    type: string
                                  location_alpha2:
                                    example: US
                                    type: string
                                  name:
                                    example: EDGECAST
                                    type: string
                                  org_name:
                                    example: Edgecast Inc.
                                    type: string
                                required:
                                  - asn
                                  - name
                                  - description
                                  - org_name
                                  - location_alpha2
                                type: object
                            type: object
                          certificates:
                            items:
                              properties:
                                issuer:
                                  type: string
                                subjectName:
                                  example: rkmod.somee.com
                                  type: string
                                validFrom:
                                  example: 1.6826844e+09
                                  type: number
                                validTo:
                                  example: 1.696698e+09
                                  type: number
                              required:
                                - issuer
                                - subjectName
                                - validFrom
                                - validTo
                              type: object
                            type: array
                          domains:
                            properties:
                              example.com:
                                properties:
                                  categories:
                                    properties:
                                      content:
                                        items:
                                          properties:
                                            id:
                                              type: integer
                                            name:
                                              example: Technology
                                              type: string
                                            super_category_id:
                                              type: integer
                                          required:
                                            - id
                                            - name
                                          type: object
                                        type: array
                                      inherited:
                                        properties:
                                          content:
                                            items:
                                              properties:
                                                id:
                                                  type: integer
                                                name:
                                                  example: Technology
                                                  type: string
                                                super_category_id:
                                                  type: integer
                                              required:
                                                - id
                                                - name
                                              type: object
                                            type: array
                                          from:
                                            example: example.com
                                            type: string
                                          risks:
                                            items:
                                              properties:
                                                id:
                                                  type: integer
                                                name:
                                                  example: Technology
                                                  type: string
                                                super_category_id:
                                                  type: integer
                                              required:
                                                - id
                                                - name
                                              type: object
                                            type: array
                                        type: object
                                      risks:
                                        items:
                                          properties:
                                            id:
                                              type: integer
                                            name:
                                              example: Technology
                                              type: string
                                            super_category_id:
                                              type: integer
                                          required:
                                            - id
                                            - name
                                          type: object
                                        type: array
                                    required:
                                      - inherited
                                    type: object
                                  dns:
                                    items:
                                      properties:
                                        address:
                                          example: 93.184.216.34
                                          type: string
                                        dnssec_valid:
                                          type: boolean
                                        name:
                                          example: example.com
                                          type: string
                                        type:
                                          example: A
                                          type: string
                                      required:
                                        - name
                                        - address
                                        - type
                                        - dnssec_valid
                                      type: object
                                    type: array
                                  name:
                                    example: example.com
                                    type: string
                                  rank:
                                    properties:
                                      bucket:
                                        example: "500"
                                        type: string
                                      name:
                                        example: example.com
                                        type: string
                                      rank:
                                        description: Rank in the Global Radar Rank, if set. See more at https://blog.cloudflare.com/radar-domain-rankings/
                                        type: integer
                                    required:
                                      - name
                                      - bucket
                                    type: object
                                  type:
                                    example: Apex domain
                                    type: string
                                required:
                                  - name
                                  - type
                                  - categories
                                  - dns
                                  - rank
                                type: object
                            type: object
                          geo:
                            properties:
                              continents:
                                description: GeoIP continent location
                                items:
                                  description: GeoIP continent location
                                  example: North America
                                  type: string
                                type: array
                              locations:
                                description: GeoIP country location
                                items:
                                  description: GeoIP country location
                                  example: US
                                  type: string
                                type: array
                            required:
                              - locations
                              - continents
                            type: object
                          ips:
                            properties:
                              ip:
                                properties:
                                  asn:
                                    example: "15133"
                                    type: string
                                  asnDescription:
                                    example: EDGECAST
                                    type: string
                                  asnLocationAlpha2:
                                    example: US
                                    type: string
                                  asnName:
                                    example: EDGECAST
                                    type: string
                                  asnOrgName:
                                    example: Edgecast Inc.
                                    type: string
                                  continent:
                                    example: North America
                                    type: string
                                  geonameId:
                                    example: "6252001"
                                    type: string
                                  ip:
                                    example: 2606:2800:220:1:248:1893:25c8:1946
                                    type: string
                                  ipVersion:
                                    example: IPv6
                                    type: string
                                  latitude:
                                    example: "39.76"
                                    type: string
                                  locationAlpha2:
                                    example: US
                                    type: string
                                  locationName:
                                    example: United States
                                    type: string
                                  longitude:
                                    example: "-98.5"
                                    type: string
                                  subdivision1Name:
                                    type: string
                                  subdivision2Name:
                                    type: string
                                required:
                                  - ip
                                  - ipVersion
                                  - locationAlpha2
                                  - locationName
                                  - subdivision1Name
                                  - subdivision2Name
                                  - latitude
                                  - longitude
                                  - continent
                                  - geonameId
                                  - asn
                                  - asnName
                                  - asnOrgName
                                  - asnDescription
                                  - asnLocationAlpha2
                                type: object
                            type: object
                          links:
                            properties:
                              link:
                                properties:
                                  href:
                                    description: Outgoing link detected in the DOM
                                    example: https://www.iana.org/domains/example
                                    type: string
                                  text:
                                    example: More information...
                                    type: string
                                required:
                                  - href
                                  - text
                                type: object
                            type: object
                          meta:
                            properties:
                              processors:
                                properties:
                                  categories:
                                    properties:
                                      content:
                                        items:
                                          properties:
                                            id:
                                              example: 155
                                              type: integer
                                            name:
                                              example: Technology
                                              type: string
                                            super_category_id:
                                              type: integer
                                          required:
                                            - id
                                            - name
                                          type: object
                                        type: array
                                      risks:
                                        items:
                                          properties:
                                            id:
                                              example: 17
                                              type: integer
                                            name:
                                              example: Newly Seen Domains
                                              type: string
                                            super_category_id:
                                              example: 32
                                              type: integer
                                          required:
                                            - id
                                            - super_category_id
                                            - name
                                          type: object
                                        type: array
                                    required:
                                      - content
                                      - risks
                                    type: object
                                  phishing:
                                    items:
                                      example: CredentialHarvester
                                      type: string
                                    type: array
                                  rank:
                                    properties:
                                      bucket:
                                        example: "500"
                                        type: string
                                      name:
                                        example: example.com
                                        type: string
                                      rank:
                                        description: Rank in the Global Radar Rank, if set. See more at https://blog.cloudflare.com/radar-domain-rankings/
                                        type: integer
                                    required:
                                      - name
                                      - bucket
                                    type: object
                                  tech:
                                    items:
                                      properties:
                                        categories:
                                          items:
                                            properties:
                                              groups:
                                                items:
                                                  type: integer
                                                type: array
                                              id:
                                                example: 63
                                                type: integer
                                              name:
                                                example: IAAS
                                                type: string
                                              priority:
                                                example: 8
                                                type: integer
                                              slug:
                                                example: iaas
                                                type: string
                                            required:
                                              - id
                                              - slug
                                              - groups
                                              - name
                                              - priority
                                            type: object
                                          type: array
                                        confidence:
                                          example: 100
                                          type: integer
                                        description:
                                          type: string
                                        evidence:
                                          properties:
                                            impliedBy:
                                              items:
                                                type: string
                                              type: array
                                            patterns:
                                              items:
                                                properties:
                                                  confidence:
                                                    example: 100
                                                    type: integer
                                                  excludes:
                                                    items:
                                                      type: string
                                                    type: array
                                                  implies:
                                                    items:
                                                      type: string
                                                    type: array
                                                  match:
                                                    example: ECS
                                                    type: string
                                                  name:
                                                    description: Header or Cookie name when set
                                                    example: server
                                                    type: string
                                                  regex:
                                                    example: ^ECS
                                                    type: string
                                                  type:
                                                    example: headers
                                                    type: string
                                                  value:
                                                    example: ECS (dcb/7EEE)
                                                    type: string
                                                  version:
                                                    type: string
                                                required:
                                                  - type
                                                  - regex
                                                  - value
                                                  - match
                                                  - name
                                                  - confidence
                                                  - version
                                                  - implies
                                                  - excludes
                                                type: object
                                              type: array
                                          required:
                                            - patterns
                                            - impliedBy
                                          type: object
                                        icon:
                                          example: Amazon ECS.svg
                                          type: string
                                        name:
                                          example: Amazon ECS
                                          type: string
                                        slug:
                                          example: amazon-ecs
                                          type: string
                                        website:
                                          example: https://aws.amazon.com/ecs/
                                          type: string
                                      required:
                                        - name
                                        - slug
                                        - categories
                                        - confidence
                                        - icon
                                        - website
                                        - evidence
                                      type: object
                                    type: array
                                required:
                                  - tech
                                  - categories
                                  - rank
                                  - phishing
                                type: object
                            required:
                              - processors
                            type: object
                          page:
                            properties:
                              asn:
                                example: "15133"
                                type: string
                              asnLocationAlpha2:
                                example: US
                                type: string
                              asnname:
                                example: EDGECAST
                                type: string
                              console:
                                items:
                                  properties:
                                    category:
                                      example: network
                                      type: string
                                    text:
                                      example: 'Failed to load resource: the server responded with a status of 404 (Not Found)'
                                      type: string
                                    type:
                                      example: error
                                      type: string
                                    url:
                                      example: http://example.com/favicon.ico
                                      type: string
                                  required:
                                    - type
                                    - text
                                    - category
                                  type: object
                                type: array
                              cookies:
                                items:
                                  properties:
                                    domain:
                                      example: rkmod.somee.com
                                      type: string
                                    expires:
                                      example: -1
                                      type: number
                                    httpOnly:
                                      type: boolean
                                    name:
                                      example: b
                                      type: string
                                    path:
                                      example: /
                                      type: string
                                    priority:
                                      example: Medium
                                      type: string
                                    sameParty:
                                      type: boolean
                                    secure:
                                      type: boolean
                                    session:
                                      example: true
                                      type: boolean
                                    size:
                                      example: 2
                                      type: number
                                    sourcePort:
                                      example: 443
                                      type: number
                                    sourceScheme:
                                      example: Secure
                                      type: string
                                    value:
                                      example: b
                                      type: string
                                  required:
                                    - name
                                    - value
                                    - domain
                                    - path
                                    - expires
                                    - size
                                    - httpOnly
                                    - secure
                                    - session
                                    - sameParty
                                    - sourceScheme
                                    - sourcePort
                                  type: object
                                type: array
                              country:
                                example: United States
                                type: string
                              countryLocationAlpha2:
                                example: US
                                type: string
                              domain:
                                example: example.com
                                type: string
                              headers:
                                items:
                                  properties:
                                    name:
                                      example: Content-Length
                                      type: string
                                    value:
                                      example: "648"
                                      type: string
                                  required:
                                    - name
                                    - value
                                  type: object
                                type: array
                              ip:
                                example: 2606:2800:220:1:248:1893:25c8:1946
                                type: string
                              js:
                                properties:
                                  variables:
                                    items:
                                      properties:
                                        name:
                                          example: checkFrame
                                          type: string
                                        type:
                                          example: string
                                          type: string
                                      required:
                                        - name
                                        - type
                                      type: object
                                    type: array
                                required:
                                  - variables
                                type: object
                              securityViolations:
                                items:
                                  properties:
                                    category:
                                      example: csp
                                      type: string
                                    text:
                                      example: '[Report Only] Refused to load the stylesheet ''https://netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css'' because it violates the following Content Security Policy directive: ... '
                                      type: string
                                    url:
                                      example: http://example.com/
                                      type: string
                                  required:
                                    - text
                                    - category
                                    - url
                                  type: object
                                type: array
                              status:
                                example: 200
                                type: number
                              subdivision1Name:
                                type: string
                              subdivision2name:
                                type: string
                              url:
                                example: http://example.com/
                                type: string
                            required:
                              - url
                              - domain
                              - country
                              - countryLocationAlpha2
                              - subdivision1Name
                              - subdivision2name
                              - ip
                              - asn
                              - asnname
                              - asnLocationAlpha2
                              - cookies
                              - headers
                              - status
                              - js
                              - console
                              - securityViolations
                            type: object
                          performance:
                            items:
                              properties:
                                connectEnd:
                                  example: 82.59999999403954
                                  type: number
                                connectStart:
                                  example: 72.79999999701977
                                  type: number
                                decodedBodySize:
                                  example: 1256
                                  type: number
                                domComplete:
                                  example: 306
                                  type: number
                                domContentLoadedEventEnd:
                                  example: 305.8999999910593
                                  type: number
                                domContentLoadedEventStart:
                                  example: 305.8999999910593
                                  type: number
                                domInteractive:
                                  example: 305.8999999910593
                                  type: number
                                domainLookupEnd:
                                  example: 72.79999999701977
                                  type: number
                                domainLookupStart:
                                  example: 2.199999988079071
                                  type: number
                                duration:
                                  example: 306
                                  type: number
                                encodedBodySize:
                                  example: 648
                                  type: number
                                entryType:
                                  example: navigation
                                  type: string
                                fetchStart:
                                  example: 0.8999999910593033
                                  type: number
                                initiatorType:
                                  example: navigation
                                  type: string
                                loadEventEnd:
                                  example: 306
                                  type: number
                                loadEventStart:
                                  example: 306
                                  type: number
                                name:
                                  example: http://example.com/
                                  type: string
                                nextHopProtocol:
                                  example: http/1.1
                                  type: string
                                redirectCount:
                                  type: number
                                redirectEnd:
                                  type: number
                                redirectStart:
                                  type: number
                                requestStart:
                                  example: 82.69999998807907
                                  type: number
                                responseEnd:
                                  example: 270.8999999910593
                                  type: number
                                responseStart:
                                  example: 265.69999998807907
                                  type: number
                                secureConnectionStart:
                                  type: number
                                startTime:
                                  type: number
                                transferSize:
                                  example: 948
                                  type: number
                                type:
                                  example: navigate
                                  type: string
                                unloadEventEnd:
                                  type: number
                                unloadEventStart:
                                  type: number
                                workerStart:
                                  type: number
                              required:
                                - name
                                - entryType
                                - startTime
                                - duration
                                - initiatorType
                                - nextHopProtocol
                                - workerStart
                                - redirectStart
                                - redirectEnd
                                - fetchStart
                                - domainLookupStart
                                - domainLookupEnd
                                - connectStart
                                - connectEnd
                                - secureConnectionStart
                                - requestStart
                                - responseStart
                                - responseEnd
                                - transferSize
                                - encodedBodySize
                                - decodedBodySize
                                - unloadEventStart
                                - unloadEventEnd
                                - domInteractive
                                - domContentLoadedEventStart
                                - domContentLoadedEventEnd
                                - domComplete
                                - loadEventStart
                                - loadEventEnd
                                - type
                                - redirectCount
                              type: object
                            type: array
                          task:
                            properties:
                              clientLocation:
                                description: Submitter location
                                example: PT
                                type: string
                              clientType:
                                enum:
                                  - Site
                                  - Automatic
                                  - Api
                                type: string
                              effectiveUrl:
                                description: URL of the primary request, after all HTTP redirects
                                example: http://example.com/
                                type: string
                              errors:
                                items:
                                  properties:
                                    message:
                                      type: string
                                  required:
                                    - message
                                  type: object
                                type: array
                              scannedFrom:
                                properties:
                                  colo:
                                    description: IATA code of Cloudflare datacenter
                                    example: MAD
                                    type: string
                                required:
                                  - colo
                                type: object
                              status:
                                enum:
                                  - Queued
                                  - InProgress
                                  - InPostProcessing
                                  - Finished
                                type: string
                              success:
                                example: true
                                type: boolean
                              time:
                                example: "2023-05-03T17:05:04.843Z"
                                type: string
                              timeEnd:
                                example: "2023-05-03T17:05:19.374Z"
                                type: string
                              url:
                                description: Submitted URL
                                example: http://example.com
                                type: string
                              uuid:
                                description: Scan ID
                                example: 2ee568d0-bf70-4827-b922-b7088c0f056f
                                type: string
                              visibility:
                                enum:
                                  - Public
                                  - Unlisted
                                type: string
                            required:
                              - uuid
                              - url
                              - status
                              - success
                              - errors
                              - time
                              - timeEnd
                              - visibility
                              - clientLocation
                              - clientType
                              - effectiveUrl
                              - scannedFrom
                            type: object
                          verdicts:
                            properties:
                              overall:
                                properties:
                                  categories:
                                    items:
                                      properties:
                                        id:
                                          example: 117
                                          type: number
                                        name:
                                          example: Malware
                                          type: string
                                        super_category_id:
                                          example: 32
                                          type: number
                                      required:
                                        - id
                                        - super_category_id
                                        - name
                                      type: object
                                    type: array
                                  malicious:
                                    description: At least one of our subsystems marked the site as potentially malicious at the time of the scan.
                                    example: true
                                    type: boolean
                                  phishing:
                                    items:
                                      example: Credential Harvester
                                      type: string
                                    type: array
                                required:
                                  - malicious
                                  - categories
                                  - phishing
                                type: object
                            required:
                              - overall
                            type: object
                        required:
                          - task
                          - meta
                          - page
                          - geo
                          - certificates
                          - performance
                          - verdicts
                        type: object
                    required:
                      - scan
                    type: object
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                  - result
                type: object
          description: Scan has finished. It may or may not have been successful.
        "202":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          example: In Progress
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    properties:
                      scan:
                        properties:
                          task:
                            properties:
                              effectiveUrl:
                                example: http://example.com/
                                type: string
                              errors:
                                items:
                                  properties:
                                    message:
                                      type: string
                                  required:
                                    - message
                                  type: object
                                type: array
                              location:
                                example: PT
                                type: string
                              region:
                                example: enam
                                type: string
                              status:
                                example: InProgress
                                type: string
                              success:
                                example: true
                                type: boolean
                              time:
                                example: "2023-05-03T17:05:04.843Z"
                                type: string
                              url:
                                example: http://example.com
                                type: string
                              uuid:
                                example: 2ee568d0-bf70-4827-b922-b7088c0f056f
                                type: string
                              visibility:
                                example: Public
                                type: string
                            required:
                              - uuid
                              - url
                              - status
                              - success
                              - errors
                              - time
                              - visibility
                              - location
                              - region
                              - effectiveUrl
                            type: object
                        required:
                          - task
                        type: object
                    required:
                      - scan
                    type: object
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                  - result
                type: object
          description: 'Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`.'
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Scan ID is not a valid uuid.
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                type: object
          description: Invalid params.
        "404":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Scan not found.
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                type: object
          description: Scan not found.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get URL scan
      tags:
        - URL Scanner
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.url-scanner.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{accountId}/urlscanner/scan/{scanId}/har:
    get:
      description: Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/.
      operationId: urlscanner-get-scan-har
      parameters:
        - description: Scan uuid
          in: path
          name: scanId
          required: true
          schema:
            description: Scan uuid
            format: uuid
            type: string
        - description: Account Id
          in: path
          name: accountId
          required: true
          schema:
            description: Account Id
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Error
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          example: OK
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    properties:
                      har:
                        properties:
                          log:
                            properties:
                              creator:
                                properties:
                                  comment:
                                    example: https://github.com/sitespeedio/chrome-har
                                    type: string
                                  name:
                                    example: chrome-har
                                    type: string
                                  version:
                                    example: 0.13.1
                                    type: string
                                required:
                                  - name
                                  - version
                                  - comment
                                type: object
                              entries:
                                items:
                                  properties:
                                    _initialPriority:
                                      example: VeryHigh
                                      type: string
                                    _initiator_type:
                                      example: other
                                      type: string
                                    _priority:
                                      example: VeryHigh
                                      type: string
                                    _requestId:
                                      example: DDC779F0CB3746BAF283EC1A51B0F2F8
                                      type: string
                                    _requestTime:
                                      example: 114135.331081
                                      type: number
                                    _resourceType:
                                      example: document
                                      type: string
                                    cache:
                                      type: object
                                    connection:
                                      example: "33"
                                      type: string
                                    pageref:
                                      example: page_1
                                      type: string
                                    request:
                                      properties:
                                        bodySize:
                                          type: number
                                        headers:
                                          items:
                                            properties:
                                              name:
                                                example: Upgrade-Insecure-Requests
                                                type: string
                                              value:
                                                example: "1"
                                                type: string
                                            required:
                                              - name
                                              - value
                                            type: object
                                          type: array
                                        headersSize:
                                          example: 197
                                          type: number
                                        httpVersion:
                                          example: http/1.1
                                          type: string
                                        method:
                                          example: GET
                                          type: string
                                        url:
                                          example: http://example.com/
                                          type: string
                                      required:
                                        - method
                                        - url
                                        - headersSize
                                        - bodySize
                                        - headers
                                        - httpVersion
                                      type: object
                                    response:
                                      properties:
                                        _transferSize:
                                          example: 1071
                                          type: number
                                        bodySize:
                                          example: 648
                                          type: number
                                        content:
                                          properties:
                                            compression:
                                              example: 608
                                              type: integer
                                            mimeType:
                                              example: text/html
                                              type: string
                                            size:
                                              example: 1256
                                              type: number
                                          required:
                                            - mimeType
                                            - size
                                          type: object
                                        headers:
                                          items:
                                            properties:
                                              name:
                                                example: Content-Encoding
                                                type: string
                                              value:
                                                example: gzip
                                                type: string
                                            required:
                                              - name
                                              - value
                                            type: object
                                          type: array
                                        headersSize:
                                          example: 423
                                          type: number
                                        httpVersion:
                                          example: http/1.1
                                          type: string
                                        redirectURL:
                                          type: string
                                        status:
                                          example: 200
                                          type: number
                                        statusText:
                                          example: OK
                                          type: string
                                      required:
                                        - httpVersion
                                        - redirectURL
                                        - status
                                        - statusText
                                        - content
                                        - headersSize
                                        - bodySize
                                        - headers
                                        - _transferSize
                                      type: object
                                    serverIPAddress:
                                      example: 2606:2800:220:1:248:1893:25c8:1946
                                      type: string
                                    startedDateTime:
                                      example: "2023-05-03T17:05:13.196Z"
                                      type: string
                                    time:
                                      example: 268.64
                                      type: number
                                  required:
                                    - cache
                                    - startedDateTime
                                    - _requestId
                                    - _initialPriority
                                    - _priority
                                    - pageref
                                    - request
                                    - time
                                    - _initiator_type
                                    - _resourceType
                                    - response
                                    - connection
                                    - serverIPAddress
                                    - _requestTime
                                  type: object
                                type: array
                              pages:
                                items:
                                  properties:
                                    id:
                                      example: page_1
                                      type: string
                                    pageTimings:
                                      properties:
                                        onContentLoad:
                                          example: 305.408
                                          type: number
                                        onLoad:
                                          example: 305.169
                                          type: number
                                      required:
                                        - onLoad
                                        - onContentLoad
                                      type: object
                                    startedDateTime:
                                      example: "2023-05-03T17:05:13.195Z"
                                      type: string
                                    title:
                                      example: http://example.com/
                                      type: string
                                  required:
                                    - id
                                    - startedDateTime
                                    - title
                                    - pageTimings
                                  type: object
                                type: array
                              version:
                                example: "1.2"
                                type: string
                            required:
                              - version
                              - creator
                              - pages
                              - entries
                            type: object
                        required:
                          - log
                        type: object
                    required:
                      - har
                    type: object
                  success:
                    description: Whether search request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                  - result
                type: object
          description: Returns the scan's har.
        "202":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          example: In Progress
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    properties:
                      scan:
                        properties:
                          task:
                            properties:
                              effectiveUrl:
                                example: http://example.com/
                                type: string
                              errors:
                                items:
                                  properties:
                                    message:
                                      type: string
                                  required:
                                    - message
                                  type: object
                                type: array
                              location:
                                example: PT
                                type: string
                              region:
                                example: enam
                                type: string
                              status:
                                example: InProgress
                                type: string
                              success:
                                example: true
                                type: boolean
                              time:
                                example: "2023-05-03T17:05:04.843Z"
                                type: string
                              url:
                                example: http://example.com
                                type: string
                              uuid:
                                example: 2ee568d0-bf70-4827-b922-b7088c0f056f
                                type: string
                              visibility:
                                example: Public
                                type: string
                            required:
                              - uuid
                              - url
                              - status
                              - success
                              - errors
                              - time
                              - visibility
                              - location
                              - region
                              - effectiveUrl
                            type: object
                        required:
                          - task
                        type: object
                    required:
                      - scan
                    type: object
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                  - result
                type: object
          description: 'Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`.'
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Scan ID is not a valid uuid.
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                type: object
          description: Invalid params.
        "404":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Scan not found.
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                type: object
          description: Scan not found.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get URL scan's HAR
      tags:
        - URL Scanner
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.url-scanner.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{accountId}/urlscanner/scan/{scanId}/screenshot:
    get:
      description: Get scan's screenshot by resolution (desktop/mobile/tablet).
      operationId: urlscanner-get-scan-screenshot
      parameters:
        - description: Scan uuid
          in: path
          name: scanId
          required: true
          schema:
            description: Scan uuid
            format: uuid
            type: string
        - description: Account Id
          in: path
          name: accountId
          required: true
          schema:
            description: Account Id
            type: string
        - description: Target device type
          in: query
          name: resolution
          schema:
            default: desktop
            description: Target device type
            enum:
              - desktop
              - mobile
              - tablet
            type: string
      responses:
        "200":
          content:
            image/png:
              schema:
                description: PNG Image
                type: string
          description: Returns the scan's requested screenshot.
        "202":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          example: In Progress
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    properties:
                      scan:
                        properties:
                          task:
                            properties:
                              effectiveUrl:
                                example: http://example.com/
                                type: string
                              errors:
                                items:
                                  properties:
                                    message:
                                      type: string
                                  required:
                                    - message
                                  type: object
                                type: array
                              location:
                                example: PT
                                type: string
                              region:
                                example: enam
                                type: string
                              status:
                                example: InProgress
                                type: string
                              success:
                                example: true
                                type: boolean
                              time:
                                example: "2023-05-03T17:05:04.843Z"
                                type: string
                              url:
                                example: http://example.com
                                type: string
                              uuid:
                                example: 2ee568d0-bf70-4827-b922-b7088c0f056f
                                type: string
                              visibility:
                                example: Public
                                type: string
                            required:
                              - uuid
                              - url
                              - status
                              - success
                              - errors
                              - time
                              - visibility
                              - location
                              - region
                              - effectiveUrl
                            type: object
                        required:
                          - task
                        type: object
                    required:
                      - scan
                    type: object
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                  - result
                type: object
          description: 'Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`.'
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Scan ID is not a valid uuid.
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                type: object
          description: Invalid params.
        "404":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          example: Scan not found.
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  messages:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  success:
                    description: Whether request was successful or not
                    type: boolean
                required:
                  - messages
                  - errors
                  - success
                type: object
          description: Scan not found.
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get screenshot
      tags:
        - URL Scanner
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.account.url-scanner.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /certificates:
    get:
      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
      parameters:
        - in: query
          name: zone_id
          schema:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_collection'
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: List Certificates response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_collection'
          description: List Certificates response
      security:
        - user_service_key: []
      summary: APIs.io Engineering Platform List Certificates
      tags:
        - Origin CA
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      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:
        content:
          application/json:
            schema:
              properties:
                csr:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_csr'
                hostnames:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_hostnames'
                request_type:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_request_type'
                requested_validity:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_requested_validity'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single'
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: Create Certificate response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single'
          description: Create Certificate response
      security:
        - user_service_key: []
      summary: APIs.io Engineering Platform Create Certificate
      tags:
        - Origin CA
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /certificates/{certificate_id}:
    delete:
      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:
        - in: path
          name: certificate_id
          required: true
          schema:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_revoke_response'
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: Revoke Certificate response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_revoke_response'
          description: Revoke Certificate response
      security:
        - user_service_key: []
      summary: APIs.io Engineering Platform Revoke Certificate
      tags:
        - Origin CA
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      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:
        - in: path
          name: certificate_id
          required: true
          schema:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single'
                  - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: Get Certificate response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single'
          description: Get Certificate response
      security:
        - user_service_key: []
      summary: APIs.io Engineering Platform Get Certificate
      tags:
        - Origin CA
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /ips:
    get:
      description: Get IPs used on the Cloudflare/JD Cloud network, see https://www.cloudflare.com/ips for Cloudflare IPs or https://developers.cloudflare.com/china-network/reference/infrastructure/ for JD Cloud IPs.
      operationId: cloudflare-i-ps-cloudflare-ip-details
      parameters:
        - description: Specified as `jdcloud` to list IPs used by JD Cloud data centers.
          in: query
          name: networks
          schema:
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - allOf:
                      - $ref: '#/components/schemas/addressing_api-response-single'
                      - properties:
                          result:
                            oneOf:
                              - $ref: '#/components/schemas/addressing_ips'
                              - $ref: '#/components/schemas/addressing_ips_jdcloud'
                  - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Cloudflare IP Details response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/addressing_api-response-single'
                  - properties:
                      result:
                        oneOf:
                          - $ref: '#/components/schemas/addressing_ips'
                          - $ref: '#/components/schemas/addressing_ips_jdcloud'
          description: Cloudflare IP Details response
      security:
        - {}
      summary: APIs.io Engineering Platform Cloudflare/JD Cloud IP Details
      tags:
        - Cloudflare IPs
  /memberships:
    get:
      description: List memberships of accounts the user can access.
      operationId: user'-s-account-memberships-list-memberships
      parameters:
        - in: query
          name: account.name
          schema:
            $ref: '#/components/schemas/iam_properties-name'
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 20
            description: Number of memberships per page.
            maximum: 50
            minimum: 5
            type: number
        - in: query
          name: order
          schema:
            description: Field to order memberships by.
            enum:
              - id
              - account.name
              - status
            example: status
            type: string
        - in: query
          name: direction
          schema:
            description: Direction to order memberships.
            enum:
              - asc
              - desc
            example: desc
            type: string
        - in: query
          name: name
          schema:
            $ref: '#/components/schemas/iam_properties-name'
        - in: query
          name: status
          schema:
            description: Status of this membership.
            enum:
              - accepted
              - pending
              - rejected
            example: accepted
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Memberships response failure
        "200":
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/iam_collection_membership_response'
                  - $ref: '#/components/schemas/iam_collection_membership_response_with_policies'
          description: List Memberships response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Memberships
      tags:
        - User's Account Memberships
      x-api-token-group:
        - Memberships Write
        - Memberships Read
  /memberships/{membership_id}:
    delete:
      description: Remove the associated member from an account.
      operationId: user'-s-account-memberships-delete-membership
      parameters:
        - in: path
          name: membership_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Delete Membership response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/iam_api-response-single'
                  - properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
                    type: object
          description: Delete Membership response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Membership
      tags:
        - User's Account Memberships
      x-api-token-group:
        - Memberships Write
    get:
      description: Get a specific membership.
      operationId: user'-s-account-memberships-membership-details
      parameters:
        - in: path
          name: membership_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Membership Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_membership_response_with_policies'
          description: Membership Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Membership Details
      tags:
        - User's Account Memberships
      x-api-token-group:
        - Memberships Write
        - Memberships Read
    put:
      description: Accept or reject this account invitation.
      operationId: user'-s-account-memberships-update-membership
      parameters:
        - in: path
          name: membership_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                status:
                  description: Whether to accept or reject this account invitation.
                  enum:
                    - accepted
                    - rejected
                  example: accepted
              required:
                - status
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Update Membership response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_membership_response_with_policies'
          description: Update Membership response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update Membership
      tags:
        - User's Account Memberships
      x-api-token-group:
        - Memberships Write
  /organizations/{organization_id}/audit_logs:
    get:
      deprecated: true
      description: Gets a list of audit logs for an organization. Can be filtered by who made the change, on which zone, and the timeframe of the change.
      operationId: audit-logs-get-organization-audit-logs
      parameters:
        - in: path
          name: organization_id
          required: true
          schema:
            $ref: '#/components/schemas/aaa_identifier'
        - in: query
          name: id
          schema:
            description: Finds a specific log by its ID.
            example: f174be97-19b1-40d6-954d-70cd5fbd52db
            type: string
        - in: query
          name: export
          schema:
            description: Indicates that this request is an export of logs in CSV format.
            example: true
            type: boolean
        - in: query
          name: action.type
          schema:
            description: Filters by the action type.
            example: add
            type: string
        - in: query
          name: actor.ip
          schema:
            description: Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.
            example: 17.168.228.63
            type: string
        - in: query
          name: actor.email
          schema:
            description: Filters by the email address of the actor that made the change.
            example: alice@example.com
            format: email
            type: string
        - in: query
          name: since
          schema:
            oneOf:
              - description: Limits the returned results to logs newer than the specified date. A `full-date` that conforms to RFC3339.
                example: "2019-04-30"
                format: date
                type: string
              - description: Limits the returned results to logs newer than the specified date. A `date-time` that conforms to RFC3339.
                example: "2019-04-30T01:12:20Z"
                format: date-time
                type: string
        - in: query
          name: before
          schema:
            oneOf:
              - description: Limits the returned results to logs older than the specified date. A `full-date` that conforms to RFC3339.
                example: "2019-04-30"
                format: date
                type: string
              - description: Limits the returned results to logs older than the specified date. A `date-time` that conforms to RFC3339.
                example: "2019-04-30T01:12:20Z"
                format: date-time
                type: string
        - in: query
          name: zone.name
          schema:
            description: Filters by the name of the zone associated to the change.
            example: example.com
            type: string
        - in: query
          name: direction
          schema:
            default: desc
            description: Changes the direction of the chronological sorting.
            enum:
              - desc
              - asc
            example: desc
            type: string
        - in: query
          name: per_page
          schema:
            default: 100
            description: Sets the number of results to return per page.
            example: 25
            maximum: 1000
            minimum: 1
            type: number
        - in: query
          name: page
          schema:
            default: 1
            description: Defines which page of results to return.
            example: 50
            minimum: 1
            type: number
        - in: query
          name: hide_user_logs
          schema:
            default: false
            description: Indicates whether or not to hide user level audit logs.
            type: boolean
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_audit_logs_response_collection'
                  - $ref: '#/components/schemas/aaa_api-response-common-failure'
          description: Get organization audit logs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_audit_logs_response_collection'
          description: Get organization audit logs response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get organization audit logs
      tags:
        - Audit Logs
      x-cfDeprecation:
        description: This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
        display: true
        eol: "2020-02-04"
        id: org_deprecation
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /radar/ai/gateway/summary/provider:
    get:
      description: Percentage distribution of unique accounts per provider.
      operationId: radar-get-ai-gateway-summary-by-provider
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          anthropic: "8.381743"
                          openai: "63.40249"
                          workers-ai: "10.274394"
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Providers Summary
      tags:
        - Radar AI Gateway
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/ai/gateway/timeseries_groups/provider:
    get:
      description: Percentage distribution of unique accounts per provider over time.
      operationId: radar-get-ai-gateway-timeseries-group-by-provider
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
          in: query
          name: limitPerGroup
          schema:
            description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
            example: 4
            type: integer
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          openai:
                            - "67.701863"
                          timestamps:
                            - "2024-07-30T03:00:00Z"
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Providers Time Series
      tags:
        - Radar AI Gateway
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/ai/inference/summary/model:
    get:
      description: Percentage distribution of unique accounts per model.
      operationId: radar-get-ai-inference-summary-by-model
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          '@cf/meta/llama-3-8b-instruct': "8.381743"
                          '@cf/meta/m2m100-1.2b': "22.904"
                          '@cf/stabilityai/stable-diffusion-xl-base-1.0': "10.274394"
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Models Summary
      tags:
        - Radar AI Inference
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/ai/inference/summary/task:
    get:
      description: Percentage distribution of unique accounts per task.
      operationId: radar-get-ai-inference-summary-by-task
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          text generation: "10.274394"
                          text-to-image: "22.904"
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Tasks Summary
      tags:
        - Radar AI Inference
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/ai/inference/timeseries_groups/model:
    get:
      description: Percentage distribution of unique accounts per model over time.
      operationId: radar-get-ai-inference-timeseries-group-by-model
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
          in: query
          name: limitPerGroup
          schema:
            description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
            example: 4
            type: integer
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          '@cf/meta/m2m100-1.2b':
                            - "67.701863"
                          timestamps:
                            - "2024-07-30T03:00:00Z"
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Models Time Series
      tags:
        - Radar AI Inference
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/ai/inference/timeseries_groups/task:
    get:
      description: Percentage distribution of unique accounts per task over time.
      operationId: radar-get-ai-inference-timeseries-group-by-task
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
          in: query
          name: limitPerGroup
          schema:
            description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
            example: 4
            type: integer
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          text-to-image:
                            - "67.701863"
                          timestamps:
                            - "2024-07-30T03:00:00Z"
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Tasks Time Series
      tags:
        - Radar AI Inference
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/annotations:
    get:
      operationId: radar-get-annotations
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Number of objects to skip before grabbing results.
          in: query
          name: offset
          schema:
            description: Number of objects to skip before grabbing results.
            type: integer
        - description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
          in: query
          name: dateRange
          schema:
            description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
            example: 7d
            pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
            type: string
        - description: Start of the date range (inclusive).
          in: query
          name: dateStart
          schema:
            description: Start of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - description: Single ASN as integer.
          in: query
          name: asn
          schema:
            description: Single ASN as integer.
            example: "174"
            type: integer
        - description: Location Alpha2 code.
          in: query
          name: location
          schema:
            description: Location Alpha2 code.
            example: US
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      annotations:
                        items:
                          properties:
                            asns:
                              items:
                                example: 189
                                type: integer
                              type: array
                            asnsDetails:
                              items:
                                properties:
                                  asn:
                                    example: "189"
                                    type: string
                                  locations:
                                    properties:
                                      code:
                                        example: US
                                        type: string
                                      name:
                                        example: United States
                                        type: string
                                    required:
                                      - code
                                      - name
                                    type: object
                                  name:
                                    example: LUMEN-LEGACY-L3-PARTITION
                                    type: string
                                required:
                                  - asn
                                  - name
                                type: object
                              type: array
                            dataSource:
                              example: ALL
                              type: string
                            description:
                              example: example
                              type: string
                            endDate:
                              example: "2022-09-08T10:00:28Z"
                              type: string
                            eventType:
                              example: OUTAGE
                              type: string
                            id:
                              example: "550"
                              type: string
                            linkedUrl:
                              example: http://example.com
                              type: string
                            locations:
                              items:
                                example: US
                                type: string
                              type: array
                            locationsDetails:
                              items:
                                properties:
                                  code:
                                    example: US
                                    type: string
                                  name:
                                    example: United States
                                    type: string
                                required:
                                  - code
                                  - name
                                type: object
                              type: array
                            outage:
                              properties:
                                outageCause:
                                  example: CABLE_CUT
                                  type: string
                                outageType:
                                  example: NATIONWIDE
                                  type: string
                              required:
                                - outageCause
                                - outageType
                              type: object
                            scope:
                              example: Colima, Michoacán, México
                              type: string
                            startDate:
                              example: "2022-09-06T10:00:28Z"
                              type: string
                          required:
                            - id
                            - dataSource
                            - startDate
                            - asns
                            - asnsDetails
                            - locations
                            - locationsDetails
                            - eventType
                            - outage
                          type: object
                        type: array
                    required:
                      - annotations
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get latest annotations.
      tags:
        - Radar Annotations
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/annotations/outages:
    get:
      operationId: radar-get-annotations-outages
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Number of objects to skip before grabbing results.
          in: query
          name: offset
          schema:
            description: Number of objects to skip before grabbing results.
            type: integer
        - description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
          in: query
          name: dateRange
          schema:
            description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
            example: 7d
            pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
            type: string
        - description: Start of the date range (inclusive).
          in: query
          name: dateStart
          schema:
            description: Start of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - description: Single ASN as integer.
          in: query
          name: asn
          schema:
            description: Single ASN as integer.
            example: "174"
            type: integer
        - description: Location Alpha2 code.
          in: query
          name: location
          schema:
            description: Location Alpha2 code.
            example: US
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      annotations:
                        items:
                          properties:
                            asns:
                              items:
                                example: 189
                                type: integer
                              type: array
                            asnsDetails:
                              items:
                                properties:
                                  asn:
                                    example: "189"
                                    type: string
                                  locations:
                                    properties:
                                      code:
                                        example: US
                                        type: string
                                      name:
                                        example: United States
                                        type: string
                                    required:
                                      - code
                                      - name
                                    type: object
                                  name:
                                    example: LUMEN-LEGACY-L3-PARTITION
                                    type: string
                                required:
                                  - asn
                                  - name
                                type: object
                              type: array
                            dataSource:
                              example: ALL
                              type: string
                            description:
                              example: example
                              type: string
                            endDate:
                              example: "2022-09-08T10:00:28Z"
                              type: string
                            eventType:
                              example: OUTAGE
                              type: string
                            id:
                              example: "550"
                              type: string
                            linkedUrl:
                              example: http://example.com
                              type: string
                            locations:
                              items:
                                example: US
                                type: string
                              type: array
                            locationsDetails:
                              items:
                                properties:
                                  code:
                                    example: US
                                    type: string
                                  name:
                                    example: United States
                                    type: string
                                required:
                                  - code
                                  - name
                                type: object
                              type: array
                            outage:
                              properties:
                                outageCause:
                                  example: CABLE_CUT
                                  type: string
                                outageType:
                                  example: NATIONWIDE
                                  type: string
                              required:
                                - outageCause
                                - outageType
                              type: object
                            scope:
                              example: Colima, Michoacán, México
                              type: string
                            startDate:
                              example: "2022-09-06T10:00:28Z"
                              type: string
                          required:
                            - id
                            - dataSource
                            - startDate
                            - asns
                            - asnsDetails
                            - locations
                            - locationsDetails
                            - eventType
                            - outage
                          type: object
                        type: array
                    required:
                      - annotations
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get latest Internet outages and anomalies.
      tags:
        - Radar Annotations
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/annotations/outages/locations:
    get:
      operationId: radar-get-annotations-outages-top
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
          in: query
          name: dateRange
          schema:
            description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
            example: 7d
            pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
            type: string
        - description: Start of the date range (inclusive).
          in: query
          name: dateStart
          schema:
            description: Start of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      annotations:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: PT
                              type: string
                            clientCountryName:
                              example: Portugal
                              type: string
                            value:
                              example: "5"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - annotations
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get the number of outages for locations.
      tags:
        - Radar Annotations
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/summary/dnssec:
    get:
      description: Percentage distribution of DNS queries to AS112 by DNSSEC support.
      operationId: radar-get-dns-as112-timeseries-by-dnssec
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          NOT_SUPPORTED:
                            example: "16"
                            type: string
                          SUPPORTED:
                            example: "84"
                            type: string
                        required:
                          - SUPPORTED
                          - NOT_SUPPORTED
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get AS112 DNSSEC Summary
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/summary/edns:
    get:
      description: Percentage distribution of DNS queries, to AS112, by EDNS support.
      operationId: radar-get-dns-as112-timeseries-by-edns
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          NOT_SUPPORTED:
                            example: "6"
                            type: string
                          SUPPORTED:
                            example: "94"
                            type: string
                        required:
                          - SUPPORTED
                          - NOT_SUPPORTED
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get AS112 EDNS Summary
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/summary/ip_version:
    get:
      description: Percentage distribution of DNS queries to AS112 per IP Version.
      operationId: radar-get-dns-as112-timeseries-by-ip-version
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          IPv4:
                            example: "80"
                            type: string
                          IPv6:
                            example: "20"
                            type: string
                        required:
                          - IPv4
                          - IPv6
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get AS112 IP Version Summary
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/summary/protocol:
    get:
      description: Percentage distribution of DNS queries to AS112 per protocol.
      operationId: radar-get-dns-as112-timeseries-by-protocol
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          tcp:
                            example: "1"
                            type: string
                          udp:
                            example: "99"
                            type: string
                        required:
                          - udp
                          - tcp
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get AS112 DNS Protocol Summary
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/summary/query_type:
    get:
      description: Percentage distribution of DNS queries to AS112 by Query Type.
      operationId: radar-get-dns-as112-timeseries-by-query-type
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          A:
                            example: "19"
                            type: string
                          AAAA:
                            example: "1"
                            type: string
                          PTR:
                            example: "74"
                            type: string
                          SOA:
                            example: "5"
                            type: string
                          SRV:
                            example: "1"
                            type: string
                        required:
                          - PTR
                          - A
                          - SOA
                          - AAAA
                          - SRV
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get AS112 Query Types Summary
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/summary/response_codes:
    get:
      description: Percentage distribution of AS112 dns requests classified per Response Codes.
      operationId: radar-get-dns-as112-timeseries-by-response-codes
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          NOERROR:
                            example: "6"
                            type: string
                          NXDOMAIN:
                            example: "94"
                            type: string
                        required:
                          - NXDOMAIN
                          - NOERROR
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get a summary of AS112 Response Codes
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/timeseries:
    get:
      description: Get AS112 queries change over time.
      operationId: radar-get-dns-as112-timeseries
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          aggInterval:
                            example: 1h
                            type: string
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            format: date-time
                            type: string
                        required:
                          - dateRange
                          - aggInterval
                          - lastUpdated
                        type: object
                      serie_0:
                        properties:
                          timestamps:
                            items:
                              format: date-time
                              type: string
                            type: array
                          values:
                            items:
                              example: 0.56
                              type: string
                            type: array
                        required:
                          - timestamps
                          - values
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get AS112 DNS Queries Time Series
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/timeseries_groups/dnssec:
    get:
      description: Percentage distribution of DNS AS112 queries by DNSSEC support over time.
      operationId: radar-get-dns-as112-timeseries-group-by-dnssec
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          NOT_SUPPORTED:
                            items:
                              example: "16"
                              type: string
                            type: array
                          SUPPORTED:
                            items:
                              example: "84"
                              type: string
                            type: array
                        required:
                          - SUPPORTED
                          - NOT_SUPPORTED
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get AS112 DNSSEC Support Time Series
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/timeseries_groups/edns:
    get:
      description: Percentage distribution of AS112 DNS queries by EDNS support over time.
      operationId: radar-get-dns-as112-timeseries-group-by-edns
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          NOT_SUPPORTED:
                            items:
                              example: "6"
                              type: string
                            type: array
                          SUPPORTED:
                            items:
                              example: "94"
                              type: string
                            type: array
                        required:
                          - SUPPORTED
                          - NOT_SUPPORTED
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get AS112 EDNS Support Summary
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/timeseries_groups/ip_version:
    get:
      description: Percentage distribution of AS112 DNS queries by IP Version over time.
      operationId: radar-get-dns-as112-timeseries-group-by-ip-version
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          IPv4:
                            items:
                              example: "80"
                              type: string
                            type: array
                          IPv6:
                            items:
                              example: "20"
                              type: string
                            type: array
                        required:
                          - IPv4
                          - IPv6
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get AS112 IP Version Time Series
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/timeseries_groups/protocol:
    get:
      description: Percentage distribution of AS112 dns requests classified per Protocol over time.
      operationId: radar-get-dns-as112-timeseries-group-by-protocol
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          tcp:
                            items:
                              example: "1"
                              type: string
                            type: array
                          udp:
                            items:
                              example: "99"
                              type: string
                            type: array
                        required:
                          - udp
                          - tcp
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get AS112 DNS Protocol Time Series
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/timeseries_groups/query_type:
    get:
      description: Percentage distribution of AS112 DNS queries by Query Type over time.
      operationId: radar-get-dns-as112-timeseries-group-by-query-type
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          A:
                            items:
                              example: "19"
                              type: string
                            type: array
                          AAAA:
                            items:
                              example: "1"
                              type: string
                            type: array
                          PTR:
                            items:
                              example: "74"
                              type: string
                            type: array
                          SOA:
                            items:
                              example: "5"
                              type: string
                            type: array
                          SRV:
                            items:
                              example: "1"
                              type: string
                            type: array
                        required:
                          - PTR
                          - A
                          - SOA
                          - AAAA
                          - SRV
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get AS112 Query Types Time Series
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/timeseries_groups/response_codes:
    get:
      description: Percentage distribution of AS112 dns requests classified per Response Codes over time.
      operationId: radar-get-dns-as112-timeseries-group-by-response-codes
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          NOERROR:
                            items:
                              example: "6"
                              type: string
                            type: array
                          NXDOMAIN:
                            items:
                              example: "94"
                              type: string
                            type: array
                        required:
                          - NXDOMAIN
                          - NOERROR
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get a time series of AS112 Response Codes
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/top/locations:
    get:
      description: Get the top locations by AS112 DNS queries. Values are a percentage out of the total queries.
      operationId: radar-get-dns-as112-top-locations
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get top autonomous systems by AS112 DNS queries
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/top/locations/dnssec/{dnssec}:
    get:
      description: Get the top locations by DNS queries DNSSEC support to AS112.
      operationId: radar-get-dns-as112-top-locations-by-dnssec
      parameters:
        - description: DNSSEC.
          in: path
          name: dnssec
          required: true
          schema:
            description: DNSSEC.
            enum:
              - SUPPORTED
              - NOT_SUPPORTED
            example: SUPPORTED
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations By DNS Queries DNSSEC Support
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/top/locations/edns/{edns}:
    get:
      description: Get the top locations, by DNS queries EDNS support to AS112.
      operationId: radar-get-dns-as112-top-locations-by-edns
      parameters:
        - description: EDNS.
          in: path
          name: edns
          required: true
          schema:
            description: EDNS.
            enum:
              - SUPPORTED
              - NOT_SUPPORTED
            example: SUPPORTED
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations By EDNS Support
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/as112/top/locations/ip_version/{ip_version}:
    get:
      description: Get the top locations by DNS queries IP version to AS112.
      operationId: radar-get-dns-as112-top-locations-by-ip-version
      parameters:
        - description: IP Version.
          in: path
          name: ip_version
          required: true
          schema:
            description: IP Version.
            enum:
              - IPv4
              - IPv6
            example: IPv4
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations by DNS Queries IP version
      tags:
        - Radar AS112
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/summary:
    get:
      deprecated: true
      description: Percentage distribution of network protocols in layer 3/4 attacks over a given time period.
      operationId: radar-get-attacks-layer3-summary
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                        required:
                          - dateRange
                        type: object
                      summary_0:
                        properties:
                          gre:
                            example: "0.9"
                            type: string
                          icmp:
                            example: "0.1"
                            type: string
                          tcp:
                            example: "60"
                            type: string
                          udp:
                            example: "39"
                            type: string
                        required:
                          - tcp
                          - udp
                          - gre
                          - icmp
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 3 Attacks Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/summary/bitrate:
    get:
      description: Percentage distribution of attacks by bitrate.
      operationId: radar-get-attacks-layer3-summary-by-bitrate
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          _1_GBPS_TO_10_GBPS:
                            example: "6.007082"
                            type: string
                          _10_GBPS_TO_100_GBPS:
                            example: "0.01056"
                            type: string
                          _500_MBPS_TO_1_GBPS:
                            example: "5.948652"
                            type: string
                          OVER_100_GBPS:
                            example: "13.141944"
                            type: string
                          UNDER_500_MBPS:
                            example: "74.891763"
                            type: string
                        required:
                          - UNDER_500_MBPS
                          - OVER_100_GBPS
                          - _1_GBPS_TO_10_GBPS
                          - _500_MBPS_TO_1_GBPS
                          - _10_GBPS_TO_100_GBPS
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Attack Bitrate Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/summary/duration:
    get:
      description: Percentage distribution of attacks by duration.
      operationId: radar-get-attacks-layer3-summary-by-duration
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          _1_HOUR_TO_3_HOURS:
                            example: "4.038413"
                            type: string
                          _10_MINS_TO_20_MINS:
                            example: "9.48709"
                            type: string
                          _20_MINS_TO_40_MINS:
                            example: "3.87624"
                            type: string
                          _40_MINS_TO_1_HOUR:
                            example: "1.892012"
                            type: string
                          OVER_3_HOURS:
                            example: "4.462923"
                            type: string
                          UNDER_10_MINS:
                            example: "76.243322"
                            type: string
                        required:
                          - UNDER_10_MINS
                          - _10_MINS_TO_20_MINS
                          - OVER_3_HOURS
                          - _1_HOUR_TO_3_HOURS
                          - _20_MINS_TO_40_MINS
                          - _40_MINS_TO_1_HOUR
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Attack Durations Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/summary/ip_version:
    get:
      description: Percentage distribution of attacks by ip version used.
      operationId: radar-get-attacks-layer3-summary-by-ip-version
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          IPv4:
                            example: "99.984766"
                            type: string
                          IPv6:
                            example: "0.015234"
                            type: string
                        required:
                          - IPv4
                          - IPv6
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get IP Versions Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/summary/protocol:
    get:
      description: Percentage distribution of attacks by protocol used.
      operationId: radar-get-attacks-layer3-summary-by-protocol
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          GRE:
                            example: "0.756379"
                            type: string
                          ICMP:
                            example: "0.015245"
                            type: string
                          TCP:
                            example: "82.89908"
                            type: string
                          UDP:
                            example: "16.328986"
                            type: string
                        required:
                          - TCP
                          - UDP
                          - GRE
                          - ICMP
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 3 Protocols Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/summary/vector:
    get:
      description: Percentage distribution of attacks by vector.
      operationId: radar-get-attacks-layer3-summary-by-vector
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          ACK Flood:
                            - "65.662148"
                          SYN Flood:
                            - "16.86401"
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Attack Vector Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/timeseries:
    get:
      description: Get attacks change over time by bytes.
      operationId: radar-get-attacks-layer3-timeseries-by-bytes
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE_CHANGE
              - MIN0_MAX
            example: MIN0_MAX
            type: string
        - description: Measurement units, eg. bytes.
          in: query
          name: metric
          schema:
            default: bytes
            description: Measurement units, eg. bytes.
            enum:
              - BYTES
              - BYTES_OLD
            type: string
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                          values:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                          - values
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Attacks By Bytes Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/timeseries_groups:
    get:
      deprecated: true
      description: Get a timeseries of the percentage distribution of network protocols in Layer 3/4 attacks.
      operationId: radar-get-attacks-layer3-timeseries-groups
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          aggInterval:
                            example: 1h
                            type: string
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            format: date-time
                            type: string
                        required:
                          - dateRange
                          - aggInterval
                          - lastUpdated
                        type: object
                      serie_0:
                        properties:
                          gre:
                            items:
                              example: "0.9"
                              type: string
                            type: array
                          icmp:
                            items:
                              example: "0.1"
                              type: string
                            type: array
                          tcp:
                            items:
                              example: "70"
                              type: string
                            type: array
                          timestamps:
                            items:
                              type: string
                            type: array
                          udp:
                            items:
                              example: "29"
                              type: string
                            type: array
                        required:
                          - timestamps
                          - udp
                          - tcp
                          - gre
                          - icmp
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 3 Attacks By Network Protocol Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/timeseries_groups/bitrate:
    get:
      description: Percentage distribution of attacks by bitrate over time.
      operationId: radar-get-attacks-layer3-timeseries-group-by-bitrate
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          _1_GBPS_TO_10_GBPS:
                            items:
                              type: string
                            type: array
                          _10_GBPS_TO_100_GBPS:
                            items:
                              type: string
                            type: array
                          _500_MBPS_TO_1_GBPS:
                            items:
                              type: string
                            type: array
                          OVER_100_GBPS:
                            items:
                              type: string
                            type: array
                          UNDER_500_MBPS:
                            items:
                              type: string
                            type: array
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                          - UNDER_500_MBPS
                          - OVER_100_GBPS
                          - _1_GBPS_TO_10_GBPS
                          - _500_MBPS_TO_1_GBPS
                          - _10_GBPS_TO_100_GBPS
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Attacks By Bitrate Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/timeseries_groups/duration:
    get:
      description: Percentage distribution of attacks by duration over time.
      operationId: radar-get-attacks-layer3-timeseries-group-by-duration
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          _1_HOUR_TO_3_HOURS:
                            items:
                              type: string
                            type: array
                          _10_MINS_TO_20_MINS:
                            items:
                              type: string
                            type: array
                          _20_MINS_TO_40_MINS:
                            items:
                              type: string
                            type: array
                          _40_MINS_TO_1_HOUR:
                            items:
                              type: string
                            type: array
                          OVER_3_HOURS:
                            items:
                              type: string
                            type: array
                          UNDER_10_MINS:
                            items:
                              type: string
                            type: array
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                          - UNDER_10_MINS
                          - _10_MINS_TO_20_MINS
                          - OVER_3_HOURS
                          - _1_HOUR_TO_3_HOURS
                          - _20_MINS_TO_40_MINS
                          - _40_MINS_TO_1_HOUR
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 3 Attack By Duration Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/timeseries_groups/industry:
    get:
      description: Percentage distribution of attacks by industry used over time.
      operationId: radar-get-attacks-layer3-timeseries-group-by-industry
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
          in: query
          name: limitPerGroup
          schema:
            description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
            example: 4
            type: integer
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          Internet:
                            - "5.519081"
                          timestamps:
                            - "2023-08-08T10:15:00Z"
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 3 Attacks By Target Industries Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/timeseries_groups/ip_version:
    get:
      description: Percentage distribution of attacks by ip version used over time.
      operationId: radar-get-attacks-layer3-timeseries-group-by-ip-version
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          IPv4:
                            items:
                              type: string
                            type: array
                          IPv6:
                            items:
                              type: string
                            type: array
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                          - IPv4
                          - IPv6
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 3 Attacks By IP Version Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/timeseries_groups/protocol:
    get:
      description: Percentage distribution of attacks by protocol used over time.
      operationId: radar-get-attacks-layer3-timeseries-group-by-protocol
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          GRE:
                            items:
                              type: string
                            type: array
                          ICMP:
                            items:
                              type: string
                            type: array
                          TCP:
                            items:
                              type: string
                            type: array
                          UDP:
                            items:
                              type: string
                            type: array
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                          - TCP
                          - UDP
                          - GRE
                          - ICMP
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 3 Attacks By Protocol Timeseries
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/timeseries_groups/vector:
    get:
      description: Percentage distribution of attacks by vector used over time.
      operationId: radar-get-attacks-layer3-timeseries-group-by-vector
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
          in: query
          name: limitPerGroup
          schema:
            description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
            example: 4
            type: integer
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          ACK Flood:
                            - "97.28898"
                          timestamps:
                            - "2023-08-08T10:15:00Z"
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 3 Attacks By Vector
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/timeseries_groups/vertical:
    get:
      description: Percentage distribution of attacks by vertical used over time.
      operationId: radar-get-attacks-layer3-timeseries-group-by-vertical
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Together with the `location` parameter, will apply the filter to origin or target location.
          in: query
          name: direction
          schema:
            default: ORIGIN
            description: Together with the `location` parameter, will apply the filter to origin or target location.
            enum:
              - ORIGIN
              - TARGET
            type: string
        - description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
          in: query
          name: limitPerGroup
          schema:
            description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
            example: 4
            type: integer
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          Internet and Telecom:
                            - "5.519081"
                          timestamps:
                            - "2023-08-08T10:15:00Z"
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 3 Attacks By Vertical Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/top/attacks:
    get:
      description: Get the top attacks from origin to target location. Values are a percentage out of the total layer 3 attacks (with billing country). 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-attacks-layer3-top-attacks
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location.
          in: query
          name: limitDirection
          schema:
            default: ORIGIN
            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
            type: string
        - description: Limit the number of attacks per origin/target (refer to `limitDirection` parameter) location.
          in: query
          name: limitPerLocation
          schema:
            description: Limit the number of attacks per origin/target (refer to `limitDirection` parameter) location.
            example: 10
            type: integer
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN_MAX
            example: PERCENTAGE
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            originCountryAlpha2:
                              example: FR
                              type: string
                            originCountryName:
                              example: France
                              type: string
                            value:
                              example: "4.323214"
                              type: string
                          required:
                            - originCountryAlpha2
                            - originCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get top attack pairs (origin and target locations) of Layer 3 attacks
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/top/industry:
    get:
      description: Get the Industry of attacks.
      operationId: radar-get-attacks-layer3-top-industries
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            name:
                              example: Computer Software
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - name
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get top Industry of attack
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/top/locations/origin:
    get:
      description: Get the origin locations of attacks.
      operationId: radar-get-attacks-layer3-top-origin-locations
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            originCountryAlpha2:
                              example: FR
                              type: string
                            originCountryName:
                              example: France
                              type: string
                            rank:
                              example: 1
                              type: number
                            value:
                              example: "4.323214"
                              type: string
                          required:
                            - originCountryAlpha2
                            - originCountryName
                            - value
                            - rank
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get top origin locations of attack
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/top/locations/target:
    get:
      description: Get the target locations of attacks.
      operationId: radar-get-attacks-layer3-top-target-locations
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            rank:
                              example: 1
                              type: number
                            targetCountryAlpha2:
                              example: FR
                              type: string
                            targetCountryName:
                              example: France
                              type: string
                            value:
                              example: "4.323214"
                              type: string
                          required:
                            - targetCountryAlpha2
                            - targetCountryName
                            - value
                            - rank
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get top target locations of attack
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer3/top/vertical:
    get:
      description: Get the Verticals of attacks.
      operationId: radar-get-attacks-layer3-top-verticals
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Array of L3/4 attack types.
          in: query
          name: protocol
          schema:
            description: Array of L3/4 attack types.
            items:
              enum:
                - UDP
                - TCP
                - ICMP
                - GRE
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            name:
                              example: Internet and Telecom
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - name
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get top Verticals of attack
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/summary:
    get:
      deprecated: true
      description: Percentage distribution of mitigation techniques in Layer 7 attacks.
      operationId: radar-get-attacks-layer7-summary
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                        required:
                          - dateRange
                        type: object
                      summary_0:
                        properties:
                          ACCESS_RULES:
                            example: "0.9"
                            type: string
                          API_SHIELD:
                            example: "0.9"
                            type: string
                          BOT_MANAGEMENT:
                            example: "0.9"
                            type: string
                          DATA_LOSS_PREVENTION:
                            example: "0.9"
                            type: string
                          DDOS:
                            example: "34"
                            type: string
                          IP_REPUTATION:
                            example: "0.1"
                            type: string
                          WAF:
                            example: "65"
                            type: string
                        required:
                          - WAF
                          - DDOS
                          - IP_REPUTATION
                          - ACCESS_RULES
                          - BOT_MANAGEMENT
                          - API_SHIELD
                          - DATA_LOSS_PREVENTION
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 7 Attacks Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/summary/http_method:
    get:
      description: Percentage distribution of attacks by http method used.
      operationId: radar-get-attacks-layer7-summary-by-http-method
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          GET:
                            example: "99.100257"
                            type: string
                          POST:
                            example: "0.899743"
                            type: string
                        required:
                          - GET
                          - POST
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get HTTP Method Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/summary/http_version:
    get:
      description: Percentage distribution of attacks by http version used.
      operationId: radar-get-attacks-layer7-summary-by-http-version
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          HTTP/1.x:
                            example: "21.722365"
                            type: string
                          HTTP/2:
                            example: "77.056555"
                            type: string
                          HTTP/3:
                            example: "1.22108"
                            type: string
                        required:
                          - HTTP/2
                          - HTTP/1.x
                          - HTTP/3
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get HTTP Version Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/summary/ip_version:
    get:
      description: Percentage distribution of attacks by ip version used.
      operationId: radar-get-attacks-layer7-summary-by-ip-version
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          IPv4:
                            example: "99.935733"
                            type: string
                          IPv6:
                            example: "0.064267"
                            type: string
                        required:
                          - IPv4
                          - IPv6
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Ip Version Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/summary/managed_rules:
    get:
      description: Percentage distribution of attacks by managed rules used.
      operationId: radar-get-attacks-layer7-summary-by-managed-rules
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          Bot:
                            example: "14.285714"
                            type: string
                          HTTP Anomaly:
                            example: "85.714286"
                            type: string
                        required:
                          - HTTP Anomaly
                          - Bot
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Managed Rules Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/summary/mitigation_product:
    get:
      description: Percentage distribution of attacks by mitigation product used.
      operationId: radar-get-attacks-layer7-summary-by-mitigation-product
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          DDOS:
                            example: "24.421594"
                            type: string
                          WAF:
                            example: "53.213368"
                            type: string
                        required:
                          - WAF
                          - DDOS
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Mitigation Product Summary
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/timeseries:
    get:
      description: Get a timeseries of Layer 7 attacks. Values represent HTTP requests and are normalized using min-max by default.
      operationId: radar-get-attacks-layer7-timeseries
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: This field is deprecated, please use the new `mitigationProduct`.
          in: query
          name: attack
          schema:
            deprecated: true
            description: This field is deprecated, please use the new `mitigationProduct`.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE_CHANGE
              - MIN0_MAX
            example: MIN0_MAX
            type: string
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          aggInterval:
                            example: 1h
                            type: string
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            format: date-time
                            type: string
                        required:
                          - dateRange
                          - aggInterval
                          - lastUpdated
                        type: object
                      serie_0:
                        properties:
                          timestamps:
                            items:
                              format: date-time
                              type: string
                            type: array
                          values:
                            items:
                              example: 0.56
                              type: string
                            type: array
                        required:
                          - timestamps
                          - values
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 7 Attacks Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/timeseries_groups:
    get:
      deprecated: true
      description: Get a time series of the percentual distribution of mitigation techniques, over time.
      operationId: radar-get-attacks-layer7-timeseries-group
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          aggInterval:
                            example: 1h
                            type: string
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            format: date-time
                            type: string
                        required:
                          - dateRange
                          - aggInterval
                          - lastUpdated
                        type: object
                      serie_0:
                        properties:
                          ACCESS_RULES:
                            items:
                              example: "5"
                              type: string
                            type: array
                          API_SHIELD:
                            items:
                              example: "5"
                              type: string
                            type: array
                          BOT_MANAGEMENT:
                            items:
                              example: "5"
                              type: string
                            type: array
                          DATA_LOSS_PREVENTION:
                            items:
                              example: "5"
                              type: string
                            type: array
                          DDOS:
                            items:
                              example: "60"
                              type: string
                            type: array
                          IP_REPUTATION:
                            items:
                              example: "5"
                              type: string
                            type: array
                          WAF:
                            items:
                              example: "30"
                              type: string
                            type: array
                          timestamps:
                            items:
                              format: date-time
                              type: string
                            type: array
                        required:
                          - timestamps
                          - WAF
                          - DDOS
                          - IP_REPUTATION
                          - ACCESS_RULES
                          - BOT_MANAGEMENT
                          - API_SHIELD
                          - DATA_LOSS_PREVENTION
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 7 Attacks By Mitigation Technique Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/timeseries_groups/http_method:
    get:
      description: Percentage distribution of attacks by http method used over time.
      operationId: radar-get-attacks-layer7-timeseries-group-by-http-method
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          GET:
                            items:
                              example: "70.970199"
                              type: string
                            type: array
                          timestamps:
                            items:
                              example: "2023-10-01T00:00:00Z"
                              type: string
                            type: array
                        required:
                          - timestamps
                          - GET
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 7 Attacks By HTTP Method Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/timeseries_groups/http_version:
    get:
      description: Percentage distribution of attacks by http version used over time.
      operationId: radar-get-attacks-layer7-timeseries-group-by-http-version
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          HTTP/1.x:
                            items:
                              example: "50.338734"
                              type: string
                            type: array
                          timestamps:
                            items:
                              example: "2023-10-01T00:00:00Z"
                              type: string
                            type: array
                        required:
                          - timestamps
                          - HTTP/1.x
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 7 Attacks By HTTP Version Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/timeseries_groups/industry:
    get:
      description: Percentage distribution of attacks by industry used over time.
      operationId: radar-get-attacks-layer7-timeseries-group-by-industry
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
          in: query
          name: limitPerGroup
          schema:
            description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
            example: 4
            type: integer
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          Internet:
                            - "5.519081"
                          timestamps:
                            - "2023-08-08T10:15:00Z"
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 7 Attacks By Target Industries Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/timeseries_groups/ip_version:
    get:
      description: Percentage distribution of attacks by ip version used over time.
      operationId: radar-get-attacks-layer7-timeseries-group-by-ip-version
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          IPv4:
                            items:
                              example: "99.935733"
                              type: string
                            type: array
                          IPv6:
                            items:
                              example: "0.064267"
                              type: string
                            type: array
                          timestamps:
                            items:
                              example: "2023-10-01T00:00:00Z"
                              type: string
                            type: array
                        required:
                          - timestamps
                          - IPv4
                          - IPv6
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 7 Attacks By IP Version Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/timeseries_groups/managed_rules:
    get:
      description: Percentage distribution of attacks by managed rules used over time.
      operationId: radar-get-attacks-layer7-timeseries-group-by-managed-rules
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          Bot:
                            items:
                              example: "0.324198"
                              type: string
                            type: array
                          timestamps:
                            items:
                              example: "2023-10-01T00:00:00Z"
                              type: string
                            type: array
                        required:
                          - timestamps
                          - Bot
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 7 Attacks By Managed Rules Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/timeseries_groups/mitigation_product:
    get:
      description: Percentage distribution of attacks by mitigation product used over time.
      operationId: radar-get-attacks-layer7-timeseries-group-by-mitigation-product
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          DDOS:
                            items:
                              example: "48.926354"
                              type: string
                            type: array
                          timestamps:
                            items:
                              example: "2023-10-01T00:00:00Z"
                              type: string
                            type: array
                        required:
                          - timestamps
                          - DDOS
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 7 Attacks By Mitigation Product Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/timeseries_groups/vertical:
    get:
      description: Percentage distribution of attacks by vertical used over time.
      operationId: radar-get-attacks-layer7-timeseries-group-by-vertical
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN0_MAX
            example: PERCENTAGE
            type: string
        - description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
          in: query
          name: limitPerGroup
          schema:
            description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
            example: 4
            type: integer
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          Internet and Telecom:
                            - "5.519081"
                          timestamps:
                            - "2023-08-08T10:15:00Z"
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Layer 7 Attacks By Vertical Time Series
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/top/ases/origin:
    get:
      description: Get the top origin Autonomous Systems of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The origin Autonomous Systems is determined by the client IP.
      operationId: radar-get-attacks-layer7-top-origin-as
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            originAsn:
                              example: "55836"
                              type: string
                            originAsnName:
                              example: RELIANCEJIO-IN Reliance Jio Infocomm Limited
                              type: string
                            rank:
                              example: 1
                              type: number
                            value:
                              example: "4.323214"
                              type: string
                          required:
                            - originAsnName
                            - originAsn
                            - value
                            - rank
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Origin Autonomous Systems By Layer 7 Attacks
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/top/attacks:
    get:
      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-attacks-layer7-top-attacks
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location.
          in: query
          name: limitDirection
          schema:
            default: ORIGIN
            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
            type: string
        - description: Limit the number of attacks per origin/target (refer to `limitDirection` parameter) location.
          in: query
          name: limitPerLocation
          schema:
            description: Limit the number of attacks per origin/target (refer to `limitDirection` parameter) location.
            example: 10
            type: integer
        - description: Attack magnitude can be defined by total requests mitigated or by total zones attacked.
          in: query
          name: magnitude
          schema:
            description: Attack magnitude can be defined by total requests mitigated or by total zones attacked.
            enum:
              - AFFECTED_ZONES
              - MITIGATED_REQUESTS
            example: MITIGATED_REQUESTS
            type: string
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            default: PERCENTAGE
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE
              - MIN_MAX
            example: PERCENTAGE
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            originCountryAlpha2:
                              example: US
                              type: string
                            originCountryName:
                              example: United States
                              type: string
                            targetCountryAlpha2:
                              example: FR
                              type: string
                            targetCountryName:
                              example: France
                              type: string
                            value:
                              example: "4.323214"
                              type: string
                          required:
                            - originCountryAlpha2
                            - originCountryName
                            - targetCountryAlpha2
                            - targetCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Attack Pairs (origin and target locations) By Layer 7 Attacks
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/top/industry:
    get:
      description: Get the Industry of attacks.
      operationId: radar-get-attacks-layer7-top-industries
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            name:
                              example: Computer Software
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - name
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get top Industry of attack
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/top/locations/origin:
    get:
      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-attacks-layer7-top-origin-location
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            originCountryAlpha2:
                              example: FR
                              type: string
                            originCountryName:
                              example: France
                              type: string
                            rank:
                              example: 1
                              type: number
                            value:
                              example: "4.323214"
                              type: string
                          required:
                            - originCountryAlpha2
                            - originCountryName
                            - value
                            - rank
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Origin Locations By Layer 7 Attacks
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/top/locations/target:
    get:
      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-attacks-layer7-top-target-location
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            rank:
                              example: 1
                              type: number
                            targetCountryAlpha2:
                              example: FR
                              type: string
                            targetCountryName:
                              example: France
                              type: string
                            value:
                              example: "4.323214"
                              type: string
                          required:
                            - targetCountryAlpha2
                            - targetCountryName
                            - value
                            - rank
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get layer 7 top target locations
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/attacks/layer7/top/vertical:
    get:
      description: Get the Verticals of attacks.
      operationId: radar-get-attacks-layer7-top-verticals
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for http method.
          in: query
          name: httpMethod
          schema:
            description: Filter for http method.
            example: GET
            items:
              enum:
                - GET
                - POST
                - DELETE
                - PUT
                - HEAD
                - PURGE
                - OPTIONS
                - PROPFIND
                - MKCOL
                - PATCH
                - ACL
                - BCOPY
                - BDELETE
                - BMOVE
                - BPROPFIND
                - BPROPPATCH
                - CHECKIN
                - CHECKOUT
                - CONNECT
                - COPY
                - LABEL
                - LOCK
                - MERGE
                - MKACTIVITY
                - MKWORKSPACE
                - MOVE
                - NOTIFY
                - ORDERPATCH
                - POLL
                - PROPPATCH
                - REPORT
                - SEARCH
                - SUBSCRIBE
                - TRACE
                - UNCHECKOUT
                - UNLOCK
                - UNSUBSCRIBE
                - UPDATE
                - VERSIONCONTROL
                - BASELINECONTROL
                - XMSENUMATTS
                - RPC_OUT_DATA
                - RPC_IN_DATA
                - JSON
                - COOK
                - TRACK
              type: string
            type: array
        - description: Array of L7 mitigation products.
          in: query
          name: mitigationProduct
          schema:
            description: Array of L7 mitigation products.
            items:
              enum:
                - DDOS
                - WAF
                - BOT_MANAGEMENT
                - ACCESS_RULES
                - IP_REPUTATION
                - API_SHIELD
                - DATA_LOSS_PREVENTION
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            name:
                              example: Internet and Telecom
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - name
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get top Verticals of attack
      tags:
        - Radar Attacks
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/hijacks/events:
    get:
      description: Get the BGP hijack events. (Beta)
      operationId: radar-get-bgp-hijacks-events
      parameters:
        - description: Current page number, starting from 1
          in: query
          name: page
          schema:
            description: Current page number, starting from 1
            type: integer
        - description: Number of entries per page
          in: query
          name: per_page
          schema:
            description: Number of entries per page
            type: integer
        - description: The unique identifier of a event
          in: query
          name: eventId
          schema:
            description: The unique identifier of a event
            type: integer
        - description: The potential hijacker AS of a BGP hijack event
          in: query
          name: hijackerAsn
          schema:
            description: The potential hijacker AS of a BGP hijack event
            type: integer
        - description: The potential victim AS of a BGP hijack event
          in: query
          name: victimAsn
          schema:
            description: The potential victim AS of a BGP hijack event
            type: integer
        - description: The potential hijacker or victim AS of a BGP hijack event
          in: query
          name: involvedAsn
          schema:
            description: The potential hijacker or victim AS of a BGP hijack event
            type: integer
        - description: The country code of the potential hijacker or victim AS of a BGP hijack event
          in: query
          name: involvedCountry
          schema:
            description: The country code of the potential hijacker or victim AS of a BGP hijack event
            type: string
        - description: Network prefix, IPv4 or IPv6.
          in: query
          name: prefix
          schema:
            description: Network prefix, IPv4 or IPv6.
            example: 1.1.1.0/24
            type: string
        - description: The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)
          in: query
          name: minConfidence
          schema:
            description: The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)
            type: integer
        - description: The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)
          in: query
          name: maxConfidence
          schema:
            description: The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)
            type: integer
        - description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
          in: query
          name: dateRange
          schema:
            description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
            example: 7d
            pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
            type: string
        - description: Start of the date range (inclusive).
          in: query
          name: dateStart
          schema:
            description: Start of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - description: Sort events by field
          in: query
          name: sortBy
          schema:
            description: Sort events by field
            enum:
              - ID
              - TIME
              - CONFIDENCE
            example: TIME
            type: string
        - description: Sort order
          in: query
          name: sortOrder
          schema:
            description: Sort order
            enum:
              - ASC
              - DESC
            example: DESC
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      asn_info:
                        items:
                          properties:
                            asn:
                              type: integer
                            country_code:
                              type: string
                            org_name:
                              type: string
                          required:
                            - asn
                            - org_name
                            - country_code
                          type: object
                        type: array
                      events:
                        items:
                          properties:
                            confidence_score:
                              type: integer
                            duration:
                              type: integer
                            event_type:
                              type: integer
                            hijack_msgs_count:
                              type: integer
                            hijacker_asn:
                              type: integer
                            hijacker_country:
                              type: string
                            id:
                              type: integer
                            is_stale:
                              type: boolean
                            max_hijack_ts:
                              type: string
                            max_msg_ts:
                              type: string
                            min_hijack_ts:
                              type: string
                            on_going_count:
                              type: integer
                            peer_asns:
                              items:
                                type: integer
                              type: array
                            peer_ip_count:
                              type: integer
                            prefixes:
                              items:
                                type: string
                              type: array
                            tags:
                              items:
                                properties:
                                  name:
                                    type: string
                                  score:
                                    type: integer
                                required:
                                  - name
                                  - score
                                type: object
                              type: array
                            victim_asns:
                              items:
                                type: integer
                              type: array
                            victim_countries:
                              items:
                                type: string
                              type: array
                          required:
                            - duration
                            - event_type
                            - hijack_msgs_count
                            - hijacker_asn
                            - hijacker_country
                            - victim_asns
                            - victim_countries
                            - id
                            - is_stale
                            - max_hijack_ts
                            - min_hijack_ts
                            - max_msg_ts
                            - on_going_count
                            - peer_asns
                            - peer_ip_count
                            - prefixes
                            - confidence_score
                            - tags
                          type: object
                        type: array
                      total_monitors:
                        type: integer
                    required:
                      - asn_info
                      - events
                      - total_monitors
                    type: object
                  result_info:
                    properties:
                      count:
                        type: integer
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                    required:
                      - count
                      - total_count
                      - page
                      - per_page
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - result_info
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get BGP hijack events
      tags:
        - Radar BGP
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/ips/timeseries:
    get:
      description: Gets time-series data for the announced IP space count, represented as the number of IPv4 /24s and IPv6 /48s, for a given ASN.
      operationId: radar-get-bgp-ips-timeseries
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - description: Array of locations (alpha-2 country codes).
          in: query
          name: location
          schema:
            description: Array of locations (alpha-2 country codes).
            example: US
            items:
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Include data delay meta information
          in: query
          name: includeDelay
          schema:
            description: Include data delay meta information
            example: "true"
            type: boolean
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          queries:
                            items:
                              properties:
                                dateRange:
                                  properties:
                                    endTime:
                                      example: "2024-07-29T13:30:00Z"
                                      type: string
                                    startTime:
                                      example: "2024-07-28T13:30:00Z"
                                      type: string
                                  required:
                                    - startTime
                                    - endTime
                                  type: object
                                entity:
                                  example: "174"
                                  type: string
                              required:
                                - dateRange
                                - entity
                              type: object
                            type: array
                        required:
                          - queries
                        type: object
                      serie_174:
                        properties:
                          ipv4:
                            items:
                              example: "4"
                              type: string
                            type: array
                          ipv6:
                            items:
                              example: "6"
                              type: string
                            type: array
                          timestamps:
                            items:
                              format: date-time
                              type: string
                            type: array
                        required:
                          - timestamps
                          - ipv4
                          - ipv6
                        type: object
                    required:
                      - meta
                      - serie_174
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get BGP IP space time series
      tags:
        - Radar BGP
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/leaks/events:
    get:
      description: Get the BGP route leak events (Beta).
      operationId: radar-get-bgp-route-leak-events
      parameters:
        - description: Current page number, starting from 1
          in: query
          name: page
          schema:
            description: Current page number, starting from 1
            type: integer
        - description: Number of entries per page
          in: query
          name: per_page
          schema:
            description: Number of entries per page
            type: integer
        - description: The unique identifier of a event
          in: query
          name: eventId
          schema:
            description: The unique identifier of a event
            type: integer
        - description: The leaking AS of a route leak event
          in: query
          name: leakAsn
          schema:
            description: The leaking AS of a route leak event
            type: integer
        - description: ASN that is causing or affected by a route leak event
          in: query
          name: involvedAsn
          schema:
            description: ASN that is causing or affected by a route leak event
            type: integer
        - description: Country code of a involved ASN in a route leak event
          in: query
          name: involvedCountry
          schema:
            description: Country code of a involved ASN in a route leak event
            type: string
        - description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
          in: query
          name: dateRange
          schema:
            description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
            example: 7d
            pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
            type: string
        - description: Start of the date range (inclusive).
          in: query
          name: dateStart
          schema:
            description: Start of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - description: Sort events by field
          in: query
          name: sortBy
          schema:
            description: Sort events by field
            enum:
              - ID
              - LEAKS
              - PEERS
              - PREFIXES
              - ORIGINS
              - TIME
            example: TIME
            type: string
        - description: Sort order
          in: query
          name: sortOrder
          schema:
            description: Sort order
            enum:
              - ASC
              - DESC
            example: DESC
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      asn_info:
                        items:
                          properties:
                            asn:
                              type: integer
                            country_code:
                              type: string
                            org_name:
                              type: string
                          required:
                            - asn
                            - org_name
                            - country_code
                          type: object
                        type: array
                      events:
                        items:
                          properties:
                            countries:
                              items:
                                type: string
                              type: array
                            detected_ts:
                              type: string
                            finished:
                              type: boolean
                            id:
                              type: integer
                            leak_asn:
                              type: integer
                            leak_count:
                              type: integer
                            leak_seg:
                              items:
                                type: integer
                              type: array
                            leak_type:
                              type: integer
                            max_ts:
                              type: string
                            min_ts:
                              type: string
                            origin_count:
                              type: integer
                            peer_count:
                              type: integer
                            prefix_count:
                              type: integer
                          required:
                            - detected_ts
                            - finished
                            - id
                            - leak_asn
                            - leak_count
                            - leak_seg
                            - leak_type
                            - max_ts
                            - min_ts
                            - origin_count
                            - peer_count
                            - prefix_count
                            - countries
                          type: object
                        type: array
                    required:
                      - asn_info
                      - events
                    type: object
                  result_info:
                    properties:
                      count:
                        type: integer
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                    required:
                      - count
                      - total_count
                      - page
                      - per_page
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - result_info
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get BGP route leak events
      tags:
        - Radar BGP
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/routes/ases:
    get:
      description: List all ASes on current global routing tables with routing statistics
      operationId: radar-get-bgp-routes-asns
      parameters:
        - description: Location Alpha2 code.
          in: query
          name: location
          schema:
            description: Location Alpha2 code.
            example: US
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Return order results by given type
          in: query
          name: sortBy
          schema:
            description: Return order results by given type
            enum:
              - cone
              - pfxs
              - ipv4
              - ipv6
              - rpki_valid
              - rpki_invalid
              - rpki_unknown
            example: ipv4
            type: string
        - description: Sort by value ascending or descending
          in: query
          name: sortOrder
          schema:
            default: desc
            description: Sort by value ascending or descending
            enum:
              - asc
              - desc
            example: desc
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      asns:
                        items:
                          properties:
                            asn:
                              type: integer
                            coneSize:
                              description: AS's customer cone size
                              type: integer
                            country:
                              description: 2-letter country code for the AS's registration country
                              example: US
                              type: string
                            ipv4Count:
                              description: number of IPv4 addresses originated by the AS
                              type: integer
                            ipv6Count:
                              description: number of IPv6 addresses originated by the AS
                              example: "1.21e24"
                              type: string
                            name:
                              description: name of the AS
                              type: string
                            pfxsCount:
                              description: number of total IP prefixes originated by the AS
                              type: integer
                            rpkiInvalid:
                              description: number of RPKI invalid prefixes originated by the AS
                              type: integer
                            rpkiUnknown:
                              description: number of RPKI unknown prefixes originated by the AS
                              type: integer
                            rpkiValid:
                              description: number of RPKI valid prefixes originated by the AS
                              type: integer
                          required:
                            - asn
                            - name
                            - coneSize
                            - country
                            - ipv4Count
                            - ipv6Count
                            - pfxsCount
                            - rpkiValid
                            - rpkiInvalid
                            - rpkiUnknown
                          type: object
                        type: array
                      meta:
                        properties:
                          dataTime:
                            description: the timestamp of when the data is generated
                            example: 2024-06-03T14:00:00
                            type: string
                          queryTime:
                            description: the timestamp of the query
                            example: 2024-06-03T14:00:00
                            type: string
                          totalPeers:
                            description: total number of route collector peers used to generate this data
                            type: integer
                        required:
                          - dataTime
                          - queryTime
                          - totalPeers
                        type: object
                    required:
                      - asns
                      - meta
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List ASes from global routing tables
      tags:
        - Radar BGP
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/routes/moas:
    get:
      description: List all Multi-origin AS (MOAS) prefixes on the global routing tables.
      operationId: radar-get-bgp-pfx2as-moas
      parameters:
        - description: Lookup MOASes originated by the given ASN
          in: query
          name: origin
          schema:
            description: Lookup MOASes originated by the given ASN
            type: integer
        - description: Network prefix, IPv4 or IPv6.
          in: query
          name: prefix
          schema:
            description: Network prefix, IPv4 or IPv6.
            example: 1.1.1.0/24
            type: string
        - description: Lookup only RPKI invalid MOASes
          in: query
          name: invalid_only
          schema:
            description: Lookup only RPKI invalid MOASes
            type: boolean
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          data_time:
                            type: string
                          query_time:
                            type: string
                          total_peers:
                            type: integer
                        required:
                          - data_time
                          - query_time
                          - total_peers
                        type: object
                      moas:
                        items:
                          properties:
                            origins:
                              items:
                                properties:
                                  origin:
                                    type: integer
                                  peer_count:
                                    type: integer
                                  rpki_validation:
                                    type: string
                                required:
                                  - origin
                                  - peer_count
                                  - rpki_validation
                                type: object
                              type: array
                            prefix:
                              type: string
                          required:
                            - prefix
                            - origins
                          type: object
                        type: array
                    required:
                      - moas
                      - meta
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get MOASes
      tags:
        - Radar BGP
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/routes/pfx2as:
    get:
      description: Lookup prefix-to-ASN mapping on global routing tables.
      operationId: radar-get-bgp-pfx2as
      parameters:
        - description: Network prefix, IPv4 or IPv6.
          in: query
          name: prefix
          schema:
            description: Network prefix, IPv4 or IPv6.
            example: 1.1.1.0/24
            type: string
        - description: Lookup prefixes originated by the given ASN
          in: query
          name: origin
          schema:
            description: Lookup prefixes originated by the given ASN
            type: integer
        - description: 'Return only results with matching rpki status: valid, invalid or unknown'
          in: query
          name: rpkiStatus
          schema:
            description: 'Return only results with matching rpki status: valid, invalid or unknown'
            enum:
              - VALID
              - INVALID
              - UNKNOWN
            example: INVALID
            type: string
        - description: Return only results with the longest prefix match for the given prefix. For example, specify a /32 prefix to lookup the origin ASN for an IPv4 address.
          in: query
          name: longestPrefixMatch
          schema:
            description: Return only results with the longest prefix match for the given prefix. For example, specify a /32 prefix to lookup the origin ASN for an IPv4 address.
            example: "true"
            type: boolean
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          data_time:
                            type: string
                          query_time:
                            type: string
                          total_peers:
                            type: integer
                        required:
                          - data_time
                          - query_time
                          - total_peers
                        type: object
                      prefix_origins:
                        items:
                          properties:
                            origin:
                              type: integer
                            peer_count:
                              type: integer
                            prefix:
                              type: string
                            rpki_validation:
                              type: string
                          required:
                            - origin
                            - peer_count
                            - prefix
                            - rpki_validation
                          type: object
                        type: array
                    required:
                      - prefix_origins
                      - meta
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get prefix-to-ASN mapping
      tags:
        - Radar BGP
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/routes/stats:
    get:
      description: Get the BGP routing table stats (Beta).
      operationId: radar-get-bgp-routes-stats
      parameters:
        - description: Single ASN as integer.
          in: query
          name: asn
          schema:
            description: Single ASN as integer.
            example: "174"
            type: integer
        - description: Location Alpha2 code.
          in: query
          name: location
          schema:
            description: Location Alpha2 code.
            example: US
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          data_time:
                            type: string
                          query_time:
                            type: string
                          total_peers:
                            type: integer
                        required:
                          - data_time
                          - query_time
                          - total_peers
                        type: object
                      stats:
                        properties:
                          distinct_origins:
                            type: integer
                          distinct_origins_ipv4:
                            type: integer
                          distinct_origins_ipv6:
                            type: integer
                          distinct_prefixes:
                            type: integer
                          distinct_prefixes_ipv4:
                            type: integer
                          distinct_prefixes_ipv6:
                            type: integer
                          routes_invalid:
                            type: integer
                          routes_invalid_ipv4:
                            type: integer
                          routes_invalid_ipv6:
                            type: integer
                          routes_total:
                            type: integer
                          routes_total_ipv4:
                            type: integer
                          routes_total_ipv6:
                            type: integer
                          routes_unknown:
                            type: integer
                          routes_unknown_ipv4:
                            type: integer
                          routes_unknown_ipv6:
                            type: integer
                          routes_valid:
                            type: integer
                          routes_valid_ipv4:
                            type: integer
                          routes_valid_ipv6:
                            type: integer
                        required:
                          - distinct_origins
                          - distinct_origins_ipv4
                          - distinct_origins_ipv6
                          - distinct_prefixes
                          - distinct_prefixes_ipv4
                          - distinct_prefixes_ipv6
                          - routes_invalid
                          - routes_invalid_ipv4
                          - routes_invalid_ipv6
                          - routes_total
                          - routes_total_ipv4
                          - routes_total_ipv6
                          - routes_unknown
                          - routes_unknown_ipv4
                          - routes_unknown_ipv6
                          - routes_valid
                          - routes_valid_ipv4
                          - routes_valid_ipv6
                        type: object
                    required:
                      - stats
                      - meta
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: 'APIs.io Engineering Platform Get BGP routing table stats'
      tags:
        - Radar BGP
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/timeseries:
    get:
      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-bgp-timeseries
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Array of BGP network prefixes.
          in: query
          name: prefix
          schema:
            description: Array of BGP network prefixes.
            example: 1.1.1.0/24
            items:
              description: Network prefix, IPv4 or IPv6.
              example: 1.1.1.0/24
              type: string
            type: array
        - description: Array of BGP update types.
          in: query
          name: updateType
          schema:
            description: Array of BGP update types.
            example: ANNOUNCEMENT
            items:
              enum:
                - ANNOUNCEMENT
                - WITHDRAWAL
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          aggInterval:
                            example: 1h
                            type: string
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            format: date-time
                            type: string
                        required:
                          - dateRange
                          - aggInterval
                          - lastUpdated
                        type: object
                      serie_0:
                        properties:
                          timestamps:
                            items:
                              format: date-time
                              type: string
                            type: array
                          values:
                            items:
                              example: 0.56
                              type: string
                            type: array
                        required:
                          - timestamps
                          - values
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get BGP time series
      tags:
        - Radar BGP
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/top/ases:
    get:
      description: Get the top autonomous systems (AS) by BGP updates (announcements only). Values are a percentage out of the total updates.
      operationId: radar-get-bgp-top-ases
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - description: Array of BGP network prefixes.
          in: query
          name: prefix
          schema:
            description: Array of BGP network prefixes.
            example: 1.1.1.0/24
            items:
              description: Network prefix, IPv4 or IPv6.
              example: 1.1.1.0/24
              type: string
            type: array
        - description: Array of BGP update types.
          in: query
          name: updateType
          schema:
            description: Array of BGP update types.
            example: ANNOUNCEMENT
            items:
              enum:
                - ANNOUNCEMENT
                - WITHDRAWAL
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                        required:
                          - dateRange
                        type: object
                      top_0:
                        items:
                          properties:
                            ASName:
                              example: Apple-Engineering
                              type: string
                            asn:
                              example: 714
                              type: integer
                            value:
                              description: Percentage of updates by this AS out of the total updates by all autonomous systems.
                              example: "0.73996"
                              type: string
                          required:
                            - asn
                            - ASName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get top autonomous systems
      tags:
        - Radar BGP
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/top/ases/prefixes:
    get:
      description: Get the full list of autonomous systems on the global routing table ordered by announced prefixes count. The data comes from public BGP MRT data archives and updates every 2 hours.
      operationId: radar-get-bgp-top-asns-by-prefixes
      parameters:
        - description: Alpha-2 country code.
          in: query
          name: country
          schema:
            description: Alpha-2 country code.
            example: NZ
            type: string
        - description: Maximum number of ASes to return
          in: query
          name: limit
          schema:
            description: Maximum number of ASes to return
            example: 10
            type: integer
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      asns:
                        items:
                          properties:
                            asn:
                              type: integer
                            country:
                              type: string
                            name:
                              type: string
                            pfxs_count:
                              type: integer
                          required:
                            - asn
                            - country
                            - name
                            - pfxs_count
                          type: object
                        type: array
                      meta:
                        properties:
                          data_time:
                            type: string
                          query_time:
                            type: string
                          total_peers:
                            type: integer
                        required:
                          - data_time
                          - query_time
                          - total_peers
                        type: object
                    required:
                      - asns
                      - meta
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get list of ASNs ordered by prefix count
      tags:
        - Radar BGP
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/top/prefixes:
    get:
      description: Get the top network prefixes by BGP updates. Values are a percentage out of the total BGP updates.
      operationId: radar-get-bgp-top-prefixes
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - description: Array of BGP update types.
          in: query
          name: updateType
          schema:
            description: Array of BGP update types.
            example: ANNOUNCEMENT
            items:
              enum:
                - ANNOUNCEMENT
                - WITHDRAWAL
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                        required:
                          - dateRange
                        type: object
                      top_0:
                        items:
                          properties:
                            prefix:
                              example: 2804:77cc:8000::/33
                              type: string
                            value:
                              example: "0.73996"
                              type: string
                          required:
                            - prefix
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get top prefixes
      tags:
        - Radar BGP
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/datasets:
    get:
      description: Get a list of datasets.
      operationId: radar-get-reports-datasets
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Number of objects to skip before grabbing results.
          in: query
          name: offset
          schema:
            description: Number of objects to skip before grabbing results.
            type: integer
        - description: Dataset type.
          in: query
          name: datasetType
          schema:
            default: RANKING_BUCKET
            description: Dataset type.
            enum:
              - RANKING_BUCKET
              - REPORT
            example: RANKING_BUCKET
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      datasets:
                        items:
                          properties:
                            description:
                              example: This dataset contains a list of the op 20000 domains globally
                              type: string
                            id:
                              example: 3
                              type: integer
                            meta:
                              type: object
                            tags:
                              items:
                                example: global
                                type: string
                              type: array
                            title:
                              example: Top bucket 20000 domains
                              type: string
                            type:
                              example: RANKING_BUCKET
                              type: string
                          required:
                            - id
                            - title
                            - description
                            - type
                            - tags
                            - meta
                          type: object
                        type: array
                    required:
                      - datasets
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Datasets
      tags:
        - Radar Datasets
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/datasets/{alias}:
    get:
      description: Get the csv content of a given dataset by alias or id. When getting the content by alias the latest dataset is returned, optionally filtered by the latest available at a given date.
      operationId: radar-get-reports-dataset-download
      parameters:
        - description: Dataset alias or id
          in: path
          name: alias
          required: true
          schema:
            description: Dataset alias or id
            example: ranking_top_1000
            type: string
      responses:
        "200":
          content:
            text/csv:
              schema:
                type: string
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Dataset csv Stream
      tags:
        - Radar Datasets
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/datasets/download:
    post:
      description: Get a url to download a single dataset.
      operationId: radar-post-reports-dataset-download-url
      parameters:
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                datasetId:
                  example: 3
                  type: integer
              required:
                - datasetId
              type: object
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      dataset:
                        properties:
                          url:
                            example: https://example.com/download
                            type: string
                        required:
                          - url
                        type: object
                    required:
                      - dataset
                    type: object
                required:
                  - result
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Dataset download url
      tags:
        - Radar Datasets
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/dns/top/ases:
    get:
      description: Get top autonomous systems by DNS queries made to Cloudflare's public DNS resolver.
      operationId: radar-get-dns-top-ases
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - description: Array of domain names.
          in: query
          name: domain
          required: true
          schema:
            description: Array of domain names.
            example: google.com
            items:
              pattern: ^([a-zA-Z0-9]([a-zA-Z0-9-]{0,63}[a-zA-Z0-9-])?\.)+[a-zA-Z0-9-]{2,63}$
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                        required:
                          - dateRange
                        type: object
                      top_0:
                        items:
                          properties:
                            clientASN:
                              example: 174
                              type: integer
                            clientASName:
                              example: Cogent-174
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientASN
                            - clientASName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Autonomous Systems by DNS queries.
      tags:
        - Radar DNS
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/dns/top/locations:
    get:
      description: Get top locations by DNS queries made to Cloudflare's public DNS resolver.
      operationId: radar-get-dns-top-locations
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - description: Array of domain names.
          in: query
          name: domain
          required: true
          schema:
            description: Array of domain names.
            example: google.com
            items:
              pattern: ^([a-zA-Z0-9]([a-zA-Z0-9-]{0,63}[a-zA-Z0-9-])?\.)+[a-zA-Z0-9-]{2,63}$
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                        required:
                          - dateRange
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: PT
                              type: string
                            clientCountryName:
                              example: Portugal
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations by DNS queries
      tags:
        - Radar DNS
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/routing/summary/arc:
    get:
      description: Percentage distribution of emails classified per ARC validation.
      operationId: radar-get-email-routing-summary-by-arc
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for encrypted emails.
          in: query
          name: encrypted
          schema:
            description: Filter for encrypted emails.
            example: ENCRYPTED
            items:
              enum:
                - ENCRYPTED
                - NOT_ENCRYPTED
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          FAIL:
                            example: "2"
                            type: string
                          NONE:
                            example: "53"
                            type: string
                          PASS:
                            example: "45"
                            type: string
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get ARC Validations Summary
      tags:
        - Radar Email Routing
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/routing/summary/dkim:
    get:
      description: Percentage distribution of emails classified per DKIM validation.
      operationId: radar-get-email-routing-summary-by-dkim
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for encrypted emails.
          in: query
          name: encrypted
          schema:
            description: Filter for encrypted emails.
            example: ENCRYPTED
            items:
              enum:
                - ENCRYPTED
                - NOT_ENCRYPTED
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          FAIL:
                            example: "2"
                            type: string
                          NONE:
                            example: "53"
                            type: string
                          PASS:
                            example: "45"
                            type: string
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get DKIM Validations Summary
      tags:
        - Radar Email Routing
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/routing/summary/dmarc:
    get:
      description: Percentage distribution of emails classified per DMARC validation.
      operationId: radar-get-email-routing-summary-by-dmarc
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for encrypted emails.
          in: query
          name: encrypted
          schema:
            description: Filter for encrypted emails.
            example: ENCRYPTED
            items:
              enum:
                - ENCRYPTED
                - NOT_ENCRYPTED
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          FAIL:
                            example: "2"
                            type: string
                          NONE:
                            example: "53"
                            type: string
                          PASS:
                            example: "45"
                            type: string
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get DMARC Validations Summary
      tags:
        - Radar Email Routing
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/routing/summary/encrypted:
    get:
      description: Percentage distribution of emails by Encrypted
      operationId: radar-get-email-routing-summary-by-encrypted
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          ENCRYPTED:
                            example: "65"
                            type: string
                          NOT_ENCRYPTED:
                            example: "35"
                            type: string
                        required:
                          - ENCRYPTED
                          - NOT_ENCRYPTED
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Encrypted Summary
      tags:
        - Radar Email Routing
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/routing/summary/ip_version:
    get:
      description: Percentage distribution of emails by Ip Version.
      operationId: radar-get-email-routing-summary-by-ip-version
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for encrypted emails.
          in: query
          name: encrypted
          schema:
            description: Filter for encrypted emails.
            example: ENCRYPTED
            items:
              enum:
                - ENCRYPTED
                - NOT_ENCRYPTED
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          IPv4:
                            example: "65"
                            type: string
                          IPv6:
                            example: "35"
                            type: string
                        required:
                          - IPv4
                          - IPv6
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Ip Version Summary
      tags:
        - Radar Email Routing
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/routing/summary/spf:
    get:
      description: Percentage distribution of emails classified per SPF validation.
      operationId: radar-get-email-routing-summary-by-spf
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for encrypted emails.
          in: query
          name: encrypted
          schema:
            description: Filter for encrypted emails.
            example: ENCRYPTED
            items:
              enum:
                - ENCRYPTED
                - NOT_ENCRYPTED
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          FAIL:
                            example: "2"
                            type: string
                          NONE:
                            example: "53"
                            type: string
                          PASS:
                            example: "45"
                            type: string
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get SPF Validations Summary
      tags:
        - Radar Email Routing
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/routing/timeseries_groups/arc:
    get:
      description: Percentage distribution of emails classified per Arc validation over time.
      operationId: radar-get-email-routing-timeseries-group-by-arc
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for encrypted emails.
          in: query
          name: encrypted
          schema:
            description: Filter for encrypted emails.
            example: ENCRYPTED
            items:
              enum:
                - ENCRYPTED
                - NOT_ENCRYPTED
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          FAIL:
                            items:
                              example: "2"
                              type: string
                            type: array
                          NONE:
                            items:
                              example: "53"
                              type: string
                            type: array
                          PASS:
                            items:
                              example: "45"
                              type: string
                            type: array
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get ARC Validations Time Series
      tags:
        - Radar Email Routing
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/routing/timeseries_groups/dkim:
    get:
      description: Percentage distribution of emails classified per DKIM validation over time.
      operationId: radar-get-email-routing-timeseries-group-by-dkim
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for encrypted emails.
          in: query
          name: encrypted
          schema:
            description: Filter for encrypted emails.
            example: ENCRYPTED
            items:
              enum:
                - ENCRYPTED
                - NOT_ENCRYPTED
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          FAIL:
                            items:
                              example: "2"
                              type: string
                            type: array
                          NONE:
                            items:
                              example: "53"
                              type: string
                            type: array
                          PASS:
                            items:
                              example: "45"
                              type: string
                            type: array
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get DKIM Validations Time Series
      tags:
        - Radar Email Routing
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/routing/timeseries_groups/dmarc:
    get:
      description: Percentage distribution of emails classified per DMARC validation over time.
      operationId: radar-get-email-routing-timeseries-group-by-dmarc
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for encrypted emails.
          in: query
          name: encrypted
          schema:
            description: Filter for encrypted emails.
            example: ENCRYPTED
            items:
              enum:
                - ENCRYPTED
                - NOT_ENCRYPTED
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          FAIL:
                            items:
                              example: "2"
                              type: string
                            type: array
                          NONE:
                            items:
                              example: "53"
                              type: string
                            type: array
                          PASS:
                            items:
                              example: "45"
                              type: string
                            type: array
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get DMARC Validations Time Series
      tags:
        - Radar Email Routing
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/routing/timeseries_groups/encrypted:
    get:
      description: Percentage distribution of emails by Encrypted over time.
      operationId: radar-get-email-routing-timeseries-group-by-encrypted
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          ENCRYPTED:
                            items:
                              example: "65"
                              type: string
                            type: array
                          NOT_ENCRYPTED:
                            items:
                              example: "35"
                              type: string
                            type: array
                        required:
                          - ENCRYPTED
                          - NOT_ENCRYPTED
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Encrypted Time Series
      tags:
        - Radar Email Routing
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/routing/timeseries_groups/ip_version:
    get:
      description: Percentage distribution of emails by Ip Version over time.
      operationId: radar-get-email-routing-timeseries-group-by-ip-version
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for encrypted emails.
          in: query
          name: encrypted
          schema:
            description: Filter for encrypted emails.
            example: ENCRYPTED
            items:
              enum:
                - ENCRYPTED
                - NOT_ENCRYPTED
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          IPv4:
                            items:
                              example: "65"
                              type: string
                            type: array
                          IPv6:
                            items:
                              example: "35"
                              type: string
                            type: array
                        required:
                          - IPv4
                          - IPv6
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Ip Version Time Series
      tags:
        - Radar Email Routing
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/routing/timeseries_groups/spf:
    get:
      description: Percentage distribution of emails classified per SPF validation over time.
      operationId: radar-get-email-routing-timeseries-group-by-spf
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for encrypted emails.
          in: query
          name: encrypted
          schema:
            description: Filter for encrypted emails.
            example: ENCRYPTED
            items:
              enum:
                - ENCRYPTED
                - NOT_ENCRYPTED
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          FAIL:
                            items:
                              example: "2"
                              type: string
                            type: array
                          NONE:
                            items:
                              example: "53"
                              type: string
                            type: array
                          PASS:
                            items:
                              example: "45"
                              type: string
                            type: array
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get SPF Validations Time Series
      tags:
        - Radar Email Routing
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/summary/arc:
    get:
      description: Percentage distribution of emails classified per ARC validation.
      operationId: radar-get-email-security-summary-by-arc
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          FAIL:
                            example: "2"
                            type: string
                          NONE:
                            example: "53"
                            type: string
                          PASS:
                            example: "45"
                            type: string
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get ARC Validations Summary
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/summary/dkim:
    get:
      description: Percentage distribution of emails classified per DKIM validation.
      operationId: radar-get-email-security-summary-by-dkim
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          FAIL:
                            example: "2"
                            type: string
                          NONE:
                            example: "53"
                            type: string
                          PASS:
                            example: "45"
                            type: string
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get DKIM Validations Summary
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/summary/dmarc:
    get:
      description: Percentage distribution of emails classified per DMARC validation.
      operationId: radar-get-email-security-summary-by-dmarc
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          FAIL:
                            example: "2"
                            type: string
                          NONE:
                            example: "53"
                            type: string
                          PASS:
                            example: "45"
                            type: string
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get DMARC Validations Summary
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/summary/malicious:
    get:
      description: Percentage distribution of emails classified as MALICIOUS.
      operationId: radar-get-email-security-summary-by-malicious
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          MALICIOUS:
                            example: "65"
                            type: string
                          NOT_MALICIOUS:
                            example: "35"
                            type: string
                        required:
                          - MALICIOUS
                          - NOT_MALICIOUS
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get MALICIOUS Validations Summary
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/summary/spam:
    get:
      description: Proportion of emails categorized as either spam or legitimate (non-spam).
      operationId: radar-get-email-security-summary-by-spam
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          NOT_SPAM:
                            example: "35"
                            type: string
                          SPAM:
                            example: "65"
                            type: string
                        required:
                          - SPAM
                          - NOT_SPAM
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get SPAM Summary
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/summary/spf:
    get:
      description: Percentage distribution of emails classified per SPF validation.
      operationId: radar-get-email-security-summary-by-spf
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          FAIL:
                            example: "2"
                            type: string
                          NONE:
                            example: "53"
                            type: string
                          PASS:
                            example: "45"
                            type: string
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get SPF Validations Summary
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/summary/spoof:
    get:
      description: Proportion of emails categorized as either spoof or legitimate (non-spoof).
      operationId: radar-get-email-security-summary-by-spoof
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          NOT_SPOOF:
                            example: "35"
                            type: string
                          SPOOF:
                            example: "65"
                            type: string
                        required:
                          - SPOOF
                          - NOT_SPOOF
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get SPOOF Summary
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/summary/threat_category:
    get:
      description: Percentage distribution of emails classified in Threat Categories.
      operationId: radar-get-email-security-summary-by-threat-category
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          BrandImpersonation:
                            example: "35"
                            type: string
                          CredentialHarvester:
                            example: "32"
                            type: string
                          IdentityDeception:
                            example: "47"
                            type: string
                          Link:
                            example: "43"
                            type: string
                        required:
                          - IdentityDeception
                          - Link
                          - BrandImpersonation
                          - CredentialHarvester
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Threat Categories Summary
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/summary/tls_version:
    get:
      description: Percentage distribution of emails classified per TLS Version.
      operationId: radar-get-email-security-summary-by-tls-version
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          TLS 1.0:
                            example: "3"
                            type: string
                          TLS 1.1:
                            example: "12"
                            type: string
                          TLS 1.2:
                            example: "41"
                            type: string
                          TLS 1.3:
                            example: "44"
                            type: string
                        required:
                          - TLS 1.0
                          - TLS 1.1
                          - TLS 1.2
                          - TLS 1.3
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get TLS Version Summary
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/timeseries_groups/arc:
    get:
      description: Percentage distribution of emails classified per Arc validation over time.
      operationId: radar-get-email-security-timeseries-group-by-arc
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          FAIL:
                            items:
                              example: "2"
                              type: string
                            type: array
                          NONE:
                            items:
                              example: "53"
                              type: string
                            type: array
                          PASS:
                            items:
                              example: "45"
                              type: string
                            type: array
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get ARC Validations Time Series
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/timeseries_groups/dkim:
    get:
      description: Percentage distribution of emails classified per DKIM validation over time.
      operationId: radar-get-email-security-timeseries-group-by-dkim
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          FAIL:
                            items:
                              example: "2"
                              type: string
                            type: array
                          NONE:
                            items:
                              example: "53"
                              type: string
                            type: array
                          PASS:
                            items:
                              example: "45"
                              type: string
                            type: array
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get DKIM Validations Time Series
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/timeseries_groups/dmarc:
    get:
      description: Percentage distribution of emails classified per DMARC validation over time.
      operationId: radar-get-email-security-timeseries-group-by-dmarc
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          FAIL:
                            items:
                              example: "2"
                              type: string
                            type: array
                          NONE:
                            items:
                              example: "53"
                              type: string
                            type: array
                          PASS:
                            items:
                              example: "45"
                              type: string
                            type: array
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get DMARC Validations Time Series
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/timeseries_groups/malicious:
    get:
      description: Percentage distribution of emails classified as MALICIOUS over time.
      operationId: radar-get-email-security-timeseries-group-by-malicious
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          MALICIOUS:
                            items:
                              example: "65"
                              type: string
                            type: array
                          NOT_MALICIOUS:
                            items:
                              example: "35"
                              type: string
                            type: array
                        required:
                          - MALICIOUS
                          - NOT_MALICIOUS
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get MALICIOUS Validations Time Series
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/timeseries_groups/spam:
    get:
      description: Percentage distribution of emails classified as SPAM over time.
      operationId: radar-get-email-security-timeseries-group-by-spam
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          NOT_SPAM:
                            items:
                              example: "35"
                              type: string
                            type: array
                          SPAM:
                            items:
                              example: "65"
                              type: string
                            type: array
                        required:
                          - SPAM
                          - NOT_SPAM
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get SPAM Validations Time Series
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/timeseries_groups/spf:
    get:
      description: Percentage distribution of emails classified per SPF validation over time.
      operationId: radar-get-email-security-timeseries-group-by-spf
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          FAIL:
                            items:
                              example: "2"
                              type: string
                            type: array
                          NONE:
                            items:
                              example: "53"
                              type: string
                            type: array
                          PASS:
                            items:
                              example: "45"
                              type: string
                            type: array
                        required:
                          - NONE
                          - PASS
                          - FAIL
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get SPF Validations Time Series
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/timeseries_groups/spoof:
    get:
      description: Percentage distribution of emails classified as SPOOF over time.
      operationId: radar-get-email-security-timeseries-group-by-spoof
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          NOT_SPOOF:
                            items:
                              example: "35"
                              type: string
                            type: array
                          SPOOF:
                            items:
                              example: "65"
                              type: string
                            type: array
                        required:
                          - SPOOF
                          - NOT_SPOOF
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get SPOOF Validations Time Series
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/timeseries_groups/threat_category:
    get:
      description: Percentage distribution of emails classified in Threat Categories over time.
      operationId: radar-get-email-security-timeseries-group-by-threat-category
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          BrandImpersonation:
                            items:
                              example: "35"
                              type: string
                            type: array
                          CredentialHarvester:
                            items:
                              example: "32"
                              type: string
                            type: array
                          IdentityDeception:
                            items:
                              example: "47"
                              type: string
                            type: array
                          Link:
                            items:
                              example: "43"
                              type: string
                            type: array
                        required:
                          - IdentityDeception
                          - Link
                          - BrandImpersonation
                          - CredentialHarvester
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Threat Categories Time Series
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/timeseries_groups/tls_version:
    get:
      description: Percentage distribution of emails classified per TLS Version over time.
      operationId: radar-get-email-security-timeseries-group-by-tls-version
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          TLS 1.0:
                            items:
                              example: "3"
                              type: string
                            type: array
                          TLS 1.1:
                            items:
                              example: "12"
                              type: string
                            type: array
                          TLS 1.2:
                            items:
                              example: "41"
                              type: string
                            type: array
                          TLS 1.3:
                            items:
                              example: "44"
                              type: string
                            type: array
                        required:
                          - TLS 1.0
                          - TLS 1.1
                          - TLS 1.2
                          - TLS 1.3
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get TLS Version Time Series
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/top/tlds:
    get:
      description: Get the top TLDs by email messages. Values are a percentage out of the total emails.
      operationId: radar-get-email-security-top-tlds-by-messages
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Filter for TLDs by category.
          in: query
          name: tldCategory
          schema:
            description: Filter for TLDs by category.
            enum:
              - CLASSIC
              - COUNTRY
            example: CLASSIC
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            name:
                              example: com.
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - name
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top TLDs By Email Messages
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/top/tlds/malicious/{malicious}:
    get:
      description: Get the TLDs by emails classified as malicious or not.
      operationId: radar-get-email-security-top-tlds-by-malicious
      parameters:
        - description: Malicious.
          in: path
          name: malicious
          required: true
          schema:
            description: Malicious.
            enum:
              - MALICIOUS
              - NOT_MALICIOUS
            example: MALICIOUS
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Filter for TLDs by category.
          in: query
          name: tldCategory
          schema:
            description: Filter for TLDs by category.
            enum:
              - CLASSIC
              - COUNTRY
            example: CLASSIC
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            name:
                              example: com.
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - name
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top TLDs By Malicious Classification
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/top/tlds/spam/{spam}:
    get:
      description: Get the top TLDs by emails classified as Spam or not.
      operationId: radar-get-email-security-top-tlds-by-spam
      parameters:
        - description: Spam.
          in: path
          name: spam
          required: true
          schema:
            description: Spam.
            enum:
              - SPAM
              - NOT_SPAM
            example: SPAM
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Filter for TLDs by category.
          in: query
          name: tldCategory
          schema:
            description: Filter for TLDs by category.
            enum:
              - CLASSIC
              - COUNTRY
            example: CLASSIC
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            name:
                              example: com.
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - name
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top TLDs By Spam Classification
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/email/security/top/tlds/spoof/{spoof}:
    get:
      description: Get the TLDs by emails classified as spoof or not.
      operationId: radar-get-email-security-top-tlds-by-spoof
      parameters:
        - description: Spoof.
          in: path
          name: spoof
          required: true
          schema:
            description: Spoof.
            enum:
              - SPOOF
              - NOT_SPOOF
            example: SPOOF
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Filter for arc (Authenticated Received Chain).
          in: query
          name: arc
          schema:
            description: Filter for arc (Authenticated Received Chain).
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dkim.
          in: query
          name: dkim
          schema:
            description: Filter for dkim.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for dmarc.
          in: query
          name: dmarc
          schema:
            description: Filter for dmarc.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for spf.
          in: query
          name: spf
          schema:
            description: Filter for spf.
            example: PASS
            items:
              enum:
                - PASS
                - NONE
                - FAIL
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
              type: string
            type: array
        - description: Filter for TLDs by category.
          in: query
          name: tldCategory
          schema:
            description: Filter for TLDs by category.
            enum:
              - CLASSIC
              - COUNTRY
            example: CLASSIC
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            name:
                              example: com.
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - name
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top TLDs By Spoof Classification
      tags:
        - Radar Email Security
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/asns:
    get:
      description: Gets a list of autonomous systems (AS).
      operationId: radar-get-entities-asn-list
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Number of objects to skip before grabbing results.
          in: query
          name: offset
          schema:
            description: Number of objects to skip before grabbing results.
            type: integer
        - description: Comma separated list of ASNs.
          in: query
          name: asn
          schema:
            description: Comma separated list of ASNs.
            example: 174,7922
            type: string
        - description: Location Alpha2 to filter results.
          in: query
          name: location
          schema:
            description: Location Alpha2 to filter results.
            example: US
            type: string
        - description: Order asn list.
          in: query
          name: orderBy
          schema:
            default: ASN
            description: Order asn list.
            enum:
              - ASN
              - POPULATION
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      asns:
                        items:
                          properties:
                            aka:
                              type: string
                            asn:
                              example: 714
                              type: integer
                            country:
                              example: GB
                              type: string
                            countryName:
                              example: United Kingdom
                              type: string
                            name:
                              example: Apple Inc.
                              type: string
                            nameLong:
                              description: Deprecated field. Please use 'aka'.
                              type: string
                            orgName:
                              type: string
                            website:
                              example: https://www.apple.com/support/systemstatus/
                              type: string
                          required:
                            - name
                            - asn
                            - country
                            - countryName
                          type: object
                        type: array
                    required:
                      - asns
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get autonomous systems
      tags:
        - Radar Entities
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/asns/{asn}:
    get:
      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). Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).
      operationId: radar-get-entities-asn-by-id
      parameters:
        - description: Autonomous System Number (ASN).
          in: path
          name: asn
          required: true
          schema:
            description: Autonomous System Number (ASN).
            example: 3
            type: integer
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      asn:
                        properties:
                          aka:
                            type: string
                          asn:
                            example: 714
                            type: integer
                          confidenceLevel:
                            example: 5
                            type: integer
                          country:
                            example: GB
                            type: string
                          countryName:
                            example: United Kingdom
                            type: string
                          estimatedUsers:
                            properties:
                              estimatedUsers:
                                description: Total estimated users
                                example: 86099
                                type: integer
                              locations:
                                items:
                                  properties:
                                    estimatedUsers:
                                      description: Estimated users per location
                                      example: 16710
                                      type: integer
                                    locationAlpha2:
                                      example: US
                                      type: string
                                    locationName:
                                      example: United States
                                      type: string
                                  required:
                                    - locationName
                                    - locationAlpha2
                                  type: object
                                type: array
                            required:
                              - locations
                            type: object
                          name:
                            example: Apple Inc.
                            type: string
                          nameLong:
                            description: Deprecated field. Please use 'aka'.
                            type: string
                          orgName:
                            type: string
                          related:
                            items:
                              properties:
                                aka:
                                  type: string
                                asn:
                                  example: 174
                                  type: integer
                                estimatedUsers:
                                  description: Total estimated users
                                  example: 65345
                                  type: integer
                                name:
                                  example: Cogent-174
                                  type: string
                              required:
                                - name
                                - asn
                              type: object
                            type: array
                          source:
                            description: Regional Internet Registry
                            example: RIPE
                            type: string
                          website:
                            example: https://www.apple.com/support/systemstatus/
                            type: string
                        required:
                          - name
                          - country
                          - countryName
                          - confidenceLevel
                          - related
                          - source
                          - asn
                          - website
                          - orgName
                          - estimatedUsers
                        type: object
                    required:
                      - asn
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get autonomous system information by AS number
      tags:
        - Radar Entities
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/asns/{asn}/rel:
    get:
      description: Get AS-level relationship for given networks.
      operationId: radar-get-asns-rel
      parameters:
        - description: Get all ASNs with provider-customer or peering relationships with the given ASN
          in: path
          name: asn
          required: true
          schema:
            description: Get all ASNs with provider-customer or peering relationships with the given ASN
            example: 3
            type: integer
        - description: Get the AS relationship of ASN2 with respect to the given ASN
          in: query
          name: asn2
          schema:
            description: Get the AS relationship of ASN2 with respect to the given ASN
            type: integer
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          data_time:
                            type: string
                          query_time:
                            type: string
                          total_peers:
                            type: integer
                        required:
                          - data_time
                          - query_time
                          - total_peers
                        type: object
                      rels:
                        items:
                          properties:
                            asn1:
                              type: integer
                            asn1_country:
                              type: string
                            asn1_name:
                              type: string
                            asn2:
                              type: integer
                            asn2_country:
                              type: string
                            asn2_name:
                              type: string
                            rel:
                              type: string
                          required:
                            - asn1
                            - asn1_country
                            - asn1_name
                            - asn2
                            - asn2_country
                            - asn2_name
                            - rel
                          type: object
                        type: array
                    required:
                      - rels
                      - meta
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get AS-level relationships by AS number
      tags:
        - Radar Entities
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/asns/ip:
    get:
      description: Get the requested autonomous system information based on IP address. Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).
      operationId: radar-get-entities-asn-by-ip
      parameters:
        - description: IP address.
          in: query
          name: ip
          required: true
          schema:
            description: IP address.
            example: 8.8.8.8
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      asn:
                        properties:
                          aka:
                            type: string
                          asn:
                            example: 714
                            type: integer
                          country:
                            example: GB
                            type: string
                          countryName:
                            example: United Kingdom
                            type: string
                          estimatedUsers:
                            properties:
                              estimatedUsers:
                                description: Total estimated users
                                example: 86099
                                type: integer
                              locations:
                                items:
                                  properties:
                                    estimatedUsers:
                                      description: Estimated users per location
                                      example: 16710
                                      type: integer
                                    locationAlpha2:
                                      example: US
                                      type: string
                                    locationName:
                                      example: United States
                                      type: string
                                  required:
                                    - locationName
                                    - locationAlpha2
                                  type: object
                                type: array
                            required:
                              - locations
                            type: object
                          name:
                            example: Apple Inc.
                            type: string
                          nameLong:
                            description: Deprecated field. Please use 'aka'.
                            type: string
                          orgName:
                            type: string
                          related:
                            items:
                              properties:
                                aka:
                                  type: string
                                asn:
                                  type: integer
                                estimatedUsers:
                                  description: Total estimated users
                                  example: 65345
                                  type: integer
                                name:
                                  type: string
                              required:
                                - name
                                - asn
                              type: object
                            type: array
                          source:
                            description: Regional Internet Registry
                            example: RIPE
                            type: string
                          website:
                            example: https://www.apple.com/support/systemstatus/
                            type: string
                        required:
                          - name
                          - country
                          - countryName
                          - related
                          - asn
                          - website
                          - orgName
                          - source
                          - estimatedUsers
                        type: object
                    required:
                      - asn
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get autonomous system information by IP address
      tags:
        - Radar Entities
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/ip:
    get:
      description: 'Get IP address information. '
      operationId: radar-get-entities-ip
      parameters:
        - description: IP address.
          in: query
          name: ip
          required: true
          schema:
            description: IP address.
            example: 8.8.8.8
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      ip:
                        properties:
                          asn:
                            example: "15169"
                            type: string
                          asnLocation:
                            example: US
                            type: string
                          asnName:
                            example: GOOGLE
                            type: string
                          asnOrgName:
                            example: Google LLC
                            type: string
                          ip:
                            example: 8.8.8.8
                            type: string
                          ipVersion:
                            example: IPv4
                            type: string
                          location:
                            example: GB
                            type: string
                          locationName:
                            example: United Kingdom
                            type: string
                        required:
                          - ip
                          - ipVersion
                          - location
                          - locationName
                          - asn
                          - asnName
                          - asnLocation
                          - asnOrgName
                        type: object
                    required:
                      - ip
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get IP address
      tags:
        - Radar Entities
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/locations:
    get:
      description: Get a list of locations.
      operationId: radar-get-entities-locations
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Number of objects to skip before grabbing results.
          in: query
          name: offset
          schema:
            description: Number of objects to skip before grabbing results.
            type: integer
        - description: Comma separated list of locations.
          in: query
          name: location
          schema:
            description: Comma separated list of locations.
            example: US,CA
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      locations:
                        items:
                          properties:
                            alpha2:
                              example: AF
                              type: string
                            latitude:
                              example: 33.939116
                              type: string
                            longitude:
                              example: 67.709953
                              type: string
                            name:
                              example: Afghanistan
                              type: string
                          required:
                            - name
                            - latitude
                            - longitude
                            - alpha2
                          type: object
                        type: array
                    required:
                      - locations
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get locations
      tags:
        - Radar Entities
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/locations/{location}:
    get:
      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-entities-location-by-alpha2
      parameters:
        - description: Alpha-2 country code.
          in: path
          name: location
          required: true
          schema:
            description: Alpha-2 country code.
            example: US
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      location:
                        properties:
                          alpha2:
                            example: AF
                            type: string
                          confidenceLevel:
                            example: 5
                            type: integer
                          latitude:
                            example: 33.939116
                            type: string
                          longitude:
                            example: 67.709953
                            type: string
                          name:
                            example: Afghanistan
                            type: string
                          region:
                            example: Middle East
                            type: string
                          subregion:
                            example: Southern Asia
                            type: string
                        required:
                          - name
                          - region
                          - subregion
                          - latitude
                          - longitude
                          - alpha2
                          - confidenceLevel
                        type: object
                    required:
                      - location
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get location
      tags:
        - Radar Entities
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/summary/bot_class:
    get:
      description: Percentage distribution of bot-generated traffic to genuine human traffic, as classified by Cloudflare. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information.
      operationId: radar-get-http-summary-by-bot-class
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          bot:
                            example: "35"
                            type: string
                          human:
                            example: "65"
                            type: string
                        required:
                          - human
                          - bot
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Bot Class Summary
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/summary/device_type:
    get:
      description: Percentage of Internet traffic generated by mobile, desktop, and other types of devices, over a given time period.
      operationId: radar-get-http-summary-by-device-type
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          desktop:
                            example: "65"
                            type: string
                          mobile:
                            example: "30"
                            type: string
                          other:
                            example: "5"
                            type: string
                        required:
                          - desktop
                          - mobile
                          - other
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Device Type Summary
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/summary/http_protocol:
    get:
      description: Percentage distribution of traffic per HTTP protocol over a given time period.
      operationId: radar-get-http-summary-by-http-protocol
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          http:
                            example: "99"
                            type: string
                          https:
                            example: "1"
                            type: string
                        required:
                          - http
                          - https
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get HTTP protocols summary
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/summary/http_version:
    get:
      description: Percentage distribution of traffic per HTTP protocol version over a given time period.
      operationId: radar-get-http-summary-by-http-version
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          HTTP/1.x:
                            example: "1"
                            type: string
                          HTTP/2:
                            example: "39"
                            type: string
                          HTTP/3:
                            example: "60"
                            type: string
                        required:
                          - HTTP/1.x
                          - HTTP/2
                          - HTTP/3
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get HTTP Versions Summary
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/summary/ip_version:
    get:
      description: Percentage distribution of Internet traffic based on IP protocol versions, such as IPv4 and IPv6, over a given time period.
      operationId: radar-get-http-summary-by-ip-version
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          IPv4:
                            example: "65"
                            type: string
                          IPv6:
                            example: "35"
                            type: string
                        required:
                          - IPv4
                          - IPv6
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get IP Version Summary
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/summary/os:
    get:
      description: Percentage distribution of Internet traffic generated by different operating systems like Windows, macOS, Android, iOS, and others, over a given time period.
      operationId: radar-get-http-summary-by-operating-system
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          ANDROID:
                            example: "65"
                            type: string
                          IOS:
                            example: "35"
                            type: string
                        required:
                          - ANDROID
                          - IOS
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Operating Systems Summary
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/summary/post_quantum:
    get:
      description: Percentage distribution of traffic per Post Quantum support over a given time period.
      operationId: radar-get-http-summary-by-post-quantum
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          NOT_SUPPORTED:
                            example: "16"
                            type: string
                          SUPPORTED:
                            example: "84"
                            type: string
                        required:
                          - SUPPORTED
                          - NOT_SUPPORTED
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get HTTP Post Quantum summary
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/summary/tls_version:
    get:
      description: Percentage distribution of traffic per TLS protocol version, over a given time period.
      operationId: radar-get-http-summary-by-tls-version
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          TLS 1.0:
                            example: "0.5"
                            type: string
                          TLS 1.1:
                            example: "0.5"
                            type: string
                          TLS 1.2:
                            example: "60"
                            type: string
                          TLS 1.3:
                            example: "10"
                            type: string
                          TLS QUIC:
                            example: "29"
                            type: string
                        required:
                          - TLS 1.0
                          - TLS 1.1
                          - TLS 1.2
                          - TLS 1.3
                          - TLS QUIC
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get TLS Versions Summary
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/timeseries:
    get:
      description: Get HTTP requests over time.
      operationId: radar-get-http-timeseries
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE_CHANGE
              - MIN0_MAX
            example: MIN0_MAX
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          aggInterval:
                            example: 1h
                            type: string
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            format: date-time
                            type: string
                        required:
                          - dateRange
                          - aggInterval
                          - lastUpdated
                        type: object
                      serie_0:
                        properties:
                          timestamps:
                            items:
                              format: date-time
                              type: string
                            type: array
                          values:
                            items:
                              example: 0.56
                              type: string
                            type: array
                        required:
                          - timestamps
                          - values
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get HTTP requests Time Series
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/timeseries_groups/bot_class:
    get:
      description: Get a time series of the percentage distribution of traffic classified as automated or human. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information.
      operationId: radar-get-http-timeseries-group-by-bot-class
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          bot:
                            items:
                              type: string
                            type: array
                          human:
                            items:
                              type: string
                            type: array
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                          - human
                          - bot
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Bot Classes Time Series
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/timeseries_groups/browser:
    get:
      description: Get a time series of the percentage distribution of traffic of the top user agents.
      operationId: radar-get-http-timeseries-group-by-browsers
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
          in: query
          name: limitPerGroup
          schema:
            description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range.
            example: 4
            type: integer
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          Chrome:
                            - "50.168733"
                          timestamps:
                            - "2023-08-08T10:15:00Z"
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get User Agents Time Series
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/timeseries_groups/browser_family:
    get:
      description: Get a time series of the percentage distribution of traffic of the top user agents aggregated in families.
      operationId: radar-get-http-timeseries-group-by-browser-families
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          Chrome:
                            - "50.168733"
                          timestamps:
                            - "2023-08-08T10:15:00Z"
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get User Agent Families Time Series
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/timeseries_groups/device_type:
    get:
      description: Get a time series of the percentage distribution of traffic per device type.
      operationId: radar-get-http-timeseries-group-by-device-type
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          desktop:
                            items:
                              type: string
                            type: array
                          mobile:
                            items:
                              type: string
                            type: array
                          other:
                            items:
                              type: string
                            type: array
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                          - desktop
                          - mobile
                          - other
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Device Types Time Series
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/timeseries_groups/http_protocol:
    get:
      description: Get a time series of the percentage distribution of traffic per HTTP protocol.
      operationId: radar-get-http-timeseries-group-by-http-protocol
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          http:
                            items:
                              type: string
                            type: array
                          https:
                            items:
                              type: string
                            type: array
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                          - http
                          - https
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get HTTP protocols Time Series
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/timeseries_groups/http_version:
    get:
      description: Get a time series of the percentage distribution of traffic per HTTP protocol version.
      operationId: radar-get-http-timeseries-group-by-http-version
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          HTTP/1.x:
                            items:
                              type: string
                            type: array
                          HTTP/2:
                            items:
                              type: string
                            type: array
                          HTTP/3:
                            items:
                              type: string
                            type: array
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                          - HTTP/1.x
                          - HTTP/2
                          - HTTP/3
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get HTTP Versions Time Series
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/timeseries_groups/ip_version:
    get:
      description: Get a time series of the percentage distribution of traffic per IP protocol version.
      operationId: radar-get-http-timeseries-group-by-ip-version
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          IPv4:
                            items:
                              type: string
                            type: array
                          IPv6:
                            items:
                              type: string
                            type: array
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                          - IPv4
                          - IPv6
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get IP Versions Time Series
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/timeseries_groups/os:
    get:
      description: Get a time series of the percentage distribution of traffic of the top operating systems.
      operationId: radar-get-http-timeseries-group-by-operating-system
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        additionalProperties:
                          items:
                            type: string
                          type: array
                        example:
                          ANDROID:
                            - "97.28898"
                          timestamps:
                            - "2023-08-08T10:15:00Z"
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Operating Systems Time Series
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/timeseries_groups/post_quantum:
    get:
      description: Get a time series of the percentage distribution of traffic per Post Quantum suport.
      operationId: radar-get-http-timeseries-group-by-post-quantum
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          NOT_SUPPORTED:
                            items:
                              example: "16"
                              type: string
                            type: array
                          SUPPORTED:
                            items:
                              example: "84"
                              type: string
                            type: array
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                          - SUPPORTED
                          - NOT_SUPPORTED
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get HTTP Post Quantum Support Time Series
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/timeseries_groups/tls_version:
    get:
      description: Get a time series of the percentage distribution of traffic per TLS protocol version.
      operationId: radar-get-http-timeseries-group-by-tls-version
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          TLS 1.0:
                            items:
                              type: string
                            type: array
                          TLS 1.1:
                            items:
                              type: string
                            type: array
                          TLS 1.2:
                            items:
                              type: string
                            type: array
                          TLS 1.3:
                            items:
                              type: string
                            type: array
                          TLS QUIC:
                            items:
                              type: string
                            type: array
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                          - TLS 1.0
                          - TLS 1.1
                          - TLS 1.2
                          - TLS 1.3
                          - TLS QUIC
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get TLS Versions Time Series
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/ases:
    get:
      description: Get the top autonomous systems by HTTP traffic. Values are a percentage out of the total traffic.
      operationId: radar-get-http-top-ases-by-http-requests
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientASN:
                              example: 3243
                              type: integer
                            clientASName:
                              example: MEO
                              type: string
                            value:
                              example: "3"
                              type: string
                          required:
                            - clientASN
                            - clientASName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Autonomous Systems By HTTP Requests
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/ases/bot_class/{bot_class}:
    get:
      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-http-top-ases-by-bot-class
      parameters:
        - description: Bot class.
          in: path
          name: bot_class
          required: true
          schema:
            description: Bot class.
            enum:
              - LIKELY_AUTOMATED
              - LIKELY_HUMAN
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientASN:
                              example: 3243
                              type: integer
                            clientASName:
                              example: MEO
                              type: string
                            value:
                              example: "3"
                              type: string
                          required:
                            - clientASN
                            - clientASName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Autonomous Systems By Bot Class
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/ases/browser_family/{browser_family}:
    get:
      description: Get the top autonomous systems (AS), by HTTP traffic, of the requested browser family. Values are a percentage out of the total traffic.
      operationId: radar-get-http-top-ases-by-browser-family
      parameters:
        - description: Browser family.
          in: path
          name: browser_family
          required: true
          schema:
            description: Browser family.
            enum:
              - CHROME
              - EDGE
              - FIREFOX
              - SAFARI
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientASN:
                              example: 3243
                              type: integer
                            clientASName:
                              example: MEO
                              type: string
                            value:
                              example: "3"
                              type: string
                          required:
                            - clientASN
                            - clientASName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Autonomous Systems By Browser Family
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/ases/device_type/{device_type}:
    get:
      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-http-top-ases-by-device-type
      parameters:
        - description: Device type.
          in: path
          name: device_type
          required: true
          schema:
            description: Device type.
            enum:
              - DESKTOP
              - MOBILE
              - OTHER
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientASN:
                              example: 3243
                              type: integer
                            clientASName:
                              example: MEO
                              type: string
                            value:
                              example: "3"
                              type: string
                          required:
                            - clientASN
                            - clientASName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Autonomous Systems By Device Type
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/ases/http_protocol/{http_protocol}:
    get:
      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-http-top-ases-by-http-protocol
      parameters:
        - description: HTTP Protocol.
          in: path
          name: http_protocol
          required: true
          schema:
            description: HTTP Protocol.
            enum:
              - HTTP
              - HTTPS
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientASN:
                              example: 3243
                              type: integer
                            clientASName:
                              example: MEO
                              type: string
                            value:
                              example: "3"
                              type: string
                          required:
                            - clientASN
                            - clientASName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Autonomous Systems By HTTP Protocol
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/ases/http_version/{http_version}:
    get:
      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-http-top-ases-by-http-version
      parameters:
        - description: HTTP version.
          in: path
          name: http_version
          required: true
          schema:
            description: HTTP version.
            enum:
              - HTTPv1
              - HTTPv2
              - HTTPv3
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientASN:
                              example: 3243
                              type: integer
                            clientASName:
                              example: MEO
                              type: string
                            value:
                              example: "3"
                              type: string
                          required:
                            - clientASN
                            - clientASName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Autonomous Systems By HTTP Version
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/ases/ip_version/{ip_version}:
    get:
      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-http-top-ases-by-ip-version
      parameters:
        - description: IP version.
          in: path
          name: ip_version
          required: true
          schema:
            description: IP version.
            enum:
              - IPv4
              - IPv6
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientASN:
                              example: 3243
                              type: integer
                            clientASName:
                              example: MEO
                              type: string
                            value:
                              example: "3"
                              type: string
                          required:
                            - clientASN
                            - clientASName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Autonomous Systems By IP Version
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/ases/os/{os}:
    get:
      description: Get the top autonomous systems, by HTTP traffic, of the requested operating systems. Values are a percentage out of the total traffic.
      operationId: radar-get-http-top-ases-by-operating-system
      parameters:
        - description: Operating system.
          in: path
          name: os
          required: true
          schema:
            description: Operating system.
            enum:
              - WINDOWS
              - MACOSX
              - IOS
              - ANDROID
              - CHROMEOS
              - LINUX
              - SMART_TV
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientASN:
                              example: 3243
                              type: integer
                            clientASName:
                              example: MEO
                              type: string
                            value:
                              example: "3"
                              type: string
                          required:
                            - clientASN
                            - clientASName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Autonomous Systems By Operating System
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/ases/tls_version/{tls_version}:
    get:
      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-http-top-ases-by-tls-version
      parameters:
        - description: TLS version.
          in: path
          name: tls_version
          required: true
          schema:
            description: TLS version.
            enum:
              - TLSv1_0
              - TLSv1_1
              - TLSv1_2
              - TLSv1_3
              - TLSvQUIC
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientASN:
                              example: 3243
                              type: integer
                            clientASName:
                              example: MEO
                              type: string
                            value:
                              example: "3"
                              type: string
                          required:
                            - clientASN
                            - clientASName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Autonomous Systems By TLS Version
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/browser:
    get:
      description: Get the top user agents by HTTP traffic. Values are a percentage out of the total traffic.
      operationId: radar-get-http-top-browsers
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            name:
                              example: chrome
                              type: string
                            value:
                              type: string
                          required:
                            - name
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top User Agents By HTTP requests
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/browser_family:
    get:
      description: Get the top user agents aggregated in families by HTTP traffic. Values are a percentage out of the total traffic.
      operationId: radar-get-http-top-browser-families
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            name:
                              example: chrome
                              type: string
                            value:
                              type: string
                          required:
                            - name
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top User Agents Families by HTTP requests
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/locations:
    get:
      description: Get the top locations by HTTP traffic. Values are a percentage out of the total traffic.
      operationId: radar-get-http-top-locations-by-http-requests
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations By HTTP requests
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/locations/bot_class/{bot_class}:
    get:
      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-http-top-locations-by-bot-class
      parameters:
        - description: Bot class.
          in: path
          name: bot_class
          required: true
          schema:
            description: Bot class.
            enum:
              - LIKELY_AUTOMATED
              - LIKELY_HUMAN
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations By Bot Class
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/locations/browser_family/{browser_family}:
    get:
      description: Get the top locations, by HTTP traffic, of the requested browser family. Values are a percentage out of the total traffic.
      operationId: radar-get-http-top-locations-by-browser-family
      parameters:
        - description: Browser family.
          in: path
          name: browser_family
          required: true
          schema:
            description: Browser family.
            enum:
              - CHROME
              - EDGE
              - FIREFOX
              - SAFARI
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations By Browser Family
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/locations/device_type/{device_type}:
    get:
      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-http-top-locations-by-device-type
      parameters:
        - description: Device type.
          in: path
          name: device_type
          required: true
          schema:
            description: Device type.
            enum:
              - DESKTOP
              - MOBILE
              - OTHER
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations By Device Type
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/locations/http_protocol/{http_protocol}:
    get:
      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-http-top-locations-by-http-protocol
      parameters:
        - description: HTTP Protocol.
          in: path
          name: http_protocol
          required: true
          schema:
            description: HTTP Protocol.
            enum:
              - HTTP
              - HTTPS
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations By HTTP Protocol
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/locations/http_version/{http_version}:
    get:
      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-http-top-locations-by-http-version
      parameters:
        - description: HTTP version.
          in: path
          name: http_version
          required: true
          schema:
            description: HTTP version.
            enum:
              - HTTPv1
              - HTTPv2
              - HTTPv3
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations By HTTP Version
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/locations/ip_version/{ip_version}:
    get:
      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-http-top-locations-by-ip-version
      parameters:
        - description: IP version.
          in: path
          name: ip_version
          required: true
          schema:
            description: IP version.
            enum:
              - IPv4
              - IPv6
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations By IP Version
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/locations/os/{os}:
    get:
      description: Get the top locations, by HTTP traffic, of the requested operating systems. Values are a percentage out of the total traffic.
      operationId: radar-get-http-top-locations-by-operating-system
      parameters:
        - description: Operating system.
          in: path
          name: os
          required: true
          schema:
            description: Operating system.
            enum:
              - WINDOWS
              - MACOSX
              - IOS
              - ANDROID
              - CHROMEOS
              - LINUX
              - SMART_TV
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for tls version.
          in: query
          name: tlsVersion
          schema:
            description: Filter for tls version.
            example: TLSv1_2
            items:
              enum:
                - TLSv1_0
                - TLSv1_1
                - TLSv1_2
                - TLSv1_3
                - TLSvQUIC
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations By Operating System
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/http/top/locations/tls_version/{tls_version}:
    get:
      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-http-top-locations-by-tls-version
      parameters:
        - description: TLS version.
          in: path
          name: tls_version
          required: true
          schema:
            description: TLS version.
            enum:
              - TLSv1_0
              - TLSv1_1
              - TLSv1_2
              - TLSv1_3
              - TLSvQUIC
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
          in: query
          name: botClass
          schema:
            description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
            example: LIKELY_AUTOMATED
            items:
              enum:
                - LIKELY_AUTOMATED
                - LIKELY_HUMAN
              type: string
            type: array
        - description: Filter for device type.
          in: query
          name: deviceType
          schema:
            description: Filter for device type.
            example: DESKTOP
            items:
              enum:
                - DESKTOP
                - MOBILE
                - OTHER
              type: string
            type: array
        - description: Filter for http protocol.
          in: query
          name: httpProtocol
          schema:
            description: Filter for http protocol.
            example: HTTPS
            items:
              enum:
                - HTTP
                - HTTPS
              type: string
            type: array
        - description: Filter for http version.
          in: query
          name: httpVersion
          schema:
            description: Filter for http version.
            example: HTTPv1
            items:
              enum:
                - HTTPv1
                - HTTPv2
                - HTTPv3
              type: string
            type: array
        - description: Filter for ip version.
          in: query
          name: ipVersion
          schema:
            description: Filter for ip version.
            example: IPv4
            items:
              enum:
                - IPv4
                - IPv6
              type: string
            type: array
        - description: Filter for os name.
          in: query
          name: os
          schema:
            description: Filter for os name.
            example: WINDOWS
            items:
              enum:
                - WINDOWS
                - MACOSX
                - IOS
                - ANDROID
                - CHROMEOS
                - LINUX
                - SMART_TV
              type: string
            type: array
        - description: Filter for browser family.
          in: query
          name: browserFamily
          schema:
            description: Filter for browser family.
            example: CHROME
            items:
              enum:
                - CHROME
                - EDGE
                - FIREFOX
                - SAFARI
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations By TLS Version
      tags:
        - Radar Http
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/netflows/summary:
    get:
      description: Percentage distribution of HTTP vs other protocols traffic over a given time period.
      operationId: radar-get-netflows-summary
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                        required:
                          - dateRange
                        type: object
                      summary_0:
                        properties:
                          HTTP:
                            example: "60"
                            type: string
                          OTHER:
                            example: "39"
                            type: string
                        required:
                          - HTTP
                          - OTHER
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Netflows Summary
      tags:
        - Radar Netflows
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/netflows/timeseries:
    get:
      description: 'Get network traffic change over time. Visit https://en.wikipedia.org/wiki/NetFlow for more information on NetFlows. '
      operationId: radar-get-netflows-timeseries
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Array of network traffic product types.
          in: query
          name: product
          schema:
            description: Array of network traffic product types.
            example: all
            items:
              enum:
                - HTTP
                - ALL
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
          in: query
          name: normalization
          schema:
            description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
            enum:
              - PERCENTAGE_CHANGE
              - MIN0_MAX
            example: MIN0_MAX
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          aggInterval:
                            example: 1h
                            type: string
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            format: date-time
                            type: string
                        required:
                          - dateRange
                          - aggInterval
                          - lastUpdated
                        type: object
                      serie_0:
                        properties:
                          timestamps:
                            items:
                              format: date-time
                              type: string
                            type: array
                          values:
                            items:
                              example: 0.56
                              type: string
                            type: array
                        required:
                          - timestamps
                          - values
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get NetFlows Time Series
      tags:
        - Radar Netflows
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/netflows/top/ases:
    get:
      description: Get the top autonomous systems (AS) by network traffic (NetFlows) over a given time period. Visit https://en.wikipedia.org/wiki/NetFlow for more information.
      operationId: radar-get-netflows-top-ases
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      top_0:
                        items:
                          properties:
                            clientASN:
                              example: 16509
                              type: number
                            clientASName:
                              example: AMAZON-02
                              type: string
                            value:
                              example: "0.73996"
                              type: string
                          required:
                            - clientASN
                            - clientASName
                            - value
                          type: object
                        type: array
                    required:
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Autonomous Systems By Network Traffic
      tags:
        - Radar Netflows
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/netflows/top/locations:
    get:
      description: Get the top locations by network traffic (NetFlows) over a given time period. Visit https://en.wikipedia.org/wiki/NetFlow for more information.
      operationId: radar-get-netflows-top-locations
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      top_0:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: US
                              type: string
                            clientCountryName:
                              example: United States
                              type: string
                            value:
                              example: "0.73996"
                              type: string
                          required:
                            - clientCountryName
                            - clientCountryAlpha2
                            - value
                          type: object
                        type: array
                    required:
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Locations By Network Traffic
      tags:
        - Radar Netflows
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/quality/iqi/summary:
    get:
      description: Get a summary (percentiles) of bandwidth, latency or DNS response time from the Radar Internet Quality Index (IQI).
      operationId: radar-get-quality-index-summary
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: 'Which metric to return: bandwidth, latency or DNS response time.'
          in: query
          name: metric
          required: true
          schema:
            description: 'Which metric to return: bandwidth, latency or DNS response time.'
            enum:
              - BANDWIDTH
              - DNS
              - LATENCY
            example: latency
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          p25:
                            example: "32.20938"
                            type: string
                          p50:
                            example: "61.819881"
                            type: string
                          p75:
                            example: "133.813087"
                            type: string
                        required:
                          - p75
                          - p50
                          - p25
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get IQI Summary
      tags:
        - Radar Quality
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/quality/iqi/timeseries_groups:
    get:
      description: Get a time series (percentiles) of bandwidth, latency or DNS response time from the Radar Internet Quality Index (IQI).
      operationId: radar-get-quality-index-timeseries-group
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Enable interpolation for all series (using the average).
          in: query
          name: interpolation
          schema:
            description: Enable interpolation for all series (using the average).
            type: boolean
        - description: 'Which metric to return: bandwidth, latency or DNS response time.'
          in: query
          name: metric
          required: true
          schema:
            description: 'Which metric to return: bandwidth, latency or DNS response time.'
            enum:
              - BANDWIDTH
              - DNS
              - LATENCY
            example: latency
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        type: object
                      serie_0:
                        properties:
                          p25:
                            items:
                              example: "31.253439"
                              type: string
                            type: array
                          p50:
                            items:
                              example: "60.337738"
                              type: string
                            type: array
                          p75:
                            items:
                              example: "125.940175"
                              type: string
                            type: array
                          timestamps:
                            items:
                              example: "2023-04-17T00:00:00Z"
                              type: string
                            type: array
                        required:
                          - timestamps
                          - p75
                          - p50
                          - p25
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get IQI Time Series
      tags:
        - Radar Quality
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/quality/speed/histogram:
    get:
      description: Get an histogram from the previous 90 days of Cloudflare Speed Test data, split into fixed bandwidth (Mbps), latency (ms) or jitter (ms) buckets.
      operationId: radar-get-quality-speed-histogram
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: The width for every bucket in the histogram.
          in: query
          name: bucketSize
          schema:
            description: The width for every bucket in the histogram.
            type: integer
        - description: Metrics to be returned.
          in: query
          name: metricGroup
          schema:
            default: bandwidth
            description: Metrics to be returned.
            enum:
              - BANDWIDTH
              - LATENCY
              - JITTER
            example: bandwidth
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      histogram_0:
                        properties:
                          bandwidthDownload:
                            items:
                              example: "83681"
                              type: string
                            type: array
                          bandwidthUpload:
                            items:
                              example: "181079"
                              type: string
                            type: array
                          bucketMin:
                            items:
                              example: "0"
                              type: string
                            type: array
                        required:
                          - bandwidthUpload
                          - bandwidthDownload
                          - bucketMin
                        type: object
                      meta:
                        type: object
                    required:
                      - meta
                      - histogram_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Speed Tests Histogram
      tags:
        - Radar Quality
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/quality/speed/summary:
    get:
      description: Get a summary of bandwidth, latency, jitter and packet loss, from the previous 90 days of Cloudflare Speed Test data.
      operationId: radar-get-quality-speed-summary
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                          normalization:
                            example: PERCENTAGE
                            type: string
                        required:
                          - dateRange
                          - normalization
                          - lastUpdated
                        type: object
                      summary_0:
                        properties:
                          bandwidthDownload:
                            example: "83.765201"
                            type: string
                          bandwidthUpload:
                            example: "39.005561"
                            type: string
                          jitterIdle:
                            example: "25.648713"
                            type: string
                          jitterLoaded:
                            example: "77.462155"
                            type: string
                          latencyIdle:
                            example: "83.165385"
                            type: string
                          latencyLoaded:
                            example: "270.561124"
                            type: string
                          packetLoss:
                            example: "1.23705"
                            type: string
                        required:
                          - bandwidthDownload
                          - bandwidthUpload
                          - latencyIdle
                          - latencyLoaded
                          - jitterIdle
                          - jitterLoaded
                          - packetLoss
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Speed Tests Summary
      tags:
        - Radar Quality
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/quality/speed/top/ases:
    get:
      description: Get the top autonomous systems by bandwidth, latency, jitter or packet loss, from the previous 90 days of Cloudflare Speed Test data.
      operationId: radar-get-quality-speed-top-ases
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Metric to order the results by.
          in: query
          name: orderBy
          schema:
            default: BANDWIDTH_DOWNLOAD
            description: Metric to order the results by.
            enum:
              - BANDWIDTH_DOWNLOAD
              - BANDWIDTH_UPLOAD
              - LATENCY_IDLE
              - LATENCY_LOADED
              - JITTER_IDLE
              - JITTER_LOADED
            type: string
        - description: Reverse the order of results.
          in: query
          name: reverse
          schema:
            description: Reverse the order of results.
            type: boolean
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            bandwidthDownload:
                              example: "642.509004"
                              type: string
                            bandwidthUpload:
                              example: "300.672274"
                              type: string
                            clientASN:
                              example: 33353
                              type: number
                            clientASName:
                              example: SIE-CGEI-ASN-1
                              type: string
                            jitterIdle:
                              example: "2.956908"
                              type: string
                            jitterLoaded:
                              example: "19.500469"
                              type: string
                            latencyIdle:
                              example: "15.925"
                              type: string
                            latencyLoaded:
                              example: "65.65"
                              type: string
                            numTests:
                              example: 13123
                              type: number
                            rankPower:
                              example: 0.77
                              type: number
                          required:
                            - clientASN
                            - clientASName
                            - bandwidthDownload
                            - bandwidthUpload
                            - latencyIdle
                            - latencyLoaded
                            - jitterIdle
                            - jitterLoaded
                            - numTests
                            - rankPower
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Speed Test Autonomous Systems
      tags:
        - Radar Quality
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/quality/speed/top/locations:
    get:
      description: Get the top locations by bandwidth, latency, jitter or packet loss, from the previous 90 days of Cloudflare Speed Test data.
      operationId: radar-get-quality-speed-top-locations
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Metric to order the results by.
          in: query
          name: orderBy
          schema:
            default: BANDWIDTH_DOWNLOAD
            description: Metric to order the results by.
            enum:
              - BANDWIDTH_DOWNLOAD
              - BANDWIDTH_UPLOAD
              - LATENCY_IDLE
              - LATENCY_LOADED
              - JITTER_IDLE
              - JITTER_LOADED
            type: string
        - description: Reverse the order of results.
          in: query
          name: reverse
          schema:
            description: Reverse the order of results.
            type: boolean
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            bandwidthDownload:
                              example: "295.886073"
                              type: string
                            bandwidthUpload:
                              example: "158.85269"
                              type: string
                            clientCountryAlpha2:
                              example: IS
                              type: string
                            clientCountryName:
                              example: Iceland
                              type: string
                            jitterIdle:
                              example: "9.640685"
                              type: string
                            jitterLoaded:
                              example: "46.480023"
                              type: string
                            latencyIdle:
                              example: "15.208124"
                              type: string
                            latencyLoaded:
                              example: "114.758887"
                              type: string
                            numTests:
                              example: 13123
                              type: number
                            rankPower:
                              example: 0.77
                              type: number
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - bandwidthDownload
                            - bandwidthUpload
                            - latencyIdle
                            - latencyLoaded
                            - jitterIdle
                            - jitterLoaded
                            - numTests
                            - rankPower
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Speed Test Locations
      tags:
        - Radar Quality
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/ranking/domain/{domain}:
    get:
      description: "Gets Domains Rank details. \n    Cloudflare provides an ordered rank for the top 100 domains, but for the remainder it only provides ranking buckets\n    like top 200 thousand, top one million, etc.. These are available through Radar datasets endpoints."
      operationId: radar-get-ranking-domain-details
      parameters:
        - in: path
          name: domain
          required: true
          schema:
            example: google.com
            pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: The ranking type.
          in: query
          name: rankingType
          schema:
            default: POPULAR
            description: The ranking type.
            enum:
              - POPULAR
              - TRENDING_RISE
              - TRENDING_STEADY
            example: POPULAR
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - description: Array of dates to filter the ranking.
          in: query
          name: date
          schema:
            description: Array of dates to filter the ranking.
            example: "2022-09-19"
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      details_0:
                        properties:
                          bucket:
                            description: Only available in POPULAR ranking for the most recent ranking.
                            example: "2000"
                            type: string
                          categories:
                            items:
                              properties:
                                id:
                                  example: 81
                                  type: number
                                name:
                                  example: Content Servers
                                  type: string
                                superCategoryId:
                                  example: 26
                                  type: number
                              required:
                                - superCategoryId
                                - name
                                - id
                              type: object
                            type: array
                          rank:
                            example: 3
                            type: integer
                          top_locations:
                            items:
                              properties:
                                locationCode:
                                  example: US
                                  type: string
                                locationName:
                                  example: United States
                                  type: string
                                rank:
                                  example: 1
                                  type: integer
                              required:
                                - rank
                                - locationName
                                - locationCode
                              type: object
                            type: array
                        required:
                          - categories
                          - top_locations
                        type: object
                    required:
                      - details_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Domains Rank details
      tags:
        - Radar Ranking
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/ranking/timeseries_groups:
    get:
      description: Gets Domains Rank updates change over time. Raw values are returned.
      operationId: radar-get-ranking-domain-timeseries
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: The ranking type.
          in: query
          name: rankingType
          schema:
            default: POPULAR
            description: The ranking type.
            enum:
              - POPULAR
              - TRENDING_RISE
              - TRENDING_STEADY
            example: POPULAR
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - description: Array of locations (alpha-2 country codes).
          in: query
          name: location
          schema:
            description: Array of locations (alpha-2 country codes).
            example: US
            items:
              type: string
            type: array
        - description: Array of comma separated list of domains names.
          in: query
          name: domains
          schema:
            description: Array of comma separated list of domains names.
            example: google.com,facebook.com
            items:
              pattern: ^([a-zA-Z0-9]([a-zA-Z0-9-]{0,63}[a-zA-Z0-9-])?\.)+[a-zA-Z0-9-]{2,63}$
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                        required:
                          - dateRange
                        type: object
                      serie_0:
                        additionalProperties:
                          items:
                            anyOf:
                              - type: string
                              - type: number
                          type: array
                        example:
                          google.com:
                            - 2
                          timestamps:
                            - "2022-09-02"
                        properties:
                          timestamps:
                            items:
                              type: string
                            type: array
                        required:
                          - timestamps
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Domains Rank time series
      tags:
        - Radar Ranking
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/ranking/top:
    get:
      description: Get top or trending domains based on their rank. Popular domains are domains of broad appeal based on how people use the Internet. Trending domains are domains that are generating a surge in interest. For more information on top domains, see https://blog.cloudflare.com/radar-domain-rankings/.
      operationId: radar-get-ranking-top-domains
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - description: Array of locations (alpha-2 country codes).
          in: query
          name: location
          schema:
            description: Array of locations (alpha-2 country codes).
            example: US
            items:
              type: string
            type: array
        - description: Array of dates to filter the ranking.
          in: query
          name: date
          schema:
            description: Array of dates to filter the ranking.
            example: "2022-09-19"
            items:
              type: string
            type: array
        - description: The ranking type.
          in: query
          name: rankingType
          schema:
            default: POPULAR
            description: The ranking type.
            enum:
              - POPULAR
              - TRENDING_RISE
              - TRENDING_STEADY
            example: POPULAR
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          top_0:
                            properties:
                              date:
                                example: "2022-09-19"
                                type: string
                            required:
                              - date
                            type: object
                        required:
                          - top_0
                        type: object
                      top_0:
                        items:
                          properties:
                            categories:
                              items:
                                properties:
                                  id:
                                    example: 81
                                    type: number
                                  name:
                                    example: Content Servers
                                    type: string
                                  superCategoryId:
                                    example: 26
                                    type: number
                                required:
                                  - superCategoryId
                                  - name
                                  - id
                                type: object
                              type: array
                            domain:
                              example: google.com
                              type: string
                            pctRankChange:
                              description: Only available in TRENDING rankings.
                              example: 10.8
                              type: number
                            rank:
                              example: 1
                              type: integer
                          required:
                            - rank
                            - domain
                            - categories
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top or Trending Domains
      tags:
        - Radar Ranking
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/robots_txt/domains:
    get:
      description: Get the top User-Agents on robots.txt files by domain.
      operationId: radar-get-robots-txt-top-by-domain
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Number of objects to skip before grabbing results.
          in: query
          name: offset
          schema:
            description: Number of objects to skip before grabbing results.
            type: integer
        - description: Filter domains by category
          in: query
          name: domainCategory
          schema:
            description: Filter domains by category
            type: string
        - description: Filter domains by name
          in: query
          name: domainName
          schema:
            description: Filter domains by name
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      date:
                        type: string
                      domains:
                        items:
                          properties:
                            '*':
                              type: string
                            amazonbot:
                              type: string
                            categories_parent:
                              type: string
                            categories_sub:
                              type: string
                            domain:
                              type: string
                          required:
                            - domain
                            - categories_sub
                            - categories_parent
                            - '*'
                            - amazonbot
                          type: object
                        type: array
                      userAgents:
                        items:
                          example: amazonbot
                          type: string
                        type: array
                    required:
                      - date
                      - userAgents
                      - domains
                    type: object
                  resultInfo:
                    properties:
                      limit:
                        type: integer
                      offset:
                        type: integer
                      total:
                        type: integer
                    required:
                      - limit
                      - offset
                      - total
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - resultInfo
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top User-Agents by Domain
      tags:
        - Radar Robots.txt
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/robots_txt/top/{directive}:
    get:
      description: Get the top User-Agents on robots.txt files by directive.
      operationId: radar-get-robots-txt-top-by-directive
      parameters:
        - description: Robots.txt directive.
          in: path
          name: directive
          required: true
          schema:
            description: Robots.txt directive.
            enum:
              - ALLOW
              - DISALLOW
            type: string
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - description: Filter by user agent category.
          in: query
          name: agentCategory
          schema:
            default: AI
            description: Filter by user agent category.
            enum:
              - AI
            example: AI
            type: string
        - description: Date to filter the ranking.
          in: query
          name: date
          schema:
            description: Date to filter the ranking.
            example: "2024-09-19"
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            example: "2023-07-26T08:59:57Z"
                            type: string
                        required:
                          - dateRange
                          - lastUpdated
                        type: object
                      top_0:
                        items:
                          properties:
                            date:
                              type: string
                            fully:
                              example: 235
                              type: integer
                            partially:
                              example: 38
                              type: integer
                            total:
                              example: 273
                              type: integer
                            userAgent:
                              example: GPTBot
                              type: string
                          required:
                            - userAgent
                            - fully
                            - partially
                            - total
                            - date
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "404":
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                  - error
                type: object
          description: Not found
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top User-Agents by Directive
      tags:
        - Radar Robots.txt
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/search/global:
    get:
      description: Lets you search for locations, autonomous systems (AS) and reports.
      operationId: radar-get-search-global
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Limit the number of objects per search category.
          in: query
          name: limitPerGroup
          schema:
            description: Limit the number of objects per search category.
            type: number
        - description: Search for locations, AS and reports.
          in: query
          name: query
          required: true
          schema:
            description: Search for locations, AS and reports.
            example: United
            type: string
        - description: Search types to be included in results.
          in: query
          name: include
          schema:
            description: Search types to be included in results.
            items:
              enum:
                - SPECIAL_EVENTS
                - NOTEBOOKS
                - LOCATIONS
                - ASNS
              type: string
            type: array
        - description: Search types to be excluded from results.
          in: query
          name: exclude
          schema:
            description: Search types to be excluded from results.
            items:
              enum:
                - SPECIAL_EVENTS
                - NOTEBOOKS
                - LOCATIONS
                - ASNS
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      search:
                        items:
                          properties:
                            code:
                              example: "13335"
                              type: string
                            name:
                              example: Cloudflare
                              type: string
                            type:
                              example: asn
                              type: string
                          required:
                            - code
                            - name
                            - type
                          type: object
                        type: array
                    required:
                      - search
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Search for locations, autonomous systems (AS) and reports.
      tags:
        - Radar Search
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/tcp_resets_timeouts/summary:
    get:
      description: Percentage distribution by connection stage of TCP connections terminated within the first 10 packets by a reset or timeout, for a given time period.
      operationId: radar-get-tcp-resets-timeouts-summary
      parameters:
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                        required:
                          - dateRange
                        type: object
                      summary_0:
                        properties:
                          later_in_flow:
                            description: Connection resets within the first 10 packets from the client, but after the server has received multiple data packets.
                            example: "10"
                            type: string
                          no_match:
                            description: All other connections.
                            example: "65"
                            type: string
                          post_ack:
                            description: Connection resets or timeouts after the server received both a SYN packet and an ACK packet, meaning the connection was successfully established.
                            example: "5"
                            type: string
                          post_psh:
                            description: Connection resets or timeouts after the server received a packet with PSH flag set, following connection establishment.
                            example: "10"
                            type: string
                          post_syn:
                            description: Connection resets or timeouts after the server received only a single SYN packet.
                            example: "10"
                            type: string
                        required:
                          - no_match
                          - post_syn
                          - post_ack
                          - post_psh
                          - later_in_flow
                        type: object
                    required:
                      - meta
                      - summary_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get TCP Resets Timeouts Summary
      tags:
        - Radar TCP Resets Timeouts
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/tcp_resets_timeouts/timeseries_groups:
    get:
      description: Percentage distribution by connection stage of TCP connections terminated within the first 10 packets by a reset or timeout, over time.
      operationId: radar-get-tcp-resets-timeouts-timeseries-group
      parameters:
        - description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
          in: query
          name: aggInterval
          schema:
            description: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
            enum:
              - 15m
              - 1h
              - 1d
              - 1w
            example: 1h
            type: string
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          aggInterval:
                            example: 1h
                            type: string
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                          lastUpdated:
                            format: date-time
                            type: string
                        required:
                          - dateRange
                          - aggInterval
                          - lastUpdated
                        type: object
                      serie_0:
                        properties:
                          later_in_flow:
                            description: Connection resets within the first 10 packets from the client, but after the server has received multiple data packets.
                            items:
                              description: Connection resets within the first 10 packets from the client, but after the server has received multiple data packets.
                              example: "10"
                              type: string
                            type: array
                          no_match:
                            description: All other connections.
                            items:
                              description: All other connections.
                              example: "65"
                              type: string
                            type: array
                          post_ack:
                            description: Connection resets or timeouts after the server received both a SYN packet and an ACK packet, meaning the connection was successfully established.
                            items:
                              description: Connection resets or timeouts after the server received both a SYN packet and an ACK packet, meaning the connection was successfully established.
                              example: "5"
                              type: string
                            type: array
                          post_psh:
                            description: Connection resets or timeouts after the server received a packet with PSH flag set, following connection establishment.
                            items:
                              description: Connection resets or timeouts after the server received a packet with PSH flag set, following connection establishment.
                              example: "10"
                              type: string
                            type: array
                          post_syn:
                            description: Connection resets or timeouts after the server received only a single SYN packet.
                            items:
                              description: Connection resets or timeouts after the server received only a single SYN packet.
                              example: "10"
                              type: string
                            type: array
                          timestamps:
                            items:
                              format: date-time
                              type: string
                            type: array
                        required:
                          - timestamps
                          - no_match
                          - post_syn
                          - post_ack
                          - post_psh
                          - later_in_flow
                        type: object
                    required:
                      - meta
                      - serie_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get TCP Resets Timeouts Time Series
      tags:
        - Radar TCP Resets Timeouts
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/traffic_anomalies:
    get:
      description: "Internet traffic anomalies are signals that might point to an outage,\n        These alerts are automatically detected by Radar and then manually verified by our team.\n        This endpoint returns the latest alerts.\n        "
      operationId: radar-get-traffic-anomalies
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Number of objects to skip before grabbing results.
          in: query
          name: offset
          schema:
            description: Number of objects to skip before grabbing results.
            type: integer
        - description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
          in: query
          name: dateRange
          schema:
            description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
            example: 7d
            pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
            type: string
        - description: Start of the date range (inclusive).
          in: query
          name: dateStart
          schema:
            description: Start of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - in: query
          name: status
          schema:
            enum:
              - VERIFIED
              - UNVERIFIED
            type: string
        - description: Single ASN as integer.
          in: query
          name: asn
          schema:
            description: Single ASN as integer.
            example: "174"
            type: integer
        - description: Location Alpha2 code.
          in: query
          name: location
          schema:
            description: Location Alpha2 code.
            example: US
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      trafficAnomalies:
                        items:
                          properties:
                            asnDetails:
                              properties:
                                asn:
                                  example: "189"
                                  type: string
                                locations:
                                  properties:
                                    code:
                                      example: US
                                      type: string
                                    name:
                                      example: United States
                                      type: string
                                  required:
                                    - code
                                    - name
                                  type: object
                                name:
                                  example: LUMEN-LEGACY-L3-PARTITION
                                  type: string
                              required:
                                - asn
                                - name
                              type: object
                            endDate:
                              example: "2023-08-03T23:15:00Z"
                              type: string
                            locationDetails:
                              properties:
                                code:
                                  example: US
                                  type: string
                                name:
                                  example: United States
                                  type: string
                              required:
                                - code
                                - name
                              type: object
                            startDate:
                              example: "2023-08-02T23:15:00Z"
                              type: string
                            status:
                              example: UNVERIFIED
                              type: string
                            type:
                              example: LOCATION
                              type: string
                            uuid:
                              example: 55a57f33-8bc0-4984-b4df-fdaff72df39d
                              type: string
                            visibleInDataSources:
                              items:
                                type: string
                              type: array
                          required:
                            - uuid
                            - type
                            - status
                            - startDate
                          type: object
                        type: array
                    required:
                      - trafficAnomalies
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: List of Internet traffic anomalies
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get latest Internet traffic anomalies.
      tags:
        - Radar Traffic Anomalies
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/traffic_anomalies/locations:
    get:
      description: "Internet traffic anomalies are signals that might point to an outage,\n        These alerts are automatically detected by Radar and then manually verified by our team.\n        This endpoint returns the sum of alerts grouped by location.\n        "
      operationId: radar-get-traffic-anomalies-top
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
          in: query
          name: dateRange
          schema:
            description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
            example: 7d
            pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
            type: string
        - description: Start of the date range (inclusive).
          in: query
          name: dateStart
          schema:
            description: Start of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            format: date-time
            type: string
        - in: query
          name: status
          schema:
            enum:
              - VERIFIED
              - UNVERIFIED
            type: string
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      trafficAnomalies:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: PT
                              type: string
                            clientCountryName:
                              example: Portugal
                              type: string
                            value:
                              example: "5"
                              type: string
                          required:
                            - clientCountryAlpha2
                            - clientCountryName
                            - value
                          type: object
                        type: array
                    required:
                      - trafficAnomalies
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: List of locations with number of traffic anomalies
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get top locations by total traffic anomalies generated.
      tags:
        - Radar Traffic Anomalies
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/verified_bots/top/bots:
    get:
      description: Get top verified bots by HTTP requests, with owner and category.
      operationId: radar-get-verified-bots-top-by-http-requests
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                        required:
                          - dateRange
                        type: object
                      top_0:
                        items:
                          properties:
                            botCategory:
                              example: Search Engine Crawler
                              type: string
                            botName:
                              example: GoogleBot
                              type: string
                            botOwner:
                              example: Google
                              type: string
                            value:
                              example: "29.034407"
                              type: string
                          required:
                            - botName
                            - botCategory
                            - botOwner
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Verified Bots By HTTP Requests
      tags:
        - Radar Verified Bots
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/verified_bots/top/categories:
    get:
      description: Get top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests.
      operationId: radar-get-verified-bots-top-categories-by-http-requests
      parameters:
        - description: Limit the number of objects in the response.
          in: query
          name: limit
          schema:
            description: Limit the number of objects in the response.
            example: 5
            type: integer
        - description: Array of names that will be used to name the series in responses.
          in: query
          name: name
          schema:
            description: Array of names that will be used to name the series in responses.
            example: main_series
            items:
              type: string
            type: array
        - 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).
          in: query
          name: dateRange
          schema:
            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).
            example: 7d
            items:
              example: 7d
              pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
              type: string
            type: array
        - description: Array of datetimes to filter the start of a series.
          in: query
          name: dateStart
          schema:
            description: Array of datetimes to filter the start of a series.
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - description: End of the date range (inclusive).
          in: query
          name: dateEnd
          schema:
            description: End of the date range (inclusive).
            example: "2023-09-01T11:41:33.782Z"
            items:
              format: date-time
              type: string
            type: array
        - 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.
          in: query
          name: asn
          schema:
            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"
            items:
              type: string
            type: array
        - 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.
          in: query
          name: location
          schema:
            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
            items:
              type: string
            type: array
        - description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          in: query
          name: continent
          schema:
            description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
            example: EU,NA
            items:
              type: string
            type: array
        - description: Format results are returned in.
          in: query
          name: format
          schema:
            description: Format results are returned in.
            enum:
              - JSON
              - CSV
            example: json
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          confidenceInfo:
                            properties:
                              annotations:
                                items:
                                  properties:
                                    dataSource:
                                      example: ALL
                                      type: string
                                    description:
                                      example: Cable cut in Tonga
                                      type: string
                                    endTime:
                                      format: date-time
                                      type: string
                                    eventType:
                                      example: OUTAGE
                                      type: string
                                    isInstantaneous:
                                      example: true
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      format: date-time
                                      type: string
                                  required:
                                    - dataSource
                                    - eventType
                                    - description
                                    - isInstantaneous
                                  type: object
                                type: array
                              level:
                                type: integer
                            type: object
                          dateRange:
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  example: "2022-09-17T10:22:57.555Z"
                                  format: date-time
                                  type: string
                                startTime:
                                  description: Adjusted start of date range.
                                  example: "2022-09-16T10:22:57.555Z"
                                  format: date-time
                                  type: string
                              required:
                                - startTime
                                - endTime
                              type: object
                            type: array
                        required:
                          - dateRange
                        type: object
                      top_0:
                        items:
                          properties:
                            botCategory:
                              example: Search
                              type: string
                            value:
                              example: "65"
                              type: string
                          required:
                            - botCategory
                            - value
                          type: object
                        type: array
                    required:
                      - meta
                      - top_0
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                  - result
                  - success
                type: object
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                        - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                  - result
                  - success
                  - errors
                type: object
          description: Bad Request
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get Top Verified Bot Categories By HTTP Requests
      tags:
        - Radar Verified Bots
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user:
    get:
      operationId: user-user-details
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: User Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_user_response'
          description: User Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform User Details
      tags:
        - User
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    patch:
      description: Edit part of your user details.
      operationId: user-edit-user
      requestBody:
        content:
          application/json:
            schema:
              properties:
                country:
                  $ref: '#/components/schemas/iam_country'
                first_name:
                  $ref: '#/components/schemas/iam_first_name'
                last_name:
                  $ref: '#/components/schemas/iam_last_name'
                telephone:
                  $ref: '#/components/schemas/iam_telephone'
                zipcode:
                  $ref: '#/components/schemas/iam_zipcode'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Edit User response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_user_response'
          description: Edit User response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Edit User
      tags:
        - User
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.user.update
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/audit_logs:
    get:
      description: Gets a list of audit logs for a user account. Can be filtered by who made the change, on which zone, and the timeframe of the change.
      operationId: audit-logs-get-user-audit-logs
      parameters:
        - in: query
          name: id
          schema:
            description: Finds a specific log by its ID.
            example: f174be97-19b1-40d6-954d-70cd5fbd52db
            type: string
        - in: query
          name: export
          schema:
            description: Indicates that this request is an export of logs in CSV format.
            example: true
            type: boolean
        - in: query
          name: action.type
          schema:
            description: Filters by the action type.
            example: add
            type: string
        - in: query
          name: actor.ip
          schema:
            description: Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.
            example: 17.168.228.63
            type: string
        - in: query
          name: actor.email
          schema:
            description: Filters by the email address of the actor that made the change.
            example: alice@example.com
            format: email
            type: string
        - in: query
          name: since
          schema:
            oneOf:
              - description: Limits the returned results to logs newer than the specified date. A `full-date` that conforms to RFC3339.
                example: "2019-04-30"
                format: date
                type: string
              - description: Limits the returned results to logs newer than the specified date. A `date-time` that conforms to RFC3339.
                example: "2019-04-30T01:12:20Z"
                format: date-time
                type: string
        - in: query
          name: before
          schema:
            oneOf:
              - description: Limits the returned results to logs older than the specified date. A `full-date` that conforms to RFC3339.
                example: "2019-04-30"
                format: date
                type: string
              - description: Limits the returned results to logs older than the specified date. A `date-time` that conforms to RFC3339.
                example: "2019-04-30T01:12:20Z"
                format: date-time
                type: string
        - in: query
          name: zone.name
          schema:
            description: Filters by the name of the zone associated to the change.
            example: example.com
            type: string
        - in: query
          name: direction
          schema:
            default: desc
            description: Changes the direction of the chronological sorting.
            enum:
              - desc
              - asc
            example: desc
            type: string
        - in: query
          name: per_page
          schema:
            default: 100
            description: Sets the number of results to return per page.
            example: 25
            maximum: 1000
            minimum: 1
            type: number
        - in: query
          name: page
          schema:
            default: 1
            description: Defines which page of results to return.
            example: 50
            minimum: 1
            type: number
        - in: query
          name: hide_user_logs
          schema:
            default: false
            description: Indicates whether or not to hide user level audit logs.
            type: boolean
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/aaa_audit_logs_response_collection'
                  - $ref: '#/components/schemas/aaa_api-response-common-failure'
          description: Get user audit logs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_audit_logs_response_collection'
          description: Get user audit logs response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get user audit logs
      tags:
        - Audit Logs
      x-api-token-group:
        - Account Settings Write
        - Account Settings Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/billing/history:
    get:
      deprecated: true
      description: Accesses your billing history object.
      operationId: user-billing-history-(-deprecated)-billing-history-details
      parameters:
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 20
            description: Number of items per page.
            maximum: 50
            minimum: 5
            type: number
        - in: query
          name: order
          schema:
            description: Field to order billing history by.
            enum:
              - type
              - occurred_at
              - action
            example: occurred_at
            type: string
        - in: query
          name: occurred_at
          schema:
            $ref: '#/components/schemas/bill-subs-api_occurred_at'
        - in: query
          name: type
          schema:
            description: The billing item type.
            example: charge
            maxLength: 30
            readOnly: true
            type: string
        - in: query
          name: action
          schema:
            description: The billing item action.
            example: subscription
            maxLength: 30
            readOnly: true
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/bill-subs-api_billing_history_collection'
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Billing History Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_billing_history_collection'
          description: Billing History Details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Billing History Details
      tags:
        - User Billing History
      x-api-token-group:
        - Billing Write
        - Billing Read
      x-cfPermissionsRequired:
        enum:
          - '#billing:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/billing/profile:
    get:
      deprecated: true
      description: Accesses your billing profile object.
      operationId: user-billing-profile-(-deprecated)-billing-profile-details
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/bill-subs-api_billing_response_single'
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Billing Profile Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_billing_response_single'
          description: Billing Profile Details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Billing Profile Details
      tags:
        - User Billing Profile
      x-api-token-group:
        - Billing Write
        - Billing Read
      x-cfPermissionsRequired:
        enum:
          - '#billing:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/firewall/access_rules/rules:
    get:
      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
      parameters:
        - in: query
          name: mode
          schema:
            $ref: '#/components/schemas/firewall_schemas-mode'
        - in: query
          name: configuration.target
          schema:
            description: The target to search in existing rules.
            enum:
              - ip
              - ip_range
              - asn
              - country
            example: ip
            type: string
        - in: query
          name: configuration.value
          schema:
            description: |-
              The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.
              Notes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.
            example: 198.51.100.4
            type: string
        - in: query
          name: notes
          schema:
            description: |-
              The string to search for in the notes of existing IP Access rules.
              Notes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.
            example: my note
            type: string
        - in: query
          name: match
          schema:
            default: all
            description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
            enum:
              - any
              - all
            type: string
        - in: query
          name: page
          schema:
            description: Requested page within paginated list of results.
            example: 1
            type: number
        - in: query
          name: per_page
          schema:
            description: Maximum number of results requested.
            example: 20
            type: number
        - in: query
          name: order
          schema:
            description: The field used to sort returned rules.
            enum:
              - configuration.target
              - configuration.value
              - mode
            example: mode
            type: string
        - in: query
          name: direction
          schema:
            description: The direction used to sort returned rules.
            enum:
              - asc
              - desc
            example: desc
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/firewall_rule_collection_response'
                  - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: List IP Access rules response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_rule_collection_response'
          description: List IP Access rules response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List IP Access rules
      tags:
        - IP Access Rules for a User
      x-api-token-group:
        - Account Firewall Access Rules Write
        - Account Firewall Access Rules Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      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:
        content:
          application/json:
            schema:
              properties:
                configuration:
                  $ref: '#/components/schemas/firewall_configuration'
                mode:
                  $ref: '#/components/schemas/firewall_schemas-mode'
                notes:
                  $ref: '#/components/schemas/firewall_notes'
              required:
                - mode
                - configuration
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/firewall_rule_single_response'
                  - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: Create an IP Access rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_rule_single_response'
          description: Create an IP Access rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create an IP Access rule
      tags:
        - IP Access Rules for a User
      x-api-token-group:
        - Account Firewall Access Rules Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/firewall/access_rules/rules/{identifier}:
    delete:
      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:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/firewall_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/firewall_rule_single_id_response'
                  - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: Delete an IP Access rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_rule_single_id_response'
          description: Delete an IP Access rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an IP Access rule
      tags:
        - IP Access Rules for a User
      x-api-token-group:
        - Account Firewall Access Rules Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    patch:
      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:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/firewall_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                mode:
                  $ref: '#/components/schemas/firewall_schemas-mode'
                notes:
                  $ref: '#/components/schemas/firewall_notes'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/firewall_rule_single_response'
                  - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: Update an IP Access rule response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_rule_single_response'
          description: Update an IP Access rule response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an IP Access rule
      tags:
        - IP Access Rules for a User
      x-api-token-group:
        - Account Firewall Access Rules Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/invites:
    get:
      description: Lists all invitations associated with my user.
      operationId: user'-s-invites-list-invitations
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Invitations response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_schemas-collection_invite_response'
          description: List Invitations response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Invitations
      tags:
        - User's Invites
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /user/invites/{invite_id}:
    get:
      description: Gets the details of an invitation.
      operationId: user'-s-invites-invitation-details
      parameters:
        - in: path
          name: invite_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_invite_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Invitation Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_invite_response'
          description: Invitation Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Invitation Details
      tags:
        - User's Invites
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      description: Responds to an invitation.
      operationId: user'-s-invites-respond-to-invitation
      parameters:
        - in: path
          name: invite_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_invite_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                status:
                  description: Status of your response to the invitation (rejected or accepted).
                  enum:
                    - accepted
                    - rejected
                  example: accepted
              required:
                - status
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Respond to Invitation response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_invite_response'
          description: Respond to Invitation response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Respond to Invitation
      tags:
        - User's Invites
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /user/load_balancers/monitors:
    get:
      description: List configured monitors for a user.
      operationId: load-balancer-monitors-list-monitors
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_monitor-response-collection'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: List Monitors response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-collection'
          description: List Monitors response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Monitors
      tags:
        - Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
        - 'Load Balancing: Monitors and Pools Read'
    post:
      description: Create a configured monitor.
      operationId: load-balancer-monitors-create-monitor
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-editable'
                - required:
                    - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Create Monitor response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
          description: Create Monitor response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create Monitor
      tags:
        - Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
  /user/load_balancers/monitors/{monitor_id}:
    delete:
      description: Delete a configured monitor.
      operationId: load-balancer-monitors-delete-monitor
      parameters:
        - in: path
          name: monitor_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_id_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Delete Monitor response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_id_response'
          description: Delete Monitor response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete Monitor
      tags:
        - Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
    get:
      description: List a single configured monitor for a user.
      operationId: load-balancer-monitors-monitor-details
      parameters:
        - in: path
          name: monitor_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Monitor Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
          description: Monitor Details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Monitor Details
      tags:
        - Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
        - 'Load Balancing: Monitors and Pools Read'
    patch:
      description: Apply changes to an existing monitor, overwriting the supplied properties.
      operationId: load-balancer-monitors-patch-monitor
      parameters:
        - in: path
          name: monitor_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-editable'
                - required:
                    - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Patch Monitor response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
          description: Patch Monitor response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Patch Monitor
      tags:
        - Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
    put:
      description: Modify a configured monitor.
      operationId: load-balancer-monitors-update-monitor
      parameters:
        - in: path
          name: monitor_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-editable'
                - required:
                    - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Update Monitor response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
          description: Update Monitor response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update Monitor
      tags:
        - Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
  /user/load_balancers/monitors/{monitor_id}/preview:
    post:
      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:
        - in: path
          name: monitor_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-editable'
                - required:
                    - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_preview_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Preview Monitor response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_preview_response'
          description: Preview Monitor response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Preview Monitor
      tags:
        - Load Balancer Monitors
  /user/load_balancers/monitors/{monitor_id}/references:
    get:
      description: Get the list of resources that reference the provided monitor.
      operationId: load-balancer-monitors-list-monitor-references
      parameters:
        - in: path
          name: monitor_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_references_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: List Monitor References response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_references_response'
          description: List Monitor References response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Monitor References
      tags:
        - Load Balancer Monitors
  /user/load_balancers/pools:
    get:
      description: List configured pools.
      operationId: load-balancer-pools-list-pools
      parameters:
        - in: query
          name: monitor
          schema:
            description: The ID of the Monitor to use for checking the health of origins within this pool.
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-response_collection'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: List Pools response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-response_collection'
          description: List Pools response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Pools
      tags:
        - Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
        - 'Load Balancing: Monitors and Pools Read'
    patch:
      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:
        content:
          application/json:
            schema:
              properties:
                notification_email:
                  $ref: '#/components/schemas/load-balancing_patch_pools_notification_email'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-response_collection'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Patch Pools response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-response_collection'
          description: Patch Pools response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Patch Pools
      tags:
        - Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
    post:
      description: Create a new pool.
      operationId: load-balancer-pools-create-pool
      requestBody:
        content:
          application/json:
            schema:
              properties:
                check_regions:
                  $ref: '#/components/schemas/load-balancing_check_regions'
                description:
                  $ref: '#/components/schemas/load-balancing_schemas-description'
                enabled:
                  $ref: '#/components/schemas/load-balancing_enabled'
                latitude:
                  $ref: '#/components/schemas/load-balancing_latitude'
                load_shedding:
                  $ref: '#/components/schemas/load-balancing_load_shedding'
                longitude:
                  $ref: '#/components/schemas/load-balancing_longitude'
                minimum_origins:
                  $ref: '#/components/schemas/load-balancing_minimum_origins'
                monitor:
                  $ref: '#/components/schemas/load-balancing_monitor_id'
                name:
                  $ref: '#/components/schemas/load-balancing_name'
                networks:
                  $ref: '#/components/schemas/load-balancing_networks'
                notification_email:
                  $ref: '#/components/schemas/load-balancing_notification_email'
                notification_filter:
                  $ref: '#/components/schemas/load-balancing_notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/load-balancing_origin_steering'
                origins:
                  $ref: '#/components/schemas/load-balancing_origins'
              required:
                - origins
                - name
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-single_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Create Pool response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-single_response'
          description: Create Pool response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create Pool
      tags:
        - Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
  /user/load_balancers/pools/{pool_id}:
    delete:
      description: Delete a configured pool.
      operationId: load-balancer-pools-delete-pool
      parameters:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-id_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Delete Pool response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-id_response'
          description: Delete Pool response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete Pool
      tags:
        - Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
    get:
      description: Fetch a single configured pool.
      operationId: load-balancer-pools-pool-details
      parameters:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-single_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Pool Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-single_response'
          description: Pool Details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Pool Details
      tags:
        - Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
        - 'Load Balancing: Monitors and Pools Read'
    patch:
      description: Apply changes to an existing pool, overwriting the supplied properties.
      operationId: load-balancer-pools-patch-pool
      parameters:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                check_regions:
                  $ref: '#/components/schemas/load-balancing_check_regions'
                description:
                  $ref: '#/components/schemas/load-balancing_schemas-description'
                disabled_at:
                  $ref: '#/components/schemas/load-balancing_schemas-disabled_at'
                enabled:
                  $ref: '#/components/schemas/load-balancing_enabled'
                latitude:
                  $ref: '#/components/schemas/load-balancing_latitude'
                load_shedding:
                  $ref: '#/components/schemas/load-balancing_load_shedding'
                longitude:
                  $ref: '#/components/schemas/load-balancing_longitude'
                minimum_origins:
                  $ref: '#/components/schemas/load-balancing_minimum_origins'
                monitor:
                  $ref: '#/components/schemas/load-balancing_monitor_id'
                name:
                  $ref: '#/components/schemas/load-balancing_name'
                notification_email:
                  $ref: '#/components/schemas/load-balancing_notification_email'
                notification_filter:
                  $ref: '#/components/schemas/load-balancing_notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/load-balancing_origin_steering'
                origins:
                  $ref: '#/components/schemas/load-balancing_origins'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-single_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Patch Pool response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-single_response'
          description: Patch Pool response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Patch Pool
      tags:
        - Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
    put:
      description: Modify a configured pool.
      operationId: load-balancer-pools-update-pool
      parameters:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                check_regions:
                  $ref: '#/components/schemas/load-balancing_check_regions'
                description:
                  $ref: '#/components/schemas/load-balancing_schemas-description'
                disabled_at:
                  $ref: '#/components/schemas/load-balancing_schemas-disabled_at'
                enabled:
                  $ref: '#/components/schemas/load-balancing_enabled'
                latitude:
                  $ref: '#/components/schemas/load-balancing_latitude'
                load_shedding:
                  $ref: '#/components/schemas/load-balancing_load_shedding'
                longitude:
                  $ref: '#/components/schemas/load-balancing_longitude'
                minimum_origins:
                  $ref: '#/components/schemas/load-balancing_minimum_origins'
                monitor:
                  $ref: '#/components/schemas/load-balancing_monitor_id'
                name:
                  $ref: '#/components/schemas/load-balancing_name'
                networks:
                  $ref: '#/components/schemas/load-balancing_networks'
                notification_email:
                  $ref: '#/components/schemas/load-balancing_notification_email'
                notification_filter:
                  $ref: '#/components/schemas/load-balancing_notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/load-balancing_origin_steering'
                origins:
                  $ref: '#/components/schemas/load-balancing_origins'
              required:
                - origins
                - name
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-single_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Update Pool response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-single_response'
          description: Update Pool response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update Pool
      tags:
        - Load Balancer Pools
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Write'
  /user/load_balancers/pools/{pool_id}/health:
    get:
      description: Fetch the latest pool health status for a single pool.
      operationId: load-balancer-pools-pool-health-details
      parameters:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_health_details'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Pool Health Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_health_details'
          description: Pool Health Details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Pool Health Details
      tags:
        - Load Balancer Pools
  /user/load_balancers/pools/{pool_id}/preview:
    post:
      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:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-editable'
                - required:
                    - expected_codes
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_preview_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Preview Pool response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_preview_response'
          description: Preview Pool response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Preview Pool
      tags:
        - Load Balancer Pools
  /user/load_balancers/pools/{pool_id}/references:
    get:
      description: Get the list of resources that reference the provided pool.
      operationId: load-balancer-pools-list-pool-references
      parameters:
        - in: path
          name: pool_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_schemas-references_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: List Pool References response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-references_response'
          description: List Pool References response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Pool References
      tags:
        - Load Balancer Pools
  /user/load_balancers/preview/{preview_id}:
    get:
      description: Get the result of a previous preview operation using the provided preview_id.
      operationId: load-balancer-monitors-preview-result
      parameters:
        - in: path
          name: preview_id
          required: true
          schema:
            $ref: '#/components/schemas/load-balancing_preview_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_preview_result_response'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: Preview Result response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_preview_result_response'
          description: Preview Result response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Preview Result
      tags:
        - Load Balancer Monitors
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Read'
  /user/load_balancing_analytics/events:
    get:
      description: List origin health changes.
      operationId: load-balancer-healthcheck-events-list-healthcheck-events
      parameters:
        - in: query
          name: until
          schema:
            $ref: '#/components/schemas/load-balancing_until'
        - in: query
          name: pool_name
          schema:
            $ref: '#/components/schemas/load-balancing_pool_name'
        - in: query
          name: origin_healthy
          schema:
            $ref: '#/components/schemas/load-balancing_origin_healthy'
        - in: query
          name: pool_id
          schema:
            $ref: '#/components/schemas/load-balancing_schemas-identifier'
        - in: query
          name: since
          schema:
            description: Start date and time of requesting data period in the ISO8601 format.
            example: "2016-11-11T12:00:00Z"
            format: date-time
            type: string
        - in: query
          name: origin_name
          schema:
            description: The name for the origin to filter.
            example: primary-dc-1
            type: string
        - in: query
          name: pool_healthy
          schema:
            default: true
            description: If true, filter events where the pool status is healthy. If false, filter events where the pool status is unhealthy.
            example: true
            type: boolean
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/load-balancing_components-schemas-response_collection'
                  - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
          description: List Healthcheck Events response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_components-schemas-response_collection'
          description: List Healthcheck Events response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform List Healthcheck Events
      tags:
        - Load Balancer Healthcheck Events
      x-api-token-group:
        - 'Load Balancing: Monitors and Pools Read'
  /user/organizations:
    get:
      description: Lists organizations the user is associated with.
      operationId: user'-s-organizations-list-organizations
      parameters:
        - in: query
          name: name
          schema:
            $ref: '#/components/schemas/iam_schemas-name'
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 20
            description: Number of organizations per page.
            maximum: 50
            minimum: 5
            type: number
        - in: query
          name: order
          schema:
            description: Field to order organizations by.
            enum:
              - id
              - name
              - status
            example: status
            type: string
        - in: query
          name: direction
          schema:
            description: Direction to order organizations.
            enum:
              - asc
              - desc
            example: desc
            type: string
        - in: query
          name: match
          schema:
            default: all
            description: Whether to match all search requirements or at least one (any).
            enum:
              - any
              - all
            type: string
        - in: query
          name: status
          schema:
            description: Whether the user is a member of the organization or has an inivitation pending.
            enum:
              - member
              - invited
            example: member
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Organizations response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_collection_organization_response'
          description: List Organizations response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Organizations
      tags:
        - User's Organizations
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /user/organizations/{organization_id}:
    delete:
      description: Removes association to an organization.
      operationId: user'-s-organizations-leave-organization
      parameters:
        - in: path
          name: organization_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_common_components-schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Leave Organization response failure
        "200":
          content:
            application/json:
              schema:
                properties:
                  id:
                    $ref: '#/components/schemas/iam_common_components-schemas-identifier'
                type: object
          description: Leave Organization response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Leave Organization
      tags:
        - User's Organizations
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Gets a specific organization the user is associated with.
      operationId: user'-s-organizations-organization-details
      parameters:
        - in: path
          name: organization_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_common_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Organization Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_organization_response'
          description: Organization Details response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Organization Details
      tags:
        - User's Organizations
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /user/subscriptions:
    get:
      description: Lists all of a user's subscriptions.
      operationId: user-subscription-get-user-subscriptions
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/bill-subs-api_user_subscription_response_collection'
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Get User Subscriptions response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_user_subscription_response_collection'
          description: Get User Subscriptions response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Get User Subscriptions
      tags:
        - User Subscription
      x-api-token-group:
        - Billing Write
        - Billing Read
      x-cfPermissionsRequired:
        enum:
          - '#billing:read'
  /user/subscriptions/{identifier}:
    delete:
      description: Deletes a user's subscription.
      operationId: user-subscription-delete-user-subscription
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - properties:
                      subscription_id:
                        $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
                    type: object
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Delete User Subscription response failure
        "200":
          content:
            application/json:
              schema:
                properties:
                  subscription_id:
                    $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
                type: object
          description: Delete User Subscription response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Delete User Subscription
      tags:
        - User Subscription
      x-api-token-group:
        - Billing Write
      x-cfPermissionsRequired:
        enum:
          - '#billing:edit'
    put:
      description: Updates a user's subscriptions.
      operationId: user-subscription-update-user-subscription
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bill-subs-api_subscription-v2'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/bill-subs-api_user_subscription_response_single'
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Update User Subscription response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_user_subscription_response_single'
          description: Update User Subscription response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update User Subscription
      tags:
        - User Subscription
      x-api-token-group:
        - Billing Write
      x-cfPermissionsRequired:
        enum:
          - '#billing:read'
          - '#billing:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/tokens:
    get:
      description: List all access tokens you created.
      operationId: user-api-tokens-list-tokens
      parameters:
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 20
            description: Maximum number of results per page.
            maximum: 50
            minimum: 5
            type: number
        - in: query
          name: direction
          schema:
            description: Direction to order results.
            enum:
              - asc
              - desc
            example: desc
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Tokens response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_collection_tokens_response'
          description: List Tokens response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform List Tokens
      tags:
        - User API Tokens
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.token.list
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Create a new access token.
      operationId: user-api-tokens-create-token
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/iam_create_payload'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Create Token response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_token_create_response'
          description: Create Token response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Create Token
      tags:
        - User API Tokens
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.token.create
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/tokens/{token_id}:
    delete:
      description: Destroy a token.
      operationId: user-api-tokens-delete-token
      parameters:
        - in: path
          name: token_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_token_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Delete Token response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-single-id'
          description: Delete Token response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Delete Token
      tags:
        - User API Tokens
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.token.delete
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Get information about a specific token.
      operationId: user-api-tokens-token-details
      parameters:
        - in: path
          name: token_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_token_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Token Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_token_response'
          description: Token Details response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Token Details
      tags:
        - User API Tokens
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.token.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Update an existing token.
      operationId: user-api-tokens-update-token
      parameters:
        - in: path
          name: token_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_token_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/iam_token_body'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Update Token response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_token_response'
          description: Update Token response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Update Token
      tags:
        - User API Tokens
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.token.update
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/tokens/{token_id}/value:
    put:
      description: Roll the token secret.
      operationId: user-api-tokens-roll-token
      parameters:
        - in: path
          name: token_id
          required: true
          schema:
            $ref: '#/components/schemas/iam_token_identifier'
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Roll Token response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_response_single_value'
          description: Roll Token response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Roll Token
      tags:
        - User API Tokens
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.token.update
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/tokens/permission_groups:
    get:
      description: Find all available permission groups for API Tokens
      operationId: permission-groups-list-permission-groups
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Token Permission Groups response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_schemas-response_collection'
          description: List Token Permission Groups response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform List Token Permission Groups
      tags:
        - API Token Permission Groups
      x-cfPermissionsRequired:
        enum:
          - com.cloudflare.api.token.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/tokens/verify:
    get:
      description: Test whether a token works.
      operationId: user-api-tokens-verify-token
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Verify Token response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_response_single_segment'
          description: Verify Token response
      security:
        - api_token: []
      summary: APIs.io Engineering Platform Verify Token
      tags:
        - User API Tokens
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /zones:
    get:
      description: |
        Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts
        is currently not allowed.
      operationId: zones-get
      parameters:
        - examples:
            Basic Query:
              summary: Simple Query
              value: example.com
            Contains Query:
              summary: Contains Query
              value: contains:.org
            Ends With Query:
              summary: Ends With Query
              value: ends_with:arpa
            Starts With Query:
              summary: Starts With Query
              value: starts_with:dev
          in: query
          name: name
          schema:
            description: |
              A domain name. Optional filter operators can be provided to extend refine the search:
                * `equal` (default)
                * `not_equal`
                * `starts_with`
                * `ends_with`
                * `contains`
                * `starts_with_case_sensitive`
                * `ends_with_case_sensitive`
                * `contains_case_sensitive`
            maxLength: 253
            type: string
        - in: query
          name: status
          schema:
            description: A zone status
            enum:
              - initializing
              - pending
              - active
              - moved
            type: string
        - in: query
          name: account.id
          schema:
            description: An account ID
            type: string
        - examples:
            Basic Query:
              summary: Simple Query
              value: Dev Account
            Contains Query:
              summary: Contains Query
              value: contains:Test
          in: query
          name: account.name
          schema:
            description: |
              An account Name. Optional filter operators can be provided to extend refine the search:
                * `equal` (default)
                * `not_equal`
                * `starts_with`
                * `ends_with`
                * `contains`
                * `starts_with_case_sensitive`
                * `ends_with_case_sensitive`
                * `contains_case_sensitive`
            maxLength: 253
            type: string
        - in: query
          name: page
          schema:
            default: 1
            description: Page number of paginated results.
            minimum: 1
            type: number
        - in: query
          name: per_page
          schema:
            default: 20
            description: Number of zones per page.
            maximum: 50
            minimum: 5
            type: number
        - in: query
          name: order
          schema:
            description: Field to order zones by.
            enum:
              - name
              - status
              - account.id
              - account.name
            example: status
            type: string
        - in: query
          name: direction
          schema:
            description: Direction to order zones.
            enum:
              - asc
              - desc
            example: desc
            type: string
        - in: query
          name: match
          schema:
            default: all
            description: Whether to match all search requirements or at least one (any).
            enum:
              - any
              - all
            type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
          description: List Zones response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zones_api-response-common'
                  - properties:
                      result_info:
                        $ref: '#/components/schemas/zones_result_info'
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/zones_zone'
                        type: array
          description: List Zones response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Zones
      tags:
        - Zone
    post:
      operationId: zones-post
      requestBody:
        content:
          application/json:
            schema:
              properties:
                account:
                  properties:
                    id:
                      $ref: '#/components/schemas/zones_identifier'
                  type: object
                name:
                  $ref: '#/components/schemas/zones_name'
                type:
                  $ref: '#/components/schemas/zones_type'
              required:
                - name
                - account
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
          description: Create Zone response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zones_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/zones_zone'
                    type: object
          description: Create Zone response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create Zone
      tags:
        - Zone
  /zones/{identifier}/subscription:
    get:
      description: Lists zone subscription details.
      operationId: zone-subscription-zone-subscription-details
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single'
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Zone Subscription Details response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single'
          description: Zone Subscription Details response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Zone Subscription Details
      tags:
        - Zone Subscription
      x-api-token-group:
        - Billing Write
        - Billing Read
      x-cfPermissionsRequired:
        enum:
          - '#billing:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Create a zone subscription, either plan or add-ons.
      operationId: zone-subscription-create-zone-subscription
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bill-subs-api_subscription-v2'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single'
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Create Zone Subscription response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single'
          description: Create Zone Subscription response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Create Zone Subscription
      tags:
        - Zone Subscription
      x-api-token-group:
        - Billing Write
      x-cfPermissionsRequired:
        enum:
          - '#billing:read'
          - '#billing:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Updates zone subscriptions, either plan or add-ons.
      operationId: zone-subscription-update-zone-subscription
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bill-subs-api_subscription-v2'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single'
                  - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Update Zone Subscription response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single'
          description: Update Zone Subscription response
      security:
        - api_email: []
          api_key: []
          api_token: []
      summary: APIs.io Engineering Platform Update Zone Subscription
      tags:
        - Zone Subscription
      x-api-token-group:
        - Billing Write
      x-cfPermissionsRequired:
        enum:
          - '#billing:read'
          - '#billing:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /zones/{zone_id}:
    delete:
      description: Deletes an existing zone.
      operationId: zones-0-delete
      parameters:
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/zones_identifier'
      requestBody:
        content:
          application/json: {}
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
          description: Delete Zone response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-single-id'
          description: Delete Zone response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete Zone
      tags:
        - Zone
      x-cfPermissionsRequired:
        enum:
          - '#zone:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      operationId: zones-0-get
      parameters:
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/zones_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
          description: Zone Details response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zones_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/zones_zone'
                    type: object
          description: Zone Details response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Zone Details
      tags:
        - Zone
      x-cfPermissionsRequired:
        enum:
          - '#zone:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    patch:
      description: Edits a zone. Only one zone property can be changed at a time.
      operationId: zones-0-patch
      parameters:
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/zones_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                paused: true
              properties:
                paused:
                  $ref: '#/components/schemas/zones_paused'
                plan:
                  description: |
                    (Deprecated) Please use the `/zones/{zone_id}/subscription` API
                    to update a zone's plan. Changing this value will create/cancel
                    associated subscriptions. To view available plans for this zone,
                    see Zone Plans.
                  properties:
                    id:
                      $ref: '#/components/schemas/zones_identifier'
                  type: object
                type:
                  description: |
                    A full zone implies that DNS is hosted with Cloudflare. A partial
                    zone is typically a partner-hosted zone or a CNAME setup. This
                    parameter is only available to Enterprise customers or if it has
                    been explicitly enabled on a zone.
                  enum:
                    - full
                    - partial
                    - secondary
                  example: full
                  type: string
                vanity_name_servers:
                  $ref: '#/components/schemas/zones_vanity_name_servers'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
          description: Edit Zone response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/zones_api-response-common'
                  - properties:
                      result:
                        $ref: '#/components/schemas/zones_zone'
                    type: object
          description: Edit Zone response
      security:
        - api_token: []
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Edit Zone
      tags:
        - Zone
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /zones/{zone_id}/access/apps:
    get:
      description: List all Access Applications in a zone.
      operationId: zone-level-access-applications-list-access-applications
      parameters:
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List Access Applications response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_apps_components-schemas-response_collection-2'
          description: List Access Applications response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Access Applications
      tags:
        - Zone-Level Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Revoke'
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    post:
      description: Adds a new application to Access.
      operationId: zone-level-access-applications-add-a-bookmark-application
      parameters:
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_apps'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Add an Access application response failure
        "201":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/access_apps_components-schemas-single_response-2'
                  - properties:
                      result:
                        $ref: '#/components/schemas/access_apps'
          description: Add an Access application response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Add an Access application
      tags:
        - Zone-Level Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /zones/{zone_id}/access/apps/{app_id}:
    delete:
      description: Deletes an application from Access.
      operationId: zone-level-access-applications-delete-an-access-application
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_app_id'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete an Access application response failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
          description: Delete an Access application response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an Access application
      tags:
        - Zone-Level Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Write'
    get:
      description: Fetches information about an Access application.
      operationId: zone-level-access-applications-get-an-access-application
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_app_id'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get an Access application response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_apps_components-schemas-single_response-2'
          description: Get an Access application response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an Access application
      tags:
        - Zone-Level Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    put:
      description: Updates an Access application.
      operationId: zone-level-access-applications-update-a-bookmark-application
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_app_id'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_apps'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update an Access application response failure
        "200":
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/access_apps_components-schemas-single_response-2'
                  - properties:
                      result:
                        $ref: '#/components/schemas/access_apps'
          description: Update an Access application response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an Access application
      tags:
        - Zone-Level Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /zones/{zone_id}/access/apps/{app_id}/ca:
    delete:
      description: Deletes a short-lived certificate CA.
      operationId: zone-level-access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete a short-lived certificate CA response failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_schemas-id_response'
          description: Delete a short-lived certificate CA response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete a short-lived certificate CA
      tags:
        - Zone-Level Access Short-Lived Certificate CAs
      x-api-token-group:
        - 'Access: Apps and Policies Write'
    get:
      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:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get a short-lived certificate CA response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_ca_components-schemas-single_response'
          description: Get a short-lived certificate CA response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get a short-lived certificate CA
      tags:
        - Zone-Level Access Short-Lived Certificate CAs
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    post:
      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:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create a short-lived certificate CA response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_ca_components-schemas-single_response'
          description: Create a short-lived certificate CA response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create a short-lived certificate CA
      tags:
        - Zone-Level Access Short-Lived Certificate CAs
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /zones/{zone_id}/access/apps/{app_id}/policies:
    get:
      description: Lists Access policies configured for an application.
      operationId: zone-level-access-policies-list-access-policies
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List Access policies response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_policies_components-schemas-response_collection'
          description: List Access policies response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List Access policies
      tags:
        - Zone-Level Access Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    post:
      description: Create a new Access policy for an application.
      operationId: zone-level-access-policies-create-an-access-policy
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                approval_groups:
                  $ref: '#/components/schemas/access_schemas-approval_groups'
                approval_required:
                  $ref: '#/components/schemas/access_approval_required'
                decision:
                  $ref: '#/components/schemas/access_decision'
                exclude:
                  $ref: '#/components/schemas/access_schemas-exclude'
                include:
                  $ref: '#/components/schemas/access_include'
                isolation_required:
                  $ref: '#/components/schemas/access_schemas-isolation_required'
                name:
                  $ref: '#/components/schemas/access_policies_components-schemas-name'
                precedence:
                  $ref: '#/components/schemas/access_schemas-precedence'
                purpose_justification_prompt:
                  $ref: '#/components/schemas/access_purpose_justification_prompt'
                purpose_justification_required:
                  $ref: '#/components/schemas/access_purpose_justification_required'
                require:
                  $ref: '#/components/schemas/access_schemas-require'
              required:
                - name
                - decision
                - include
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create an Access policy response failure
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_policies_components-schemas-single_response'
          description: Create an Access policy response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Create an Access policy
      tags:
        - Zone-Level Access Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /zones/{zone_id}/access/apps/{app_id}/policies/{policy_id}:
    delete:
      description: Delete an Access policy.
      operationId: zone-level-access-policies-delete-an-access-policy
      parameters:
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete an Access policy response failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
          description: Delete an Access policy response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Delete an Access policy
      tags:
        - Zone-Level Access Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
    get:
      description: Fetches a single Access policy.
      operationId: zone-level-access-policies-get-an-access-policy
      parameters:
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get an Access policy response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_policies_components-schemas-single_response'
          description: Get an Access policy response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Get an Access policy
      tags:
        - Zone-Level Access Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
    put:
      description: Update a configured Access policy.
      operationId: zone-level-access-policies-update-an-access-policy
      parameters:
        - in: path
          name: policy_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_uuid'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                approval_groups:
                  $ref: '#/components/schemas/access_schemas-approval_groups'
                approval_required:
                  $ref: '#/components/schemas/access_approval_required'
                decision:
                  $ref: '#/components/schemas/access_decision'
                exclude:
                  $ref: '#/components/schemas/access_schemas-exclude'
                include:
                  $ref: '#/components/schemas/access_include'
                isolation_required:
                  $ref: '#/components/schemas/access_schemas-isolation_required'
                name:
                  $ref: '#/components/schemas/access_policies_components-schemas-name'
                precedence:
                  $ref: '#/components/schemas/access_schemas-precedence'
                purpose_justification_prompt:
                  $ref: '#/components/schemas/access_purpose_justification_prompt'
                purpose_justification_required:
                  $ref: '#/components/schemas/access_purpose_justification_required'
                require:
                  $ref: '#/components/schemas/access_schemas-require'
              required:
                - name
                - decision
                - include
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update an Access policy response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_policies_components-schemas-single_response'
          description: Update an Access policy response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Update an Access policy
      tags:
        - Zone-Level Access Policies
      x-api-token-group:
        - 'Access: Apps and Policies Write'
  /zones/{zone_id}/access/apps/{app_id}/revoke_tokens:
    post:
      description: Revokes all tokens issued for an application.
      operationId: zone-level-access-applications-revoke-service-tokens
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_app_id'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Revoke application tokens response failure
        "202":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_schemas-empty_response'
          description: Revoke application tokens response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Revoke application tokens
      tags:
        - Zone-Level Access Applications
      x-api-token-group:
        - 'Access: Apps and Policies Revoke'
        - 'Access: Apps and Policies Write'
  /zones/{zone_id}/access/apps/{app_id}/user_policy_checks:
    get:
      description: Tests if a specific user has permission to access an application.
      operationId: zone-level-access-applications-test-access-policies
      parameters:
        - in: path
          name: app_id
          required: true
          schema:
            $ref: '#/components/schemas/access_app_id'
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Test Access policies response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_schemas-policy_check_response'
          description: Test Access policies response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform Test Access policies
      tags:
        - Zone-Level Access Applications
  /zones/{zone_id}/access/apps/ca:
    get:
      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:
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List short-lived certificate CAs response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_ca_components-schemas-response_collection'
          description: List short-lived certificate CAs response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List short-lived certificate CAs
      tags:
        - Zone-Level Access Short-Lived Certificate CAs
      x-api-token-group:
        - 'Access: Apps and Policies Write'
        - 'Access: Apps and Policies Read'
  /zones/{zone_id}/access/certificates:
    get:
      description: Lists all mTLS certificates.
      operationId: zone-level-access-mtls-authentication-list-mtls-certificates
      parameters:
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List mTLS certificates response failure
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-response_collection-2'
          description: List mTLS certificates response
      security:
        - api_email: []
          api_key: []
      summary: APIs.io Engineering Platform List mTLS certificates
      tags:
        - Zone-Level Access mTLS Authentication
      x-api-token-group:
        - 'Access: Certificates Write'
        - 'Access: Certificates Read'
    post:
      description: Adds a new mTLS root certificate to Access.
      operationId: zone-level-access-mtls-authentication-add-an-mtls-certificate
      parameters:
        - in: path
          name: zone_id
          required: true
          schema:
            $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                associated_hostnames:
                  $ref: '#/components/schemas/access_associated_hostnames'
                certificate:
                  description: The certificate content.
                  example:
      tags:
        - Zones
tags:
  - name: Access Application-Scoped Policies
  - name: Access Applications
  - name: Access Authentication Logs
  - name: Access Bookmark Applications (Deprecated)
  - name: Access Custom Pages
  - name: Access Groups
  - name: Access Identity Providers
  - name: Access Key Configuration
  - name: Access mTLS Authentication
  - name: Access Policy Tester
  - name: Access Reusable Policies
  - name: Access Service Tokens
  - name: Access Short-Lived Certificate CAs
  - name: Access Tags
  - name: Account Billing Profile
  - name: Account Load Balancer Monitors
  - name: Account Load Balancer Pools
  - name: Account Load Balancer Search
  - name: Account Members
  - name: Account Permission Groups
  - name: Account Request Tracer
  - name: Account Resource Groups
  - name: Account Roles
  - name: Account Rulesets
  - name: Account Subscriptions
  - name: Account-Level Custom Nameservers
  - name: Accounts
  - name: AI Gateway
  - name: API Token Permission Groups
  - name: ASN Intelligence
  - name: Audit Logs
  - name: Botnet Threat Feed
  - name: Calls Apps
  - name: Calls TURN Keys
  - name: Cloudflare Images
  - name: Cloudflare Images Keys
  - name: Cloudflare Images Variants
  - name: Cloudflare IPs
  - name: Cloudflare Tunnel
  - name: Cloudflare Tunnel Configuration
  - name: Custom Indicator Feeds
  - name: Custom Pages for an Account
  - name: D1
  - name: Device DEX Tests
  - name: Device Managed Networks
  - name: Device Posture Integrations
  - name: Device Posture Rules
  - name: Devices
  - name: DEX Synthetic Application Monitoring
  - name: Diagnostics
  - name: DLP Datasets
  - name: DLP Profiles
  - name: DLP Settings
  - name: DLS Regional Services
  - name: DNS Firewall
  - name: DNS Firewall Analytics
  - name: DNS Settings for an Account
  - name: Domain History
  - name: Domain Intelligence
  - name: Durable Objects Namespace
  - name: Email Routing Destination Addresses
  - name: Email Security
  - name: Email Security Settings
  - name: Hyperdrive
  - name: Infrastructure Access Targets
  - name: IP Access Rules for a User
  - name: IP Access Rules for an Account
  - name: IP Address Management Address Maps
  - name: IP Address Management BGP Prefixes
  - name: IP Address Management Dynamic Advertisement
  - name: IP Address Management Prefix Delegation
  - name: IP Address Management Prefixes
  - name: IP Address Management Service Bindings
  - name: IP Intelligence
  - name: IP List
  - name: Lists
  - name: Load Balancer Healthcheck Events
  - name: Load Balancer Monitors
  - name: Load Balancer Pools
  - name: Load Balancer Regions
  - name: Logcontrol CMB Config for an Account
  - name: Logpush Jobs for an Account
  - name: Magic Account Apps
  - name: Magic Connectors
  - name: Magic GRE Tunnels
  - name: Magic Interconnects
  - name: Magic IPsec Tunnels
  - name: Magic Network Monitoring Configuration
  - name: Magic Network Monitoring Rules
  - name: Magic PCAP Collection
  - name: Magic Site ACLs
  - name: Magic Site App Configs
  - name: Magic Site LANs
  - name: Magic Site WANs
  - name: Magic Sites
  - name: Magic Static Routes
  - name: Miscategorization
  - name: mTLS Certificate Management
  - name: Notification Alert Types
  - name: Notification Destinations with PagerDuty
  - name: Notification History
  - name: Notification Mechanism Eligibility
  - name: Notification Policies
  - name: Notification Webhooks
  - name: Origin CA
  - name: Pages Build Cache
  - name: Pages Deployment
  - name: Pages Domains
  - name: Pages Project
  - name: Passive DNS by IP
  - name: Phishing URL Information
  - name: Phishing URL Scanner
  - name: Priority Intelligence Requirements (PIR)
  - name: Queue
  - name: R2 Bucket
  - name: R2 Event Notification
  - name: Radar AI Gateway
  - name: Radar AI Inference
  - name: Radar Annotations
  - name: Radar AS112
  - name: Radar Attacks
  - name: Radar BGP
  - name: Radar Datasets
  - name: Radar DNS
  - name: Radar Email Routing
  - name: Radar Email Security
  - name: Radar Entities
  - name: Radar Http
  - name: Radar Netflows
  - name: Radar Quality
  - name: Radar Ranking
  - name: Radar Robots.txt
  - name: Radar Search
  - name: Radar TCP Resets Timeouts
  - name: Radar Traffic Anomalies
  - name: Radar Verified Bots
  - name: Registrar Domains
  - name: Request for Information (RFI)
  - name: Secondary DNS (ACL)
  - name: Secondary DNS (Peer)
  - name: Secondary DNS (TSIG)
  - name: Security Center Insights
  - name: Sinkhole Config
  - name: Stream Audio Tracks
  - name: Stream Live Inputs
  - name: Stream MP4 Downloads
  - name: Stream Signing Keys
  - name: Stream Subtitles/Captions
  - name: Stream Video Clipping
  - name: Stream Videos
  - name: Stream Watermark Profile
  - name: Stream Webhook
  - name: Tunnel Routing
  - name: Tunnel Virtual Network
  - name: Turnstile
  - name: URL Scanner
  - name: User
  - name: User API Tokens
  - name: User Billing History
  - name: User Billing Profile
  - name: User Subscription
  - name: User's Account Memberships
  - name: User's Invites
  - name: User's Organizations
  - name: Vectorize
  - name: Vectorize Beta (Deprecated)
  - name: Web Analytics
  - name: WHOIS Record
  - name: Worker Account Settings
  - name: Worker Cron Trigger
  - name: Worker Deployments
  - name: Worker Deployments (Deprecated)
  - name: Worker Domain
  - name: Worker Environment
  - name: Worker Script
  - name: Worker Subdomain
  - name: Worker Tail Logs
  - name: Worker Versions
  - name: Workers AI
  - name: Workers AI Automatic Speech Recognition
  - name: Workers AI Finetune
  - name: Workers AI Image Classification
  - name: Workers AI Object Detection
  - name: Workers AI Summarization
  - name: Workers AI Text Classification
  - name: Workers AI Text Embeddings
  - name: Workers AI Text Generation
  - name: Workers AI Text to Image
  - name: Workers AI Translation
  - name: Workers for Platforms
  - name: Workers KV Namespace
  - name: Workers KV Request Analytics
  - name: Workers KV Stored Data Analytics
  - name: Zero Trust Accounts
  - name: Zero Trust Audit SSH Settings
  - name: Zero Trust Certificates
  - name: Zero Trust Connectivity Settings
  - name: Zero Trust Gateway Application and Application Type Mappings
  - name: Zero Trust Gateway Categories
  - name: Zero Trust Gateway Locations
  - name: Zero Trust Gateway Proxy Endpoints
  - name: Zero Trust Gateway Rules
  - name: Zero Trust Lists
  - name: Zero Trust Organization
  - name: Zero Trust Risk Scoring
  - name: Zero Trust Risk Scoring Integrations
  - name: Zero Trust Seats
  - name: Zero Trust Users
  - name: Zone
  - name: Zone Subscription
  - name: Zone-Level Access Applications
  - name: Zone-Level Access mTLS Authentication
  - name: Zone-Level Access Policies
  - name: Zone-Level Access Short-Lived Certificate CAs
  - name: Zones