Cloudflare API

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:
         

# --- truncated at 32 KB (5384 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/engineering-platform/refs/heads/main/openapi/_original/cloudflare-openapi-original.yml