openapi: 3.0.3 components: schemas: aaa_account-id: type: string description: The account id example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 aaa_alert-types: type: object 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' aaa_alert_body: type: string description: Message body included in the notification sent. example: SSL certificate has expired aaa_alert_type: type: string description: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. 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 - custom_ssl_certificate_event_type - dedicated_ssl_certificate_event_type - 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 - load_balancing_health_alert - load_balancing_pool_enablement_alert - logo_match_alert - magic_tunnel_health_check_event - 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_zone_successfully_updated - secondary_dns_zone_validation_warning - sentinel_alert - stream_live_notifications - 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 aaa_api-response-collection: allOf: - $ref: '#/components/schemas/aaa_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/aaa_result_info' type: object aaa_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/aaa_messages' messages: $ref: '#/components/schemas/aaa_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true aaa_api-response-common-failure: type: object required: - success - errors - messages - result 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: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false aaa_api-response-single: allOf: - $ref: '#/components/schemas/aaa_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object aaa_audit-logs: type: object properties: action: type: object properties: result: type: boolean description: A boolean that indicates if the action attempted was successful. example: true type: type: string description: A short string that describes the action that was performed. example: change_setting actor: type: object properties: email: type: string format: email description: The email of the user that performed the action. example: michelle@example.com id: type: string description: The ID of the actor that performed the action. If a user performed the action, this will be their User ID. example: f6b5de0326bb5182b8a4840ee01ec774 ip: type: string description: The IP address of the request that performed the action. example: 198.41.129.166 type: type: string description: The type of actor, whether a User, Cloudflare Admin, or an Automated System. enum: - user - admin - Cloudflare example: user id: type: string description: A string that uniquely identifies the audit log. example: d5b0f326-1232-4452-8858-1089bd7168ef interface: type: string description: The source of the event. example: API metadata: type: object description: An object which can lend more context to the action being logged. This is a flexible value and varies between different actions. example: name: security_level type: firewall value: high zone_name: example.com newValue: type: string description: The new value of the resource that was modified. example: low oldValue: type: string description: The value of the resource before it was modified. example: high owner: type: object properties: id: $ref: '#/components/schemas/aaa_identifier' resource: type: object properties: id: type: string description: An identifier for the resource that was affected by the action. example: 023e105f4ecef8ad9ca31a8372d0c353 type: type: string description: A short string that describes the resource that was affected by the action. example: zone when: type: string format: date-time description: A UTC RFC3339 timestamp that specifies when the action being logged occured. example: "2017-04-26T17:31:07Z" aaa_audit_logs_response_collection: oneOf: - properties: errors: type: object nullable: true messages: type: array example: [] items: {} result: type: array items: $ref: '#/components/schemas/aaa_audit-logs' success: type: boolean example: true - $ref: '#/components/schemas/aaa_api-response-common' aaa_before: type: string format: date-time 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" aaa_components-schemas-description: type: string description: Description of the notification policy (if present). example: Universal Certificate validation status, issuance, renewal, and expiration notices aaa_components-schemas-name: type: string description: The name of the webhook destination. This will be included in the request body when you receive a webhook notification. example: Slack Webhook aaa_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/aaa_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/aaa_pagerduty' aaa_components-schemas-type: type: string description: Type of webhook endpoint. enum: - slack - generic - gchat example: slack aaa_created_at: type: string format: date-time description: Timestamp of when the webhook destination was created. example: "2020-10-26T18:25:04.532316Z" readOnly: true aaa_description: type: string description: Describes the alert type. example: High levels of 5xx HTTP errors at your origin aaa_display_name: type: string description: Alert type name. example: Origin Error Rate Alert aaa_eligibility: type: object properties: eligible: $ref: '#/components/schemas/aaa_eligible' ready: $ref: '#/components/schemas/aaa_ready' type: $ref: '#/components/schemas/aaa_schemas-type' aaa_eligible: type: boolean description: Determines whether or not the account is eligible for the delivery mechanism. example: true aaa_enabled: type: boolean description: Whether or not the Notification policy is enabled. default: true example: true aaa_filter_options: type: array description: 'Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings.' example: - AvailableValues: null 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: {} aaa_filters: type: object 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: type: array description: Usage depends on specific alert type items: type: string affected_asns: type: array description: Used for configuring radar_notification items: type: string affected_components: type: array description: Used for configuring incident_alert. A list of identifiers for each component to monitor. example: 4c231tkdlpcl items: type: string affected_locations: type: array description: Used for configuring radar_notification items: type: string airport_code: type: array description: Used for configuring maintenance_event_notification items: type: string alert_trigger_preferences: type: array description: Usage depends on specific alert type items: type: string alert_trigger_preferences_value: type: array description: Used for configuring magic_tunnel_health_check_event items: type: string enum: - "99.0" - "98.0" - "97.0" minItems: 1 maxItems: 1 enabled: type: array description: Used for configuring load_balancing_pool_enablement_alert items: type: string minItems: 1 environment: type: array description: Used for configuring pages_event_alert items: type: string minItems: 1 event: type: array description: Used for configuring pages_event_alert items: type: string minItems: 1 event_source: type: array description: Used for configuring load_balancing_health_alert items: type: string event_type: type: array description: Usage depends on specific alert type items: type: string group_by: type: array description: Usage depends on specific alert type items: type: string health_check_id: type: array description: Used for configuring health_check_status_notification items: type: string incident_impact: type: array description: Used for configuring incident_alert items: type: string enum: - INCIDENT_IMPACT_NONE - INCIDENT_IMPACT_MINOR - INCIDENT_IMPACT_MAJOR - INCIDENT_IMPACT_CRITICAL input_id: type: array description: Used for configuring stream_live_notifications items: type: string limit: type: array description: Used for configuring billing_usage_alert items: type: string minItems: 1 logo_tag: type: array description: Used for configuring logo_match_alert items: type: string megabits_per_second: type: array description: Used for configuring advanced_ddos_attack_l4_alert items: type: string new_health: type: array description: Used for configuring load_balancing_health_alert items: type: string new_status: type: array description: Used for configuring tunnel_health_event items: type: string packets_per_second: type: array description: Used for configuring advanced_ddos_attack_l4_alert items: type: string pool_id: type: array description: Usage depends on specific alert type items: type: string product: type: array description: Used for configuring billing_usage_alert items: type: string minItems: 1 project_id: type: array description: Used for configuring pages_event_alert items: type: string minItems: 1 protocol: type: array description: Used for configuring advanced_ddos_attack_l4_alert items: type: string query_tag: type: array description: Usage depends on specific alert type items: type: string requests_per_second: type: array description: Used for configuring advanced_ddos_attack_l7_alert items: type: string selectors: type: array description: Usage depends on specific alert type items: type: string services: type: array description: Used for configuring clickhouse_alert_fw_ent_anomaly items: type: string minItems: 1 slo: type: array description: Usage depends on specific alert type items: type: string status: type: array description: Used for configuring health_check_status_notification items: type: string minItems: 1 target_hostname: type: array description: Used for configuring advanced_ddos_attack_l7_alert items: type: string target_ip: type: array description: Used for configuring advanced_ddos_attack_l4_alert items: type: string target_zone_name: type: array description: Used for configuring advanced_ddos_attack_l7_alert items: type: string traffic_exclusions: type: array description: Used for configuring traffic_anomalies_alert items: type: string enum: - security_events maxItems: 1 tunnel_id: type: array description: Used for configuring tunnel_health_event items: type: string tunnel_name: type: array description: Used for configuring magic_tunnel_health_check_event items: type: string minItems: 1 where: type: array description: Usage depends on specific alert type items: type: string zones: type: array description: Usage depends on specific alert type items: type: string aaa_history: type: object 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' aaa_history_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/aaa_api-response-collection' - properties: result: type: array example: - alert_body: data: custom_csr_id: "" expires_on: null hosts: [] id: "11111111111" issuer: "" method: txt serial_number: "" settings: null signature: "" status: "" type: "" uploaded_on: null validation_errors: [] validation_records: - cname: "" cname_target: "" emails: [] http_body: "" http_url: "" txt_name: _acme-challenge.example.com txt_value: "11111111111" metadata: account: null event: created_at: null 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' result_info: type: object example: count: 1 page: 1 per_page: 20 aaa_id_response: allOf: - $ref: '#/components/schemas/aaa_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/aaa_uuid' aaa_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 aaa_integration-token: type: string description: The token integration key example: 8c71e667571b4f61b94d9e4b12158038 readOnly: true maxLength: 32 aaa_last_failure: type: string format: date-time description: Timestamp of the last time an attempt to dispatch a notification to this webhook failed. example: "2020-10-26T18:25:04.532316Z" readOnly: true aaa_last_success: type: string format: date-time description: Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook. example: "2020-10-26T18:25:04.532316Z" readOnly: true aaa_mechanism: type: string description: The mechanism to which the notification has been dispatched. example: test@example.com aaa_mechanism_type: type: string description: The type of mechanism to which the notification has been dispatched. This can be email/pagerduty/webhook based on the mechanism configured. enum: - email - pagerduty - webhook example: email aaa_mechanisms: type: object description: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address. example: email: - id: test@example.com pagerduty: - id: e8133a15-00a4-4d69-aec1-32f70c51f6e5 webhooks: - id: 14cc1190-5d2b-4b98-a696-c424cb2ad05f aaa_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string aaa_name: type: string description: The name of the pagerduty service. example: My PagerDuty Service aaa_pagerduty: type: object properties: id: $ref: '#/components/schemas/aaa_uuid' name: $ref: '#/components/schemas/aaa_name' aaa_per_page: type: number description: Number of items per page. default: 25 minimum: 5 maximum: 1000 aaa_policies: type: object properties: 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' aaa_policies_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/aaa_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/aaa_policies' aaa_policy-id: type: string description: The unique identifier of a notification policy example: 0da2b59e-f118-439d-8097-bdfb215203c9 readOnly: true maxLength: 36 aaa_ready: type: boolean description: Beta flag. Users can create a policy with a mechanism that is not ready, but we cannot guarantee successful delivery of notifications. example: true aaa_response_collection: allOf: - $ref: '#/components/schemas/aaa_api-response-collection' - properties: result: type: object example: Origin Monitoring: - description: High levels of 5xx HTTP errors at your origin. display_name: Origin Error Rate Alert filter_options: - AvailableValues: null 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 aaa_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 aaa_schemas-alert_type: type: string description: Type of notification that has been dispatched. example: universal_ssl_event_type aaa_schemas-description: type: string description: Optional description for the Notification policy. example: Something describing the policy. aaa_schemas-name: type: string description: Name of the policy. example: SSL Notification Event Policy aaa_schemas-response_collection: allOf: - $ref: '#/components/schemas/aaa_api-response-collection' - properties: result: type: object example: email: eligible: true ready: true type: email aaa_schemas-single_response: allOf: - $ref: '#/components/schemas/aaa_api-response-single' - properties: result: $ref: '#/components/schemas/aaa_webhooks' aaa_schemas-type: type: string description: Determines type of delivery mechanism. enum: - email - pagerduty - webhook example: email aaa_secret: type: string 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. aaa_sensitive_id_response: allOf: - $ref: '#/components/schemas/aaa_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/aaa_token' aaa_sent: type: string format: date-time description: Timestamp of when the notification was dispatched in ISO 8601 format. example: "2021-10-08T17:52:17.571336Z" aaa_single_response: allOf: - $ref: '#/components/schemas/aaa_api-response-single' - properties: result: $ref: '#/components/schemas/aaa_policies' aaa_timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true aaa_token: type: string description: token in form of UUID example: a313ba7d-3e46-4c0e-a408-08fafbc3816a readOnly: true maxLength: 36 aaa_type: type: string description: Use this value when creating and updating a notification policy. example: http_alert_origin_error aaa_url: type: string description: The POST endpoint to call when dispatching a notification. example: https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd aaa_uuid: type: string description: UUID example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 readOnly: true maxLength: 36 aaa_webhook-id: type: string description: The unique identifier of a webhook example: b115d5ec-15c6-41ee-8b76-92c449b5227b readOnly: true maxLength: 36 aaa_webhooks: type: object 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' aaa_webhooks_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/aaa_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/aaa_webhooks' access_access-requests: type: object 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_email' access_access-requests_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_access-requests' access_access_group_rule: type: object title: Access groups description: Matches an Access group. required: - group properties: group: type: object required: - id properties: id: type: string description: The ID of a previously created Access group. example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f access_access_seat: type: boolean description: True if the seat is part of Access. example: false access_action: type: string description: The event that occurred, such as a login attempt. example: login access_active_device_count: type: number description: The number of active devices registered to the user. example: 2 access_active_session_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: allOf: - $ref: '#/components/schemas/access_identity' - type: object properties: isActive: type: boolean example: true type: object access_active_sessions_response: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: type: object properties: expiration: type: integer example: 1.694813506e+09 metadata: type: object properties: apps: type: object expires: type: integer example: 1.694813506e+09 iat: type: integer example: 1.694791905e+09 nonce: type: string example: X1aXj1lFVcqqyoXF ttl: type: integer example: 21600 name: type: string access_allow_all_headers: type: boolean description: Allows all HTTP request headers. example: true access_allow_all_methods: type: boolean description: Allows all HTTP request methods. access_allow_all_origins: type: boolean description: Allows all origins. access_allow_authenticate_via_warp: type: boolean 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" access_allow_credentials: type: boolean description: When set to `true`, includes credentials (cookies, authorization headers, or TLS client certificates) with requests. access_allowed: type: boolean description: The result of the authentication event. default: false access_allowed_headers: type: array description: Allowed HTTP request headers. items: type: string access_allowed_idps: type: array description: The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account. items: type: string description: The identity providers selected for application. example: 699d98642c564d2e855e9661899b7252 access_allowed_methods: type: array description: Allowed HTTP request methods. example: - GET items: type: string enum: - GET - POST - HEAD - PUT - DELETE - CONNECT - OPTIONS - TRACE - PATCH access_allowed_origins: type: array description: Allowed origins. example: - https://example.com items: type: string access_any_valid_service_token_rule: type: object title: Any Valid Service Token description: Matches any valid Access Service Token required: - any_valid_service_token properties: any_valid_service_token: type: object description: An empty object which matches on all service tokens. example: {} access_api-response-collection: allOf: - $ref: '#/components/schemas/access_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/access_result_info' type: object access_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/access_messages' messages: $ref: '#/components/schemas/access_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true access_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/access_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/access_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false access_api-response-single: allOf: - $ref: '#/components/schemas/access_api-response-common' - properties: result: anyOf: - type: object - type: string type: object access_app_count: type: integer description: Number of apps the custom page is assigned to. access_app_domain: type: string description: The URL of the Access application. example: test.example.com/admin access_app_id: oneOf: - $ref: '#/components/schemas/access_identifier' - $ref: '#/components/schemas/access_uuid' 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: type: string description: The application type. example: app_launcher access_app_launcher_visible: type: boolean description: Displays the application in the App Launcher. default: true example: true access_app_uid: type: string description: The unique identifier for the Access application. example: df7e2w5f-02b7-4d9d-af26-8d1988fca630 access_approval_group: type: object description: A group of email addresses that can approve a temporary authentication request. required: - approvals_needed properties: approvals_needed: type: number description: The number of approvals needed to obtain access. example: 1 minimum: 0 email_addresses: type: array description: A list of emails that can approve the access request. example: - test@cloudflare.com - test2@cloudflare.com items: type: string email_list_uuid: type: string description: The UUID of an re-usable email list. access_approval_groups: type: array description: Administrators who can approve a temporary authentication request. example: - approvals_needed: 1 email_addresses: - test1@cloudflare.com - test2@cloudflare.com - approvals_needed: 3 email_list_uuid: 597147a1-976b-4ef2-9af0-81d5d007fc34 items: $ref: '#/components/schemas/access_approval_group' access_approval_required: type: boolean description: Requires the user to request access from an administrator at the start of each session. default: false example: true access_apps: anyOf: - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_self_hosted_props' type: object title: Self Hosted Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_saas_props' type: object title: SaaS Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_ssh_props' type: object title: Browser SSH Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_vnc_props' type: object title: Browser VNC Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_app_launcher_props' type: object title: App Launcher Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_warp_props' type: object title: Device Enrollment Permissions Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_biso_props' type: object title: Browser Isolation Permissions Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_bookmark_props' type: object title: Bookmark application access_apps_components-schemas-name: type: string description: The name of the application. example: Admin Site access_apps_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_apps' access_apps_components-schemas-response_collection-2: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_schemas-apps' access_apps_components-schemas-single_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: $ref: '#/components/schemas/access_apps' access_apps_components-schemas-single_response-2: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: $ref: '#/components/schemas/access_schemas-apps' access_associated_hostnames: type: array description: The hostnames of the applications that will use this certificate. items: type: string description: A fully-qualified domain name (FQDN). example: admin.example.com access_aud: type: string description: The Application Audience (AUD) tag. Identifies the application associated with the CA. example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893 readOnly: true maxLength: 64 access_auth_domain: type: string description: The unique subdomain assigned to your Zero Trust organization. example: test.cloudflareaccess.com access_authentication_method_rule: type: object title: Authentication method description: Enforce different MFA options required: - auth_method properties: auth_method: type: object required: - auth_method properties: auth_method: type: string description: The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176. example: mfa access_auto_redirect_to_identity: type: boolean description: When set to `true`, users skip the identity provider selection step during login. default: false access_azure_group_rule: type: object title: Azure group description: |- Matches an Azure group. Requires an Azure identity provider. required: - azureAD properties: azureAD: type: object required: - id - connection_id properties: connection_id: type: string description: The ID of your Azure identity provider. example: ea85612a-29c8-46c2-bacb-669d65136971 id: type: string description: The ID of an Azure group. example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f access_azureAD: allOf: - $ref: '#/components/schemas/access_identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - $ref: '#/components/schemas/access_custom-claims-support' - type: object properties: conditional_access_enabled: type: boolean description: Should Cloudflare try to load authentication contexts from your account directory_id: type: string description: Your Azure directory uuid example: prompt: type: string description: Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether. enum: - login - select_account - none support_groups: type: boolean description: Should Cloudflare try to load groups from your account type: object title: Azure AD access_basic_app_response_props: type: object properties: aud: $ref: '#/components/schemas/access_schemas-aud' created_at: $ref: '#/components/schemas/access_timestamp' id: $ref: '#/components/schemas/access_uuid' updated_at: $ref: '#/components/schemas/access_timestamp' 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: type: string description: The application type. example: biso access_bookmark_props: type: object title: Bookmark application properties: app_launcher_visible: $ref: '#/components/schemas/access_app_launcher_visible' domain: type: string 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' tags: $ref: '#/components/schemas/access_tags' type: type: string description: The application type. example: bookmark access_bookmarks: type: object 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: type: string description: The unique identifier for the Bookmark application. logo_url: $ref: '#/components/schemas/access_logo_url' name: $ref: '#/components/schemas/access_bookmarks_components-schemas-name' updated_at: $ref: '#/components/schemas/access_timestamp' access_bookmarks_components-schemas-name: type: string description: The name of the Bookmark application. example: My Website access_bookmarks_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_bookmarks' access_bookmarks_components-schemas-single_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: $ref: '#/components/schemas/access_bookmarks' access_ca: type: object properties: aud: $ref: '#/components/schemas/access_aud' id: $ref: '#/components/schemas/access_id' public_key: $ref: '#/components/schemas/access_public_key' access_ca_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_ca' 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' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - $ref: '#/components/schemas/access_custom-claims-support' - type: object properties: centrify_account: type: string description: Your centrify account url example: https://abc123.my.centrify.com/ centrify_app_id: type: string description: Your centrify app id example: exampleapp type: object title: Centrify access_certificate_rule: type: object title: Valid certificate description: Matches any valid client certificate. example: certificate: {} required: - certificate properties: certificate: type: object example: {} access_certificates: type: object properties: associated_hostnames: $ref: '#/components/schemas/access_associated_hostnames' created_at: $ref: '#/components/schemas/access_timestamp' expires_on: $ref: '#/components/schemas/access_timestamp' fingerprint: $ref: '#/components/schemas/access_fingerprint' id: type: string 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' access_certificates_components-schemas-name: type: string description: The name of the certificate. example: Allow devs access_certificates_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_certificates' access_certificates_components-schemas-response_collection-2: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_schemas-certificates' 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: type: string description: The Client ID for the service token. Access will check for this value in the `CF-Access-Client-ID` request header. example: 88bf3b6d86161464f6509f7219099e57.access.example.com access_client_secret: type: string description: The Client Secret for the service token. Access will check for this value in the `CF-Access-Client-Secret` request header. example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5 access_components-schemas-domain: type: string description: The domain and path that Access will secure. example: test.example.com/admin access_components-schemas-id_response: allOf: - $ref: '#/components/schemas/access_api-response-common' - properties: result: type: object properties: id: $ref: '#/components/schemas/access_uuid' access_components-schemas-identifier: example: 699d98642c564d2e855e9661899b7252 access_components-schemas-name: type: string description: The name of the Access group. example: Allow devs access_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_service-tokens' access_components-schemas-session_duration: type: string 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.' default: 24h example: 24h access_components-schemas-single_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: $ref: '#/components/schemas/access_groups' access_connection: type: string description: The IdP used to authenticate. example: saml access_cors_headers: type: object properties: allow_all_headers: $ref: '#/components/schemas/access_allow_all_headers' allow_all_methods: $ref: '#/components/schemas/access_allow_all_methods' allow_all_origins: $ref: '#/components/schemas/access_allow_all_origins' allow_credentials: $ref: '#/components/schemas/access_allow_credentials' allowed_headers: $ref: '#/components/schemas/access_allowed_headers' allowed_methods: $ref: '#/components/schemas/access_allowed_methods' allowed_origins: $ref: '#/components/schemas/access_allowed_origins' max_age: $ref: '#/components/schemas/access_max_age' access_country_rule: type: object title: Country description: Matches a specific country required: - geo properties: geo: type: object required: - country_code properties: country_code: type: string description: The country code that should be matched. example: US 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: type: string description: The ID of the service token. name: $ref: '#/components/schemas/access_service-tokens_components-schemas-name' updated_at: $ref: '#/components/schemas/access_timestamp' access_custom-claims-support: type: object properties: claims: type: array description: Custom claims example: - email_verified - preferred_username - custom_claim_name items: type: string email_claim_name: type: string description: The claim name for email in the id_token response. example: custom_claim_name access_custom-pages_components-schemas-name: type: string description: Custom page name. access_custom-pages_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_custom_page_without_html' 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: type: string description: The custom error message shown to a user when they are denied access to the application. access_custom_deny_url: type: string description: The custom URL a user is redirected to when they are denied access to the application when failing identity-based rules. access_custom_non_identity_deny_url: type: string description: The custom URL a user is redirected to when they are denied access to the application when failing non-identity rules. access_custom_page: type: object required: - name - custom_html - type properties: app_count: $ref: '#/components/schemas/access_app_count' created_at: $ref: '#/components/schemas/access_timestamp' custom_html: type: string description: Custom page HTML. example:

Access Denied

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' access_custom_page_without_html: type: object required: - name - type properties: app_count: $ref: '#/components/schemas/access_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' access_custom_pages: properties: forbidden: type: string description: The uid of the custom page to use when a user is denied access after failing a non-identity rule. example: 699d98642c564d2e855e9661899b7252 identity_denied: type: string description: The uid of the custom page to use when a user is denied access. example: 699d98642c564d2e855e9661899b7252 access_days_until_next_rotation: type: number description: The number of days until the next key rotation. example: 1 readOnly: true access_decision: type: string description: The action Access will take if a user matches this policy. enum: - allow - deny - non_identity - bypass example: allow access_device_posture_check: type: object properties: exists: type: boolean path: type: string access_device_posture_rule: type: object title: Device Posture description: Enforces a device posture rule has run successfully required: - device_posture properties: device_posture: type: object required: - integration_uid properties: integration_uid: type: string description: The ID of a device posture integration. example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f access_device_session: type: object example: last_authenticated: 1.638832687e+09 properties: last_authenticated: type: number access_domain: type: string 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 access_domain_rule: type: object title: Email domain description: Match an entire email domain. required: - email_domain properties: email_domain: type: object required: - domain properties: domain: type: string description: The email domain to match. example: example.com access_duration: type: string description: 'The duration for how long the service token will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The default is 1 year in hours (8760h).' example: 60m access_email: type: string format: email description: The email address of the authenticating user. example: user@example.com access_email_list_rule: type: object title: Email list description: Matches an email address from a list. required: - email_list properties: email_list: type: object required: - id properties: id: type: string description: The ID of a previously created email list. example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f access_email_rule: type: object title: Email description: Matches a specific email. required: - email properties: email: type: object required: - email properties: email: type: string format: email description: The email of the user. example: test@example.com access_empty_response: allOf: - properties: result: type: boolean enum: - true - false example: true success: type: boolean enum: - true - false example: true access_enable_binding_cookie: type: boolean description: Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks. default: false access_everyone_rule: type: object title: Everyone description: Matches everyone. required: - everyone properties: everyone: type: object description: An empty object which matches on all users. example: {} access_exclude: type: array description: Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules. items: $ref: '#/components/schemas/access_rule' access_external_evaluation_rule: type: object title: External Evaluation description: Create Allow or Block policies which evaluate the user based on custom criteria. required: - external_evaluation properties: external_evaluation: type: object required: - evaluate_url - keys_url properties: evaluate_url: type: string description: The API endpoint containing your business logic. example: https://eval.example.com keys_url: type: string description: The API endpoint containing the key that Access uses to verify that the response came from your API. example: https://eval.example.com/keys access_facebook: allOf: - $ref: '#/components/schemas/access_identity-provider' - type: object properties: config: $ref: '#/components/schemas/access_generic-oauth-config' type: object title: Facebook access_failed_login_response: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: type: object properties: expiration: type: integer metadata: type: object example: app_name: Test App aud: 39691c1480a2352a18ece567debc2b32552686cbd38eec0887aa18d5d3f00c04 datetime: "2022-02-02T21:54:34.914Z" ray_id: 6d76a8a42ead4133 user_email: test@cloudflare.com user_uuid: 57171132-e453-4ee8-b2a5-8cbaad333207 access_feature_app_props: type: object required: - type properties: allowed_idps: $ref: '#/components/schemas/access_allowed_idps' auto_redirect_to_identity: $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity' domain: $ref: '#/components/schemas/access_domain' name: $ref: '#/components/schemas/access_apps_components-schemas-name' session_duration: $ref: '#/components/schemas/access_schemas-session_duration' type: $ref: '#/components/schemas/access_type' access_fingerprint: type: string description: The MD5 fingerprint of the certificate. example: MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91 access_gateway_seat: type: boolean description: True if the seat is part of Gateway. example: false access_generic-oauth-config: type: object properties: client_id: type: string description: Your OAuth Client ID example: client_secret: type: string description: Your OAuth Client Secret example: access_geo: type: object example: country: US properties: country: type: string access_github: allOf: - $ref: '#/components/schemas/access_identity-provider' - type: object properties: config: $ref: '#/components/schemas/access_generic-oauth-config' type: object title: GitHub access_github_organization_rule: type: object title: Github organization description: |- Matches a Github organization. Requires a Github identity provider. required: - github-organization properties: github-organization: type: object required: - name - connection_id properties: connection_id: type: string description: The ID of your Github identity provider. example: ea85612a-29c8-46c2-bacb-669d65136971 name: type: string description: The name of the organization. example: cloudflare access_google: allOf: - $ref: '#/components/schemas/access_identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - $ref: '#/components/schemas/access_custom-claims-support' type: object title: Google access_google-apps: allOf: - $ref: '#/components/schemas/access_identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - $ref: '#/components/schemas/access_custom-claims-support' - type: object properties: apps_domain: type: string description: Your companies TLD example: mycompany.com type: object title: Google Workspace access_groups: type: object properties: created_at: $ref: '#/components/schemas/access_timestamp' exclude: $ref: '#/components/schemas/access_exclude' id: $ref: '#/components/schemas/access_uuid' include: $ref: '#/components/schemas/access_include' is_default: $ref: '#/components/schemas/access_require' name: $ref: '#/components/schemas/access_components-schemas-name' require: $ref: '#/components/schemas/access_require' updated_at: $ref: '#/components/schemas/access_timestamp' access_groups_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_schemas-groups' access_groups_components-schemas-single_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: $ref: '#/components/schemas/access_schemas-groups' access_gsuite_group_rule: type: object title: Google Workspace group description: |- Matches a group in Google Workspace. Requires a Google Workspace identity provider. required: - gsuite properties: gsuite: type: object required: - email - connection_id properties: connection_id: type: string description: The ID of your Google Workspace identity provider. example: ea85612a-29c8-46c2-bacb-669d65136971 email: type: string description: The email of the Google Workspace group. example: devs@cloudflare.com access_http_only_cookie_attribute: type: boolean description: Enables the HttpOnly cookie attribute, which increases security against XSS attacks. default: true example: true access_id: type: string description: The ID of the CA. example: 7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9 readOnly: true maxLength: 48 access_id_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/access_uuid' access_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 access_identity: type: object properties: account_id: type: string example: "1234567890" auth_status: type: string example: NONE common_name: type: string example: "" device_id: type: string example: "" device_sessions: $ref: '#/components/schemas/access_string_key_map_device_session' devicePosture: type: object email: type: string example: test@cloudflare.com geo: $ref: '#/components/schemas/access_geo' iat: type: number example: 1.694791905e+09 idp: type: object properties: id: type: string type: type: string ip: type: string example: 127.0.0.0 is_gateway: type: boolean example: false is_warp: type: boolean example: false mtls_auth: type: object properties: auth_status: type: string cert_issuer_dn: type: string cert_issuer_ski: type: string cert_presented: type: boolean cert_serial: type: string service_token_id: type: string example: "" service_token_status: type: boolean example: false user_uuid: type: string example: 57cf8cf2-f55a-4588-9ac9-f5e41e9f09b4 version: type: number example: 2 access_identity-provider: type: object required: - name - type - config properties: config: type: object description: The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). id: $ref: '#/components/schemas/access_uuid' name: $ref: '#/components/schemas/access_schemas-name' scim_config: type: object description: The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider. properties: enabled: type: boolean description: A flag to enable or disable SCIM for the identity provider. group_member_deprovision: type: boolean description: A flag to revoke a user's session in Access and force a reauthentication on the user's Gateway session when they have been added or removed from a group in the Identity Provider. seat_deprovision: type: boolean description: A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider. This cannot be enabled unless user_deprovision is also enabled. secret: type: string description: A read-only token generated when the SCIM integration is enabled for the first time. It is redacted on subsequent requests. If you lose this you will need to refresh it token at /access/identity_providers/:idpID/refresh_scim_secret. user_deprovision: type: boolean description: A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider. type: type: string description: The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). enum: - onetimepin - azureAD - saml - centrify - facebook - github - google-apps - google - linkedin - oidc - okta - onelogin - pingone - yandex example: onetimepin 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' - type: object properties: result: type: array items: anyOf: - $ref: '#/components/schemas/access_schemas-azureAD' - $ref: '#/components/schemas/access_schemas-centrify' - $ref: '#/components/schemas/access_schemas-facebook' - $ref: '#/components/schemas/access_schemas-github' - $ref: '#/components/schemas/access_schemas-google' - $ref: '#/components/schemas/access_schemas-google-apps' - $ref: '#/components/schemas/access_schemas-linkedin' - $ref: '#/components/schemas/access_schemas-oidc' - $ref: '#/components/schemas/access_schemas-okta' - $ref: '#/components/schemas/access_schemas-onelogin' - $ref: '#/components/schemas/access_schemas-pingone' - $ref: '#/components/schemas/access_schemas-saml' - $ref: '#/components/schemas/access_schemas-yandex' - $ref: '#/components/schemas/access_schemas-onetimepin' type: object 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_include: type: array description: Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules. items: $ref: '#/components/schemas/access_rule' access_ip: type: string description: The IP address of the authenticating user. example: 198.41.129.166 access_ip_list_rule: type: object title: IP list description: Matches an IP address from a list. required: - ip_list properties: ip_list: type: object required: - id properties: id: type: string description: The ID of a previously created IP list. example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f access_ip_rule: type: object title: IP ranges description: Matches an IP address block. required: - ip properties: ip: type: object required: - ip properties: ip: type: string description: An IPv4 or IPv6 CIDR block. example: 2400:cb00:21:10a::/64 access_is_default: type: boolean description: Whether this is the default group access_is_ui_read_only: type: boolean description: Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled. example: "false" access_isolation_required: type: boolean 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. default: false example: false access_key_config: type: object 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' access_key_rotation_interval_days: type: number description: The number of days between key rotations. example: 30 minimum: 21 maximum: 365 access_keys_components-schemas-single_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - $ref: '#/components/schemas/access_key_config' access_last_key_rotation_at: type: string format: date-time description: The timestamp of the previous key rotation. example: "2014-01-01T05:20:00.12345Z" 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: type: string format: date-time description: The time at which the user last successfully logged in. example: "2020-07-01T05:20:00Z" access_linkedin: allOf: - $ref: '#/components/schemas/access_identity-provider' - type: object properties: config: $ref: '#/components/schemas/access_generic-oauth-config' type: object title: LinkedIn access_login_design: properties: background_color: type: string description: The background color on your login page. example: '#c5ed1b' footer_text: type: string description: The text at the bottom of your login page. example: This is an example description. header_text: type: string description: The text at the top of your login page. example: This is an example description. logo_path: type: string description: The URL of the logo on your login page. example: https://example.com/logo.png text_color: type: string description: The text color on your login page. example: '#c5ed1b' access_logo_url: type: string description: The image URL for the logo shown in the App Launcher dashboard. example: https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg access_max_age: type: number description: The maximum number of seconds the results of a preflight request can be cached. example: -1 minimum: -1 maximum: 86400 access_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string access_name: type: string description: The name of your Zero Trust organization. example: Widget Corps Internal Applications access_name_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - type: object properties: result: type: object properties: name: $ref: '#/components/schemas/access_tags_components-schemas-name' access_nonce: type: string example: X1aXj1lFVcqqyoXF access_oidc: allOf: - $ref: '#/components/schemas/access_identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - $ref: '#/components/schemas/access_custom-claims-support' - type: object properties: auth_url: type: string description: The authorization_endpoint URL of your IdP example: https://accounts.google.com/o/oauth2/auth certs_url: type: string description: The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens example: https://www.googleapis.com/oauth2/v3/certs scopes: type: array description: OAuth scopes example: - openid - email - profile items: type: string token_url: type: string description: The token_endpoint URL of your IdP example: https://accounts.google.com/o/oauth2/token type: object title: Generic OAuth access_oidc_saas_app: type: object title: OIDC SaaS App properties: app_launcher_url: type: string description: The URL where this applications tile redirects users example: https://example.com/login auth_type: type: string description: Identifier of the authentication protocol used for the saas app. Required for OIDC. enum: - saml - oidc example: oidc client_id: type: string description: The application client id example: oidc client id client_secret: type: string description: The application client secret, only returned on POST request. example: oidc client secret created_at: $ref: '#/components/schemas/access_timestamp' grant_types: type: array description: The OIDC flows supported by this application example: - authorization_code items: type: string enum: - authorization_code - authorization_code_with_pkce group_filter_regex: type: string description: A regex to filter Cloudflare groups returned in ID token and userinfo endpoint example: ^GROUP_FILTER-*$ public_key: type: string description: The Access public certificate that will be used to verify your identity. example: example unique name redirect_uris: type: array description: The permitted URL's for Cloudflare to return Authorization codes and Access/ID tokens example: - https://example.com items: type: string scopes: type: array description: Define the user information shared with access example: - openid - groups - email - profile items: type: string enum: - openid - groups - email - profile updated_at: $ref: '#/components/schemas/access_timestamp' access_okta: allOf: - $ref: '#/components/schemas/access_identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - $ref: '#/components/schemas/access_custom-claims-support' - type: object properties: authorization_server_id: type: string description: Your okta authorization server id example: aus9o8wzkhckw9TLa0h7z okta_account: type: string description: Your okta account url example: https://dev-abc123.oktapreview.com type: object title: Okta access_okta_group_rule: type: object title: Okta group description: |- Matches an Okta group. Requires an Okta identity provider. required: - okta properties: okta: type: object required: - email - connection_id properties: connection_id: type: string description: The ID of your Okta identity provider. example: ea85612a-29c8-46c2-bacb-669d65136971 email: type: string description: The email of the Okta group. example: devs@cloudflare.com access_onelogin: allOf: - $ref: '#/components/schemas/access_identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - $ref: '#/components/schemas/access_custom-claims-support' - type: object properties: onelogin_account: type: string description: Your OneLogin account url example: https://mycompany.onelogin.com type: object title: OneLogin access_onetimepin: allOf: - $ref: '#/components/schemas/access_identity-provider' - properties: config: type: object type: enum: - onetimepin type: object title: One Time Pin access_options_preflight_bypass: type: boolean 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 access_organizations: type: object 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' access_organizations_components-schemas-single_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: $ref: '#/components/schemas/access_schemas-organizations' access_path_cookie_attribute: type: boolean 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 default: false example: true access_pingone: allOf: - $ref: '#/components/schemas/access_identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - $ref: '#/components/schemas/access_custom-claims-support' - type: object properties: ping_env_id: type: string description: Your PingOne environment identifier example: 342b5660-0c32-4936-a5a4-ce21fae57b0a type: object title: PingOne access_policies: type: object properties: approval_groups: $ref: '#/components/schemas/access_approval_groups' approval_required: $ref: '#/components/schemas/access_approval_required' created_at: $ref: '#/components/schemas/access_timestamp' decision: $ref: '#/components/schemas/access_decision' exclude: $ref: '#/components/schemas/access_schemas-exclude' id: $ref: '#/components/schemas/access_uuid' include: $ref: '#/components/schemas/access_include' isolation_required: $ref: '#/components/schemas/access_isolation_required' name: $ref: '#/components/schemas/access_policies_components-schemas-name' precedence: $ref: '#/components/schemas/access_precedence' purpose_justification_prompt: $ref: '#/components/schemas/access_purpose_justification_prompt' purpose_justification_required: $ref: '#/components/schemas/access_purpose_justification_required' require: $ref: '#/components/schemas/access_schemas-require' session_duration: $ref: '#/components/schemas/access_components-schemas-session_duration' updated_at: $ref: '#/components/schemas/access_timestamp' access_policies_components-schemas-name: type: string description: The name of the Access policy. example: Allow devs access_policies_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_policies' access_policies_components-schemas-response_collection-2: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_schemas-policies' access_policies_components-schemas-single_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: $ref: '#/components/schemas/access_policies' access_policies_components-schemas-single_response-2: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: $ref: '#/components/schemas/access_schemas-policies' access_policy_check_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: type: object properties: app_state: type: object properties: app_uid: $ref: '#/components/schemas/access_uuid' aud: type: string example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389 hostname: type: string example: test.com name: type: string example: Test App policies: type: array example: - decision: allow exclude: [] include: - _type: email email: testuser@gmail.com precedence: 0 require: [] status: Success items: type: object status: type: string example: Success user_identity: type: object properties: account_id: type: string example: 41ecfbb341f033e52b46742756aabb8b device_sessions: type: object example: {} email: type: string example: testuser@gmail.com geo: type: object properties: country: type: string example: US iat: type: integer id: type: string example: "1164449231815010287495" is_gateway: type: boolean example: false is_warp: type: boolean example: false name: type: string example: Test User user_uuid: $ref: '#/components/schemas/access_uuid' version: type: integer access_precedence: type: integer description: The order of execution for this policy. Must be unique for each policy. access_public_key: type: string description: The public key to add to your SSH server configuration. example: ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org readOnly: true access_purpose_justification_prompt: type: string description: A custom message that will appear on the purpose justification screen. example: Please enter a justification for entering this protected domain. access_purpose_justification_required: type: boolean description: Require users to enter a justification when they log in to the application. default: false example: true access_ray_id: type: string description: The unique identifier for the request to Cloudflare. example: 187d944c61940c77 maxLength: 16 access_require: type: array description: Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules. items: $ref: '#/components/schemas/access_rule' access_response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - type: object properties: result: type: array 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: object access_response_collection_hostnames: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_settings' access_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 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: type: object title: SaaS Application properties: allowed_idps: $ref: '#/components/schemas/access_allowed_idps' app_launcher_visible: $ref: '#/components/schemas/access_app_launcher_visible' auto_redirect_to_identity: $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity' 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: type: string description: The application type. example: saas access_same_site_cookie_attribute: type: string description: Sets the SameSite cookie setting, which provides increased security against CSRF attacks. example: strict access_saml: allOf: - $ref: '#/components/schemas/access_identity-provider' - type: object properties: config: type: object properties: attributes: type: array description: A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules. example: - group - department_code - divison items: type: string email_attribute_name: type: string description: The attribute name for email in the SAML response. example: Email header_attributes: type: array description: Add a list of attribute names that will be returned in the response header from the Access callback. items: type: object properties: attribute_name: type: string description: attribute name from the IDP header_name: type: string description: header that will be added on the request to the origin idp_public_certs: type: array description: X509 certificate to verify the signature in the SAML authentication response items: type: string issuer_url: type: string description: IdP Entity ID or Issuer URL example: https://whoami.com sign_request: type: boolean description: Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints. sso_target_url: type: string description: URL to send the SAML authentication requests to example: https://edgeaccess.org/idp/saml/login type: object title: Generic SAML access_saml_group_rule: type: object title: SAML group description: |- Matches a SAML group. Requires a SAML identity provider. required: - saml properties: saml: type: object required: - attribute_name - attribute_value properties: attribute_name: type: string description: The name of the SAML attribute. example: group attribute_value: type: string description: The SAML attribute value to look for. example: devs@cloudflare.com access_saml_saas_app: type: object title: SAML SaaS App properties: auth_type: type: string description: Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is "saml" enum: - saml - oidc example: saml consumer_service_url: type: string description: The service provider's endpoint that is responsible for receiving and parsing a SAML assertion. example: https://example.com created_at: $ref: '#/components/schemas/access_timestamp' custom_attributes: type: object properties: name: type: string description: The name of the attribute. example: family_name name_format: type: string description: A globally unique name for an identity or service provider. enum: - urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified - urn:oasis:names:tc:SAML:2.0:attrname-format:basic - urn:oasis:names:tc:SAML:2.0:attrname-format:uri example: urn:oasis:names:tc:SAML:2.0:attrname-format:basic source: type: object properties: name: type: string description: The name of the IdP attribute. example: last_name default_relay_state: type: string description: The URL that the user will be redirected to after a successful login for IDP initiated logins. example: https://example.com idp_entity_id: type: string description: The unique identifier for your SaaS application. example: https://example.cloudflareaccess.com name_id_format: type: string description: The format of the name identifier sent to the SaaS application. enum: - id - email example: id name_id_transform_jsonata: type: string description: | A [JSONata](https://jsonata.org/) expression that transforms an application's user identities into a NameID value for its SAML assertion. This expression should evaluate to a singular string. The output of this expression can override the `name_id_format` setting. example: $substringBefore(email, '@') & '+sandbox@' & $substringAfter(email, '@') public_key: type: string description: The Access public certificate that will be used to verify your identity. example: example unique name saml_attribute_transform_jsonata: type: string 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} |' sp_entity_id: type: string description: A globally unique name for an identity or service provider. example: example unique name sso_endpoint: type: string description: The endpoint where your SaaS application will send login requests. example: https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd updated_at: $ref: '#/components/schemas/access_timestamp' access_schemas-access_seat: type: boolean description: True if the user has authenticated with Cloudflare Access. example: false access_schemas-allow_authenticate_via_warp: type: boolean 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 access_schemas-allowed_headers: type: array description: Allowed HTTP request headers. items: {} access_schemas-allowed_origins: type: array description: Allowed origins. example: - https://example.com items: {} access_schemas-app_launcher_props: allOf: - $ref: '#/components/schemas/access_schemas-feature_app_props' - properties: domain: example: authdomain.cloudflareaccess.com readOnly: true name: default: App Launcher example: App Launcher readOnly: true type: type: string description: The application type. example: app_launcher access_schemas-app_launcher_visible: type: boolean description: Displays the application in the App Launcher. example: true access_schemas-approval_group: type: object description: A group of email addresses that can approve a temporary authentication request. required: - approvals_needed properties: approvals_needed: type: number description: The number of approvals needed to obtain access. example: 1 minimum: 0 email_addresses: type: array description: A list of emails that can approve the access request. example: - test@cloudflare.com - test2@cloudflare.com items: {} email_list_uuid: type: string description: The UUID of an re-usable email list. access_schemas-approval_groups: type: array description: Administrators who can approve a temporary authentication request. example: - approvals_needed: 1 email_addresses: - test1@cloudflare.com - test2@cloudflare.com - approvals_needed: 3 email_list_uuid: 597147a1-976b-4ef2-9af0-81d5d007fc34 items: $ref: '#/components/schemas/access_schemas-approval_group' access_schemas-apps: anyOf: - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_schemas-self_hosted_props' type: object title: Self Hosted Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_schemas-saas_props' type: object title: SaaS Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_schemas-ssh_props' type: object title: Browser SSH Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_schemas-vnc_props' type: object title: Browser VNC Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_schemas-app_launcher_props' type: object title: App Launcher Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_schemas-warp_props' type: object title: Device Enrollment Permissions Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_schemas-biso_props' type: object title: Browser Isolation Permissions Application - allOf: - $ref: '#/components/schemas/access_basic_app_response_props' - $ref: '#/components/schemas/access_schemas-bookmark_props' type: object title: Bookmark application type: object access_schemas-aud: type: string description: Audience tag. example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893 readOnly: true maxLength: 64 access_schemas-auto_redirect_to_identity: type: boolean description: When set to `true`, users skip the identity provider selection step during login. You must specify only one identity provider in allowed_idps. default: false access_schemas-azureAD: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - type: object properties: conditional_access_enabled: type: boolean description: Should Cloudflare try to load authentication contexts from your account directory_id: type: string description: Your Azure directory uuid example: prompt: type: string description: Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether. enum: - login - select_account - none support_groups: type: boolean description: Should Cloudflare try to load groups from your account type: object title: Azure AD access_schemas-biso_props: allOf: - $ref: '#/components/schemas/access_schemas-feature_app_props' - properties: domain: example: authdomain.cloudflareaccess.com/browser readOnly: true name: default: Clientless Web Isolation example: Clientless Web Isolation readOnly: true type: type: string description: The application type. example: biso access_schemas-bookmark_props: type: object title: Bookmark Application required: - type - domain properties: app_launcher_visible: default: true domain: description: The URL or domain of the bookmark. example: https://mybookmark.com logo_url: $ref: '#/components/schemas/access_logo_url' name: $ref: '#/components/schemas/access_apps_components-schemas-name' type: type: string description: The application type. example: bookmark access_schemas-centrify: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - type: object properties: centrify_account: type: string description: Your centrify account url example: https://abc123.my.centrify.com/ centrify_app_id: type: string description: Your centrify app id example: exampleapp type: object title: Centrify access_schemas-certificates: type: object properties: associated_hostnames: $ref: '#/components/schemas/access_associated_hostnames' created_at: $ref: '#/components/schemas/access_timestamp' expires_on: $ref: '#/components/schemas/access_timestamp' fingerprint: $ref: '#/components/schemas/access_fingerprint' id: description: The ID of the application that will use this certificate. name: $ref: '#/components/schemas/access_certificates_components-schemas-name' updated_at: $ref: '#/components/schemas/access_timestamp' access_schemas-cors_headers: type: object properties: allow_all_headers: $ref: '#/components/schemas/access_allow_all_headers' allow_all_methods: $ref: '#/components/schemas/access_allow_all_methods' allow_all_origins: $ref: '#/components/schemas/access_allow_all_origins' allow_credentials: $ref: '#/components/schemas/access_allow_credentials' allowed_headers: $ref: '#/components/schemas/access_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' access_schemas-custom_deny_url: type: string description: The custom URL a user is redirected to when they are denied access to the application. access_schemas-custom_pages: type: array description: The custom pages that will be displayed when applicable for this application items: type: string description: The custom pages selected for application. example: 699d98642c564d2e855e9661899b7252 access_schemas-device_posture_rule: type: object 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 access_schemas-domain: type: string description: The domain of the Bookmark application. example: example.com access_schemas-email: type: string format: email description: The email of the user. example: jdoe@example.com access_schemas-empty_response: allOf: - properties: result: type: object nullable: true success: type: boolean enum: - true - false example: true access_schemas-exclude: type: array description: Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules. items: $ref: '#/components/schemas/access_rule' access_schemas-facebook: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: $ref: '#/components/schemas/access_generic-oauth-config' type: object title: Facebook access_schemas-feature_app_props: type: object required: - type properties: allowed_idps: $ref: '#/components/schemas/access_allowed_idps' auto_redirect_to_identity: $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity' domain: $ref: '#/components/schemas/access_components-schemas-domain' name: $ref: '#/components/schemas/access_apps_components-schemas-name' session_duration: $ref: '#/components/schemas/access_schemas-session_duration' type: $ref: '#/components/schemas/access_type' access_schemas-gateway_seat: type: boolean description: True if the user has logged into the WARP client. example: false access_schemas-github: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: $ref: '#/components/schemas/access_generic-oauth-config' type: object title: GitHub access_schemas-google: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: $ref: '#/components/schemas/access_generic-oauth-config' type: object title: Google access_schemas-google-apps: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - type: object properties: apps_domain: type: string description: Your companies TLD example: mycompany.com type: object title: Google Workspace access_schemas-groups: type: object properties: created_at: $ref: '#/components/schemas/access_timestamp' exclude: $ref: '#/components/schemas/access_exclude' id: $ref: '#/components/schemas/access_uuid' include: $ref: '#/components/schemas/access_include' name: $ref: '#/components/schemas/access_components-schemas-name' require: $ref: '#/components/schemas/access_require' updated_at: $ref: '#/components/schemas/access_timestamp' access_schemas-id_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/access_id' access_schemas-identifier: type: string example: 699d98642c564d2e855e9661899b7252 access_schemas-identity-provider: type: object required: - name - type - config properties: config: type: object description: The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). id: $ref: '#/components/schemas/access_uuid' name: $ref: '#/components/schemas/access_schemas-name' scim_config: type: object description: The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider. properties: enabled: type: boolean description: A flag to enable or disable SCIM for the identity provider. group_member_deprovision: type: boolean description: A flag to revoke a user's session in Access and force a reauthentication on the user's Gateway session when they have been added or removed from a group in the Identity Provider. seat_deprovision: type: boolean description: A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider. This cannot be enabled unless user_deprovision is also enabled. secret: type: string description: A read-only token generated when the SCIM integration is enabled for the first time. It is redacted on subsequent requests. If you lose this you will need to refresh it token at /access/identity_providers/:idpID/refresh_scim_secret. user_deprovision: type: boolean description: A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider. type: type: string description: The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). enum: - onetimepin - azureAD - saml - centrify - facebook - github - google-apps - google - linkedin - oidc - okta - onelogin - pingone - yandex example: onetimepin 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: type: boolean description: Require this application to be served in an isolated browser for users matching this policy. default: false example: false access_schemas-linkedin: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: $ref: '#/components/schemas/access_generic-oauth-config' type: object title: LinkedIn access_schemas-name: type: string description: The name of the identity provider, shown to users on the login page. example: Widget Corps IDP access_schemas-oidc: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - type: object properties: auth_url: type: string description: The authorization_endpoint URL of your IdP example: https://accounts.google.com/o/oauth2/auth certs_url: type: string description: The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens example: https://www.googleapis.com/oauth2/v3/certs claims: type: array description: List of custom claims that will be pulled from your id_token and added to your signed Access JWT token. example: - given_name - locale items: type: string scopes: type: array description: OAuth scopes example: - openid - email - profile items: type: string token_url: type: string description: The token_endpoint URL of your IdP example: https://accounts.google.com/o/oauth2/token type: object title: Generic OAuth access_schemas-okta: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - type: object properties: okta_account: type: string description: Your okta account url example: https://dev-abc123.oktapreview.com type: object title: Okta access_schemas-onelogin: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - type: object properties: onelogin_account: type: string description: Your OneLogin account url example: https://mycompany.onelogin.com type: object title: OneLogin access_schemas-onetimepin: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - properties: config: type: object type: enum: - onetimepin type: object title: One Time Pin access_schemas-organizations: type: object properties: auth_domain: $ref: '#/components/schemas/access_auth_domain' created_at: $ref: '#/components/schemas/access_timestamp' is_ui_read_only: $ref: '#/components/schemas/access_is_ui_read_only' login_design: $ref: '#/components/schemas/access_login_design' name: $ref: '#/components/schemas/access_name' ui_read_only_toggle_reason: $ref: '#/components/schemas/access_ui_read_only_toggle_reason' updated_at: $ref: '#/components/schemas/access_timestamp' user_seat_expiration_inactive_time: $ref: '#/components/schemas/access_user_seat_expiration_inactive_time' access_schemas-pingone: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: allOf: - $ref: '#/components/schemas/access_generic-oauth-config' - type: object properties: ping_env_id: type: string description: Your PingOne environment identifier example: 342b5660-0c32-4936-a5a4-ce21fae57b0a type: object title: PingOne access_schemas-policies: type: object 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_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' access_schemas-policy_check_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: type: object properties: app_state: type: object properties: app_uid: $ref: '#/components/schemas/access_uuid' aud: type: string example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389 hostname: type: string example: test.com name: type: string example: Test App policies: type: array example: - decision: allow exclude: [] include: - _type: email email: testuser@gmail.com precedence: 0 require: [] status: Success items: {} status: type: string example: Success user_identity: type: object properties: account_id: type: string example: 41ecfbb341f033e52b46742756aabb8b device_sessions: type: object example: {} email: type: string example: testuser@gmail.com geo: type: object properties: country: type: string example: US iat: type: integer id: type: string example: "1164449231815010287495" is_gateway: type: boolean example: false is_warp: type: boolean example: false name: type: string example: Test User user_uuid: $ref: '#/components/schemas/access_uuid' version: type: integer access_schemas-require: type: array description: Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules. items: $ref: '#/components/schemas/access_rule' access_schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_groups' access_schemas-saas_props: type: object title: SaaS Application properties: allowed_idps: $ref: '#/components/schemas/access_allowed_idps' app_launcher_visible: $ref: '#/components/schemas/access_app_launcher_visible' auto_redirect_to_identity: $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity' logo_url: $ref: '#/components/schemas/access_logo_url' name: $ref: '#/components/schemas/access_apps_components-schemas-name' saas_app: oneOf: - $ref: '#/components/schemas/access_schemas-saml_saas_app' - $ref: '#/components/schemas/access_oidc_saas_app' type: object type: type: string description: The application type. example: saas access_schemas-saml: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: type: object properties: attributes: type: array description: A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules. example: - group - department_code - divison items: type: string email_attribute_name: type: string description: The attribute name for email in the SAML response. example: Email header_attributes: type: array description: Add a list of attribute names that will be returned in the response header from the Access callback. items: type: object properties: attribute_name: type: string description: attribute name from the IDP header_name: type: string description: header that will be added on the request to the origin idp_public_certs: type: array description: X509 certificate to verify the signature in the SAML authentication response items: type: string issuer_url: type: string description: IdP Entity ID or Issuer URL example: https://whoami.com sign_request: type: boolean description: Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints. sso_target_url: type: string description: URL to send the SAML authentication requests to example: https://edgeaccess.org/idp/saml/login type: object title: Generic SAML access_schemas-saml_saas_app: type: object title: SAML SaaS App properties: auth_type: type: string description: Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is "saml" enum: - saml - oidc example: saml consumer_service_url: type: string description: The service provider's endpoint that is responsible for receiving and parsing a SAML assertion. example: https://example.com created_at: $ref: '#/components/schemas/access_timestamp' custom_attributes: type: object properties: name: type: string description: The name of the attribute. example: family_name name_format: type: string description: A globally unique name for an identity or service provider. enum: - urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified - urn:oasis:names:tc:SAML:2.0:attrname-format:basic - urn:oasis:names:tc:SAML:2.0:attrname-format:uri example: urn:oasis:names:tc:SAML:2.0:attrname-format:basic source: type: object properties: name: type: string description: The name of the IdP attribute. example: last_name idp_entity_id: type: string description: The unique identifier for your SaaS application. example: https://example.cloudflareaccess.com name_id_format: type: string description: The format of the name identifier sent to the SaaS application. enum: - id - email example: id name_id_transform_jsonata: type: string description: | A [JSONata](https://jsonata.org/) expression that transforms an application's user identities into a NameID value for its SAML assertion. This expression should evaluate to a singular string. The output of this expression can override the `name_id_format` setting. example: $substringBefore(email, '@') & '+sandbox@' & $substringAfter(email, '@') public_key: type: string description: The Access public certificate that will be used to verify your identity. example: example unique name sp_entity_id: type: string description: A globally unique name for an identity or service provider. example: example unique name sso_endpoint: type: string description: The endpoint where your SaaS application will send login requests. example: https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd updated_at: $ref: '#/components/schemas/access_timestamp' access_schemas-self_hosted_props: type: object title: Self Hosted Application required: - type - domain properties: allowed_idps: $ref: '#/components/schemas/access_allowed_idps' app_launcher_visible: $ref: '#/components/schemas/access_app_launcher_visible' auto_redirect_to_identity: $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity' cors_headers: $ref: '#/components/schemas/access_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: type: string description: The application type. example: self_hosted access_schemas-session_duration: type: string description: 'The amount of time that tokens issued for this application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.' default: 24h example: 24h access_schemas-single_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: $ref: '#/components/schemas/access_identity-providers' access_schemas-ssh_props: allOf: - $ref: '#/components/schemas/access_schemas-self_hosted_props' - properties: type: type: string description: The application type. example: ssh access_schemas-type: type: string description: Custom page type. enum: - identity_denied - forbidden access_schemas-vnc_props: allOf: - $ref: '#/components/schemas/access_schemas-self_hosted_props' - properties: type: type: string description: The application type. example: vnc access_schemas-warp_props: allOf: - $ref: '#/components/schemas/access_schemas-feature_app_props' - properties: domain: example: authdomain.cloudflareaccess.com/warp readOnly: true name: default: Warp Login App example: Warp Login App readOnly: true type: type: string description: The application type. example: warp access_schemas-yandex: allOf: - $ref: '#/components/schemas/access_schemas-identity-provider' - type: object properties: config: $ref: '#/components/schemas/access_generic-oauth-config' type: object title: Yandex access_seat: type: object required: - seat_uid - gateway_seat - 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_identifier' access_seat_uid: type: string description: The unique API identifier for the Zero Trust seat. access_seats: type: object 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_identifier' updated_at: $ref: '#/components/schemas/access_timestamp' access_seats_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/access_seats' access_seats_definition: type: array items: $ref: '#/components/schemas/access_seat' required: - seat_uid - gateway_seat - access_seat access_self_hosted_domains: type: array description: List of domains that Access will secure. example: - test.example.com/admin - test.anotherexample.com/staff items: type: string description: A domain that Access will secure. access_self_hosted_props: type: object title: Self Hosted Application required: - type - domain 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: type: string description: The application type. example: self_hosted access_service-tokens: type: object properties: client_id: $ref: '#/components/schemas/access_client_id' created_at: $ref: '#/components/schemas/access_timestamp' duration: $ref: '#/components/schemas/access_duration' id: description: The ID of the service token. name: $ref: '#/components/schemas/access_service-tokens_components-schemas-name' updated_at: $ref: '#/components/schemas/access_timestamp' access_service-tokens_components-schemas-name: type: string description: The name of the service token. example: CI/CD token access_service-tokens_components-schemas-single_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: $ref: '#/components/schemas/access_service-tokens' access_service_auth_401_redirect: type: boolean description: Returns a 401 status code when the request is blocked by a Service Auth policy. example: true access_service_token_rule: type: object title: Service Token description: Matches a specific Access Service Token required: - service_token properties: service_token: type: object required: - token_id properties: token_id: type: string description: The ID of a Service Token. example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f access_session_duration: type: string 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 access_settings: type: object title: Hostname Settings required: - hostname - china_network - client_certificate_forwarding properties: china_network: type: boolean description: Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled. example: false client_certificate_forwarding: type: boolean description: Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin. example: true hostname: type: string description: The hostname that these settings apply to. example: admin.example.com 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_interstitial: type: boolean description: Enables automatic authentication through cloudflared. example: true access_ssh_props: allOf: - $ref: '#/components/schemas/access_self_hosted_props' - properties: type: type: string description: The application type. example: ssh access_string_key_map_device_session: type: object access_tag: type: object description: A tag required: - name properties: app_count: type: integer description: The number of applications that have this tag example: 1 created_at: $ref: '#/components/schemas/access_timestamp' name: $ref: '#/components/schemas/access_tags_components-schemas-name' updated_at: $ref: '#/components/schemas/access_timestamp' access_tag_without_app_count: type: object description: A tag required: - name properties: created_at: $ref: '#/components/schemas/access_timestamp' name: $ref: '#/components/schemas/access_tags_components-schemas-name' updated_at: $ref: '#/components/schemas/access_timestamp' access_tags: type: array description: The tags you want assigned to an application. Tags are used to filter applications in the App Launcher dashboard. items: type: string description: The tag associated with an application. example: engineers access_tags_components-schemas-name: type: string description: The name of the tag example: engineers access_tags_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/access_tag' access_tags_components-schemas-single_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - type: object properties: result: $ref: '#/components/schemas/access_tag' access_timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true access_type: type: string description: The application type. enum: - self_hosted - saas - ssh - vnc - app_launcher - warp - biso - bookmark - dash_sso example: self_hosted access_ui_read_only_toggle_reason: type: string description: A description of the reason why the UI read only field is being toggled. example: Temporarily turn off the UI read only lock to make a change via the UI access_uid: type: string description: The unique API identifier for the user. access_user_seat_expiration_inactive_time: type: string description: 'The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Must be in the format `300ms` or `2h45m`. Valid time units are: `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.' example: 720h access_users: type: object 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_schemas-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_seat_uid' uid: $ref: '#/components/schemas/access_uid' updated_at: $ref: '#/components/schemas/access_timestamp' access_users_components-schemas-name: type: string description: The name of the user. example: Jane Doe access_users_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/access_api-response-collection' - properties: result_info: type: object properties: count: example: 1 page: example: 1 per_page: example: 100 total_count: example: 1 - properties: result: type: array items: $ref: '#/components/schemas/access_users' access_uuid: type: string description: UUID example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 readOnly: true maxLength: 36 access_vnc_props: allOf: - $ref: '#/components/schemas/access_self_hosted_props' - properties: type: type: string description: The application type. example: vnc access_warp_auth_session_duration: type: string 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 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: type: string description: The application type. example: warp access_yandex: allOf: - $ref: '#/components/schemas/access_identity-provider' - type: object properties: config: $ref: '#/components/schemas/access_generic-oauth-config' type: object title: Yandex addressing_address-maps: type: object 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' addressing_address-maps-ip: type: object properties: created_at: $ref: '#/components/schemas/addressing_timestamp' ip: $ref: '#/components/schemas/addressing_ip' addressing_address-maps-membership: type: object properties: can_delete: $ref: '#/components/schemas/addressing_schemas-can_delete' created_at: $ref: '#/components/schemas/addressing_timestamp' identifier: $ref: '#/components/schemas/addressing_identifier' kind: $ref: '#/components/schemas/addressing_kind' addressing_advertised: type: boolean description: Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled. example: true nullable: true addressing_advertised_response: allOf: - $ref: '#/components/schemas/addressing_api-response-single' - properties: result: type: object properties: advertised: $ref: '#/components/schemas/addressing_schemas-advertised' advertised_modified_at: $ref: '#/components/schemas/addressing_modified_at_nullable' addressing_api-response-collection: allOf: - $ref: '#/components/schemas/addressing_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/addressing_result_info' type: object addressing_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/addressing_messages' messages: $ref: '#/components/schemas/addressing_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true addressing_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false addressing_api-response-single: allOf: - $ref: '#/components/schemas/addressing_api-response-common' - properties: result: anyOf: - type: object - type: string type: object addressing_approved: type: string description: Approval state of the prefix (P = pending, V = active). example: P addressing_asn: type: integer description: Autonomous System Number (ASN) the prefix will be advertised under. example: 209242 nullable: true addressing_bgp_on_demand: type: object 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' addressing_bgp_prefix_update_advertisement: type: object properties: on_demand: type: object properties: advertised: type: boolean addressing_bgp_signal_opts: type: object properties: enabled: $ref: '#/components/schemas/addressing_bgp_signaling_enabled' modified_at: $ref: '#/components/schemas/addressing_bgp_signaling_modified_at' addressing_bgp_signaling_enabled: type: boolean description: Whether control of advertisement of the prefix to the Internet is enabled to be performed via BGP signal example: false addressing_bgp_signaling_modified_at: type: string format: date-time 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" nullable: true addressing_can_delete: type: boolean description: If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps. example: true readOnly: true addressing_can_modify_ips: type: boolean description: If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps. example: true readOnly: true addressing_cidr: type: string description: IP Prefix in Classless Inter-Domain Routing format. example: 192.0.2.0/24 addressing_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/addressing_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/addressing_address-maps' 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: type: object properties: cidr: $ref: '#/components/schemas/addressing_cidr' service_id: $ref: '#/components/schemas/addressing_service_identifier' addressing_default_sni: type: string description: If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account. example: '*.example.com' nullable: true addressing_delegated_account_identifier: type: string description: Account identifier for the account to which prefix is being delegated. example: b1946ac92492d2347c6235b4d2611184 maxLength: 32 addressing_delegation_identifier: type: string description: Delegation identifier tag. example: d933b1530bc56c9953cf8ce166da8004 readOnly: true maxLength: 32 addressing_description: type: string description: Description of the prefix. example: Internal test prefix maxLength: 1000 addressing_enabled: type: boolean 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. default: false example: true nullable: true addressing_etag: type: string description: A digest of the IP data. Useful for determining if the data has changed. example: a8e453d9d129a3769407127936edfdb0 addressing_full_response: allOf: - $ref: '#/components/schemas/addressing_api-response-single' - type: object properties: result: allOf: - $ref: '#/components/schemas/addressing_address-maps' - type: object properties: ips: $ref: '#/components/schemas/addressing_schemas-ips' memberships: $ref: '#/components/schemas/addressing_memberships' addressing_id_response: allOf: - $ref: '#/components/schemas/addressing_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/addressing_delegation_identifier' addressing_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 addressing_ip: type: string description: An IPv4 or IPv6 address. example: 192.0.2.1 addressing_ip_address: type: string description: An IPv4 or IPv6 address. example: 192.0.2.1 addressing_ipam-bgp-prefixes: type: object 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' addressing_ipam-delegations: type: object 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' addressing_ipam-prefixes: type: object 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' addressing_ips: type: object properties: etag: $ref: '#/components/schemas/addressing_etag' ipv4_cidrs: $ref: '#/components/schemas/addressing_ipv4_cidrs' ipv6_cidrs: $ref: '#/components/schemas/addressing_ipv6_cidrs' addressing_ips_jdcloud: type: object 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' addressing_ipv4_cidrs: type: array description: List of Cloudflare IPv4 CIDR addresses. items: type: string description: IPv4 CIDR. example: 199.27.128.0/21 addressing_ipv6_cidrs: type: array description: List of Cloudflare IPv6 CIDR addresses. items: type: string description: IPv6 CIDR. example: 2400:cb00::/32 addressing_jdcloud_cidrs: type: array description: List IPv4 and IPv6 CIDRs, only populated if `?networks=jdcloud` is used. items: type: string description: IPv4 or IPv6 CIDR. example: 199.27.128.0/21 addressing_kind: type: string description: The type of the membership. enum: - zone - account example: zone addressing_loa_document_identifier: type: string description: Identifier for the uploaded LOA document. example: d933b1530bc56c9953cf8ce166da8004 nullable: true maxLength: 32 addressing_loa_upload_response: allOf: - $ref: '#/components/schemas/addressing_api-response-single' - properties: result: type: object properties: filename: type: string description: Name of LOA document. example: document.pdf addressing_memberships: type: array description: Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership. items: $ref: '#/components/schemas/addressing_address-maps-membership' addressing_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string addressing_modified_at_nullable: type: string format: date-time description: Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled. example: "2014-01-01T05:20:00.12345Z" nullable: true addressing_on_demand_enabled: type: boolean description: Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled. example: true addressing_on_demand_locked: type: boolean description: Whether advertisement status of the prefix is locked, meaning it cannot be changed. example: false addressing_provisioning: type: object description: Status of a Service Binding's deployment to the Cloudflare network properties: state: type: string 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 addressing_response_collection: allOf: - $ref: '#/components/schemas/addressing_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/addressing_ipam-prefixes' addressing_response_collection_bgp: allOf: - $ref: '#/components/schemas/addressing_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/addressing_ipam-bgp-prefixes' addressing_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 addressing_schemas-advertised: type: boolean description: Enablement of prefix advertisement to the Internet. example: true addressing_schemas-can_delete: type: boolean description: Controls whether the membership can be deleted via the API or not. example: true addressing_schemas-description: type: string description: An optional description field which may be used to describe the types of IPs or zones on the map. example: My Ecommerce zones nullable: true addressing_schemas-ips: type: array description: The set of IPs on the Address Map. items: $ref: '#/components/schemas/addressing_address-maps-ip' addressing_schemas-response_collection: allOf: - $ref: '#/components/schemas/addressing_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/addressing_ipam-delegations' addressing_schemas-single_response: allOf: - $ref: '#/components/schemas/addressing_api-response-single' - properties: result: $ref: '#/components/schemas/addressing_ipam-delegations' addressing_service_binding: type: object 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' addressing_service_identifier: type: string description: Identifier example: 2db684ee7ca04e159946fd05b99e1bcd maxLength: 32 addressing_service_name: type: string description: Name of a service running on the Cloudflare network example: Magic Transit 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: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true api-shield_api-response-collection: allOf: - $ref: '#/components/schemas/api-shield_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/api-shield_result_info' type: object api-shield_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/api-shield_messages' messages: $ref: '#/components/schemas/api-shield_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful example: true api-shield_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/api-shield_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/api-shield_messages' example: [] result: type: object nullable: true success: type: boolean description: Whether the API call was successful example: false api-shield_api-response-single: allOf: - $ref: '#/components/schemas/api-shield_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object api-shield_api-shield: allOf: - $ref: '#/components/schemas/api-shield_operation' api-shield_api_discovery_origin: type: string description: | * `ML` - Discovered operation was sourced using ML API Discovery * `SessionIdentifier` - Discovered operation was sourced using Session Identifier API Discovery enum: - ML - SessionIdentifier api-shield_api_discovery_patch_multiple_request: type: object example: 3818d821-5901-4147-a474-f5f5aec1d54e: state: ignored b17c8043-99a0-4202-b7d9-8f7cdbee02cd: state: review api-shield_api_discovery_patch_multiple_request_entry: type: object description: Operation ID to patch state mappings properties: operation_id: $ref: '#/components/schemas/api-shield_uuid' state: $ref: '#/components/schemas/api-shield_api_discovery_state_patch' api-shield_api_discovery_state: type: string 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 api-shield_api_discovery_state_patch: type: string description: | Mark state of operation in API Discovery * `review` - Mark operation as for review * `ignored` - Mark operation as ignored enum: - review - ignored api-shield_auth_id_tokens: type: integer description: The total number of auth-ids seen across this calculation. readOnly: true api-shield_basic_operation: type: object required: - method - host - endpoint properties: endpoint: $ref: '#/components/schemas/api-shield_endpoint' host: $ref: '#/components/schemas/api-shield_host' method: $ref: '#/components/schemas/api-shield_method' api-shield_characteristics: type: array uniqueItems: true maxItems: 10 items: type: object required: - type - name properties: name: $ref: '#/components/schemas/api-shield_name' type: $ref: '#/components/schemas/api-shield_type' api-shield_collection_response: allOf: - $ref: '#/components/schemas/api-shield_api-response-collection' - properties: result: type: array items: allOf: - $ref: '#/components/schemas/api-shield_api-shield' - properties: features: {} api-shield_collection_response_paginated: allOf: - $ref: '#/components/schemas/api-shield_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/api-shield_api-shield' api-shield_configuration: type: object properties: auth_id_characteristics: $ref: '#/components/schemas/api-shield_characteristics' api-shield_data_points: type: integer description: The number of data points used for the threshold suggestion calculation. readOnly: true api-shield_default_response: allOf: - $ref: '#/components/schemas/api-shield_api-response-single' api-shield_discovery_operation: allOf: - required: - id - last_updated - state - origin properties: features: anyOf: - $ref: '#/components/schemas/api-shield_traffic_stats' type: object id: $ref: '#/components/schemas/api-shield_uuid' last_updated: $ref: '#/components/schemas/api-shield_timestamp' origin: type: array description: API discovery engine(s) that discovered this operation items: $ref: '#/components/schemas/api-shield_api_discovery_origin' state: $ref: '#/components/schemas/api-shield_api_discovery_state' - $ref: '#/components/schemas/api-shield_basic_operation' type: object api-shield_endpoint: type: string format: uri-template description: 'The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.' example: /api/v1/users/{var1} maxLength: 4096 pattern: ^/.*$ api-shield_host: type: string format: hostname description: RFC3986-compliant host. example: www.example.com maxLength: 255 api-shield_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 api-shield_kind: type: string description: Kind of schema enum: - openapi_v3 example: openapi_v3 api-shield_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string api-shield_method: type: string description: The HTTP method used to access the endpoint. enum: - GET - POST - HEAD - OPTIONS - PUT - DELETE - CONNECT - PATCH - TRACE example: GET api-shield_name: type: string description: The name of the characteristic field, i.e., the header or cookie name. example: authorization maxLength: 128 api-shield_openapi: type: object description: A OpenAPI 3.0.0 compliant schema. example: info: title: OpenAPI JSON schema for www.example.com version: "1.0" openapi: 3.0.0 paths: '... Further paths ...': {} /api/v1/users/{var1}: get: parameters: - in: path name: var1 required: true schema: type: string servers: - url: www.example.com api-shield_openapiwiththresholds: type: object description: A OpenAPI 3.0.0 compliant schema. example: info: title: OpenAPI JSON schema for www.example.com version: "1.0" openapi: 3.0.0 paths: '... Further paths ...': {} /api/v1/users/{var1}: get: parameters: - in: path name: var1 required: true schema: type: string servers: - url: www.example.com api-shield_operation: allOf: - $ref: '#/components/schemas/api-shield_basic_operation' - required: - operation_id - last_updated properties: features: $ref: '#/components/schemas/api-shield_operation_features' last_updated: $ref: '#/components/schemas/api-shield_timestamp' operation_id: $ref: '#/components/schemas/api-shield_uuid' type: object api-shield_operation_feature_parameter_schemas: type: object readOnly: true required: - parameter_schemas - last_updated properties: parameter_schemas: type: object properties: last_updated: $ref: '#/components/schemas/api-shield_timestamp' parameter_schemas: $ref: '#/components/schemas/api-shield_parameter_schemas_definition' api-shield_operation_feature_thresholds: type: object readOnly: true required: - period_seconds - suggested_threshold - p50 - p90 - p99 - requests - auth_id_tokens - data_points - last_updated properties: thresholds: type: object properties: auth_id_tokens: $ref: '#/components/schemas/api-shield_auth_id_tokens' data_points: $ref: '#/components/schemas/api-shield_data_points' last_updated: $ref: '#/components/schemas/api-shield_timestamp' p50: $ref: '#/components/schemas/api-shield_p50' p90: $ref: '#/components/schemas/api-shield_p90' p99: $ref: '#/components/schemas/api-shield_p99' period_seconds: $ref: '#/components/schemas/api-shield_period_seconds' requests: $ref: '#/components/schemas/api-shield_requests' suggested_threshold: $ref: '#/components/schemas/api-shield_suggested_threshold' api-shield_operation_features: anyOf: - $ref: '#/components/schemas/api-shield_operation_feature_thresholds' - $ref: '#/components/schemas/api-shield_operation_feature_parameter_schemas' type: object readOnly: true api-shield_operation_mitigation_action: type: string 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 - null example: block nullable: true api-shield_operation_schema_validation_settings: type: object properties: mitigation_action: $ref: '#/components/schemas/api-shield_operation_mitigation_action' api-shield_operation_schema_validation_settings_multiple_request: type: object example: 3818d821-5901-4147-a474-f5f5aec1d54e: mitigation_action: log b17c8043-99a0-4202-b7d9-8f7cdbee02cd: mitigation_action: block api-shield_operation_schema_validation_settings_multiple_request_entry: type: object description: Operation ID to mitigation action mappings properties: mitigation_action: $ref: '#/components/schemas/api-shield_operation_mitigation_action' api-shield_p50: type: integer description: The p50 quantile of requests (in period_seconds). readOnly: true api-shield_p90: type: integer description: The p90 quantile of requests (in period_seconds). readOnly: true api-shield_p99: type: integer description: The p99 quantile of requests (in period_seconds). readOnly: true api-shield_parameter_schemas_definition: type: object description: An operation schema object containing a response. example: parameters: - description: Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema. in: path name: var1 required: true schema: maximum: 10 minimum: 1 type: integer responses: null readOnly: true properties: parameters: type: array description: An array containing the learned parameter schemas. example: - description: Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema. in: path name: var1 required: true schema: maximum: 10 minimum: 1 type: integer readOnly: true items: {} responses: type: object description: An empty response object. This field is required to yield a valid operation schema. nullable: true readOnly: true api-shield_patch_discoveries_response: allOf: - $ref: '#/components/schemas/api-shield_api-response-single' - properties: result: $ref: '#/components/schemas/api-shield_api_discovery_patch_multiple_request' api-shield_patch_discovery_response: allOf: - $ref: '#/components/schemas/api-shield_api-response-single' - properties: result: type: object properties: state: $ref: '#/components/schemas/api-shield_api_discovery_state' api-shield_period_seconds: type: integer description: The period over which this threshold is suggested. readOnly: true api-shield_properties: type: array description: Requests information about certain properties. example: - auth_id_characteristics uniqueItems: true items: type: string enum: - auth_id_characteristics example: auth_id_characteristics api-shield_public_schema: type: object required: - schema_id - name - kind - created_at properties: created_at: $ref: '#/components/schemas/api-shield_timestamp' kind: $ref: '#/components/schemas/api-shield_kind' name: type: string description: Name of the schema example: petstore schema schema_id: $ref: '#/components/schemas/api-shield_uuid' source: type: string description: Source of the schema example: validation_enabled: $ref: '#/components/schemas/api-shield_validation_enabled' api-shield_requests: type: integer description: The estimated number of requests covered by these calculations. readOnly: true api-shield_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 api-shield_schema_response_discovery: allOf: - $ref: '#/components/schemas/api-shield_api-response-single' - properties: result: type: object properties: schemas: type: array items: $ref: '#/components/schemas/api-shield_openapi' timestamp: $ref: '#/components/schemas/api-shield_timestamp' api-shield_schema_response_with_thresholds: allOf: - $ref: '#/components/schemas/api-shield_default_response' - properties: result: type: object properties: schemas: type: array items: $ref: '#/components/schemas/api-shield_openapiwiththresholds' timestamp: type: string api-shield_schema_upload_details_errors_critical: type: object properties: critical: type: array description: Diagnostic critical error events that occurred during processing. items: $ref: '#/components/schemas/api-shield_schema_upload_log_event' errors: type: array description: Diagnostic error events that occurred during processing. items: $ref: '#/components/schemas/api-shield_schema_upload_log_event' api-shield_schema_upload_details_warnings_only: type: object properties: warnings: type: array description: Diagnostic warning events that occurred during processing. These events are non-critical errors found within the schema. items: $ref: '#/components/schemas/api-shield_schema_upload_log_event' api-shield_schema_upload_failure: allOf: - properties: upload_details: $ref: '#/components/schemas/api-shield_schema_upload_details_errors_critical' - $ref: '#/components/schemas/api-shield_api-response-common-failure' api-shield_schema_upload_log_event: type: object required: - code properties: code: type: integer description: Code that identifies the event that occurred. example: 28 locations: type: array description: JSONPath location(s) in the schema where these events were encountered. See [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) for JSONPath specification. items: type: string description: JSONPath location in the schema where these events were encountered. See [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) for JSONPath specification. example: .paths["/user/{username}"].put message: type: string description: Diagnostic message that describes the event. example: 'unsupported media type: application/octet-stream' api-shield_schema_upload_response: type: object required: - schema properties: schema: $ref: '#/components/schemas/api-shield_public_schema' upload_details: $ref: '#/components/schemas/api-shield_schema_upload_details_warnings_only' api-shield_schemas-single_response: allOf: - $ref: '#/components/schemas/api-shield_api-response-single' - properties: result: $ref: '#/components/schemas/api-shield_api-shield' api-shield_single_response: allOf: - $ref: '#/components/schemas/api-shield_api-response-single' - properties: result: $ref: '#/components/schemas/api-shield_configuration' api-shield_suggested_threshold: type: integer description: The suggested threshold in requests done by the same auth_id or period_seconds. readOnly: true api-shield_timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true api-shield_traffic_stats: type: object readOnly: true properties: traffic_stats: type: object required: - period_seconds - requests - last_updated properties: last_updated: $ref: '#/components/schemas/api-shield_timestamp' period_seconds: type: integer description: The period in seconds these statistics were computed over example: 3600 readOnly: true requests: type: number format: float description: The average number of requests seen during this period example: 1987.06 readOnly: true api-shield_type: type: string description: The type of characteristic. enum: - header - cookie example: header api-shield_uuid: type: string format: uuid description: UUID identifier example: 0d9bf70c-92e1-4bb3-9411-34a3bcc59003 readOnly: true minLength: 36 maxLength: 36 api-shield_validation_default_mitigation_action: type: string 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 api-shield_validation_default_mitigation_action_patch: type: string description: | The default mitigation action used when there is no mitigation action defined on the operation 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 - null example: block nullable: true api-shield_validation_enabled: type: boolean description: Flag whether schema is enabled for validation. api-shield_validation_override_mitigation_action: type: string 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 - null example: disable_override nullable: true api-shield_validation_override_mitigation_action_patch: type: string 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 - null example: none nullable: true api-shield_validation_override_mitigation_action_write: type: string 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 - null example: none nullable: true api-shield_zone_schema_validation_settings: type: object properties: validation_default_mitigation_action: $ref: '#/components/schemas/api-shield_validation_default_mitigation_action' validation_override_mitigation_action: $ref: '#/components/schemas/api-shield_validation_override_mitigation_action' api-shield_zone_schema_validation_settings_patch: type: object properties: validation_default_mitigation_action: $ref: '#/components/schemas/api-shield_validation_default_mitigation_action_patch' validation_override_mitigation_action: $ref: '#/components/schemas/api-shield_validation_override_mitigation_action_patch' api-shield_zone_schema_validation_settings_put: type: object required: - validation_default_mitigation_action properties: validation_default_mitigation_action: $ref: '#/components/schemas/api-shield_validation_default_mitigation_action' validation_override_mitigation_action: $ref: '#/components/schemas/api-shield_validation_override_mitigation_action_write' argo-analytics_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/argo-analytics_messages' messages: $ref: '#/components/schemas/argo-analytics_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true argo-analytics_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/argo-analytics_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/argo-analytics_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false argo-analytics_api-response-single: allOf: - $ref: '#/components/schemas/argo-analytics_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object argo-analytics_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 argo-analytics_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string argo-analytics_response_single: allOf: - $ref: '#/components/schemas/argo-analytics_api-response-single' - type: object properties: result: type: object argo-config_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/argo-config_messages' messages: $ref: '#/components/schemas/argo-config_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true argo-config_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/argo-config_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/argo-config_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false argo-config_api-response-single: allOf: - $ref: '#/components/schemas/argo-config_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object argo-config_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 argo-config_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string argo-config_patch: type: object description: Update enablement of Argo Smart Routing required: - value properties: value: $ref: '#/components/schemas/argo-config_value' argo-config_response_single: allOf: - $ref: '#/components/schemas/argo-config_api-response-single' - type: object properties: result: type: object argo-config_value: type: string description: Enables Argo Smart Routing. enum: - "on" - "off" example: "on" bill-subs-api_account_identifier: {} bill-subs-api_account_subscription_response_collection: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/bill-subs-api_subscription' bill-subs-api_account_subscription_response_single: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-single' - type: object properties: result: type: object bill-subs-api_action: type: string description: The billing item action. example: subscription readOnly: true maxLength: 30 bill-subs-api_amount: type: number description: The amount associated with this billing item. example: 20.99 readOnly: true bill-subs-api_api-response-collection: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/bill-subs-api_result_info' type: object bill-subs-api_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/bill-subs-api_messages' messages: $ref: '#/components/schemas/bill-subs-api_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true bill-subs-api_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/bill-subs-api_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/bill-subs-api_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false bill-subs-api_api-response-single: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object bill-subs-api_available-rate-plan: type: object properties: can_subscribe: $ref: '#/components/schemas/bill-subs-api_can_subscribe' currency: $ref: '#/components/schemas/bill-subs-api_currency' externally_managed: $ref: '#/components/schemas/bill-subs-api_externally_managed' frequency: $ref: '#/components/schemas/bill-subs-api_schemas-frequency' id: $ref: '#/components/schemas/bill-subs-api_identifier' is_subscribed: $ref: '#/components/schemas/bill-subs-api_is_subscribed' legacy_discount: $ref: '#/components/schemas/bill-subs-api_legacy_discount' legacy_id: $ref: '#/components/schemas/bill-subs-api_legacy_id' name: $ref: '#/components/schemas/bill-subs-api_schemas-name' price: $ref: '#/components/schemas/bill-subs-api_schemas-price' bill-subs-api_billing-history: type: object required: - id - type - action - description - occurred_at - amount - currency - zone 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' bill-subs-api_billing_history_collection: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/bill-subs-api_billing-history' bill-subs-api_billing_response_single: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-single' - type: object properties: result: type: object bill-subs-api_can_subscribe: type: boolean description: Indicates whether you can subscribe to this plan. default: false example: true bill-subs-api_component-value: type: object properties: default: $ref: '#/components/schemas/bill-subs-api_default' name: $ref: '#/components/schemas/bill-subs-api_components-schemas-name' unit_price: $ref: '#/components/schemas/bill-subs-api_unit_price' bill-subs-api_component_value: type: object description: A component value for a subscription. properties: default: type: number description: The default amount assigned. example: 5 name: type: string description: The name of the component value. example: page_rules price: type: number description: The unit price for the component value. example: 5 value: type: number description: The amount of the component value assigned. example: 20 bill-subs-api_component_values: type: array description: The list of add-ons subscribed to. items: $ref: '#/components/schemas/bill-subs-api_component_value' bill-subs-api_components-schemas-identifier: type: string description: Billing item identifier tag. example: b69a9f3492637782896352daae219e7d readOnly: true maxLength: 32 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: type: string description: The monetary unit in which pricing information is displayed. example: USD readOnly: true bill-subs-api_current_period_end: type: string format: date-time description: The end of the current period and also when the next billing is due. example: "2014-03-31T12:20:00Z" readOnly: true bill-subs-api_current_period_start: type: string format: date-time description: When the current billing period started. May match initial_period_start if this is the first period. example: "2014-05-11T12:20:00Z" readOnly: true bill-subs-api_default: type: number description: The default amount allocated. example: 5 bill-subs-api_description: type: string description: The billing item description. example: The billing item description readOnly: true maxLength: 255 bill-subs-api_duration: type: number description: The duration of the plan subscription. example: 1 bill-subs-api_externally_managed: type: boolean description: Indicates whether this plan is managed externally. default: false example: false bill-subs-api_frequency: type: string description: How often the subscription is renewed automatically. enum: - weekly - monthly - quarterly - yearly example: monthly bill-subs-api_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 bill-subs-api_install_id: type: string description: app install id. bill-subs-api_is_subscribed: type: boolean description: Indicates whether you are currently subscribed to this plan. default: false example: false bill-subs-api_legacy_discount: type: boolean description: Indicates whether this plan has a legacy discount applied. default: false example: false bill-subs-api_legacy_id: type: string description: The legacy identifier for this rate plan, if any. example: free readOnly: true bill-subs-api_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string bill-subs-api_name: type: string description: The domain name example: example.com readOnly: true maxLength: 253 pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$ bill-subs-api_occurred_at: type: string format: date-time description: When the billing item was created. example: "2014-03-01T12:21:59.3456Z" readOnly: true bill-subs-api_plan_response_collection: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/bill-subs-api_schemas-rate-plan' bill-subs-api_price: type: number description: The price of the subscription that will be billed, in US dollars. example: 20 readOnly: true bill-subs-api_rate-plan: type: object properties: components: $ref: '#/components/schemas/bill-subs-api_schemas-component_values' currency: $ref: '#/components/schemas/bill-subs-api_currency' duration: $ref: '#/components/schemas/bill-subs-api_duration' frequency: $ref: '#/components/schemas/bill-subs-api_schemas-frequency' id: $ref: '#/components/schemas/bill-subs-api_rate-plan_components-schemas-identifier' name: $ref: '#/components/schemas/bill-subs-api_schemas-name' bill-subs-api_rate-plan_components-schemas-identifier: type: string description: Plan identifier tag. example: free readOnly: true bill-subs-api_rate_plan: type: object description: The rate plan applied to the subscription. properties: currency: type: string description: The currency applied to the rate plan subscription. example: USD externally_managed: type: boolean description: Whether this rate plan is managed externally from Cloudflare. example: false id: description: The ID of the rate plan. example: free is_contract: type: boolean description: Whether a rate plan is enterprise-based (or newly adopted term contract). example: false public_name: type: string description: The full name of the rate plan. example: Business Plan scope: type: string description: The scope that this rate plan applies to. example: zone sets: type: array description: The list of sets this rate plan applies to. items: type: string bill-subs-api_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 bill-subs-api_schemas-component_values: type: array description: Array of available components values for the plan. items: $ref: '#/components/schemas/bill-subs-api_component-value' bill-subs-api_schemas-frequency: type: string description: The frequency at which you will be billed for this plan. enum: - weekly - monthly - quarterly - yearly example: monthly readOnly: true bill-subs-api_schemas-identifier: type: string description: Subscription identifier tag. example: 506e3185e9c882d175a2d0cb0093d9f2 readOnly: true maxLength: 32 bill-subs-api_schemas-name: type: string description: The plan name. example: Free Plan readOnly: true maxLength: 80 bill-subs-api_schemas-price: type: number description: The amount you will be billed for this plan. example: 0 bill-subs-api_schemas-rate-plan: allOf: - $ref: '#/components/schemas/bill-subs-api_rate-plan' type: object bill-subs-api_schemas-zone: type: object properties: name: readOnly: true bill-subs-api_state: type: string description: The state that the subscription is in. enum: - Trial - Provisioned - Paid - AwaitingPayment - Cancelled - Failed - Expired example: Paid readOnly: true bill-subs-api_subscription: allOf: - $ref: '#/components/schemas/bill-subs-api_subscription-v2' type: object bill-subs-api_subscription-v2: type: object properties: app: properties: install_id: $ref: '#/components/schemas/bill-subs-api_install_id' component_values: $ref: '#/components/schemas/bill-subs-api_component_values' currency: $ref: '#/components/schemas/bill-subs-api_currency' current_period_end: $ref: '#/components/schemas/bill-subs-api_current_period_end' current_period_start: $ref: '#/components/schemas/bill-subs-api_current_period_start' frequency: $ref: '#/components/schemas/bill-subs-api_frequency' id: $ref: '#/components/schemas/bill-subs-api_schemas-identifier' price: $ref: '#/components/schemas/bill-subs-api_price' rate_plan: $ref: '#/components/schemas/bill-subs-api_rate_plan' state: $ref: '#/components/schemas/bill-subs-api_state' zone: $ref: '#/components/schemas/bill-subs-api_zone' bill-subs-api_type: type: string description: The billing item type. example: charge readOnly: true maxLength: 30 bill-subs-api_unit_price: type: number description: The unit price of the addon. example: 1 readOnly: true bill-subs-api_user_subscription_response_collection: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/bill-subs-api_subscription' bill-subs-api_user_subscription_response_single: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-single' - type: object properties: result: type: object bill-subs-api_zone: type: object description: A simple zone object. May have null properties if not a zone subscription. properties: id: $ref: '#/components/schemas/bill-subs-api_identifier' name: $ref: '#/components/schemas/bill-subs-api_name' bill-subs-api_zone_subscription_response_single: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-single' - type: object properties: result: type: object bot-management_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/bot-management_messages' messages: $ref: '#/components/schemas/bot-management_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true bot-management_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/bot-management_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/bot-management_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false bot-management_api-response-single: allOf: - $ref: '#/components/schemas/bot-management_api-response-common' - properties: result: anyOf: - type: object - type: string type: object bot-management_auto_update_model: type: boolean description: Automatically update to the newest bot detection models created by Cloudflare as they are released. [Learn more.](https://developers.cloudflare.com/bots/reference/machine-learning-models#model-versions-and-release-notes) example: true bot-management_base_config: allOf: - properties: enable_js: $ref: '#/components/schemas/bot-management_enable_js' using_latest_model: $ref: '#/components/schemas/bot-management_using_latest_model' title: Shared Config 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' - type: object properties: result: oneOf: - $ref: '#/components/schemas/bot-management_bot_fight_mode_config' - $ref: '#/components/schemas/bot-management_sbfm_definitely_config' - $ref: '#/components/schemas/bot-management_sbfm_likely_config' - $ref: '#/components/schemas/bot-management_bm_subscription_config' 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: type: boolean description: Use lightweight, invisible JavaScript detections to improve Bot Management. [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). example: true bot-management_fight_mode: type: boolean description: Whether to enable Bot Fight Mode. example: true bot-management_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 bot-management_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string bot-management_optimize_wordpress: type: boolean description: Whether to optimize Super Bot Fight Mode protections for Wordpress. example: true bot-management_sbfm_definitely_automated: type: string description: Super Bot Fight Mode (SBFM) action to take on definitely automated requests. enum: - allow - block - managed_challenge example: allow 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: type: string description: Super Bot Fight Mode (SBFM) action to take on likely automated requests. enum: - allow - block - managed_challenge example: allow 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: type: boolean description: | Super Bot Fight Mode (SBFM) to enable static resource protection. Enable if static resources on your application need bot protection. Note: Static resource protection can also result in legitimate traffic being blocked. example: true bot-management_sbfm_verified_bots: type: string description: Super Bot Fight Mode (SBFM) action to take on verified bots requests. enum: - allow - block example: allow bot-management_suppress_session_score: type: boolean description: Whether to disable tracking the highest bot score for a session in the Bot Management cookie. example: false bot-management_using_latest_model: type: boolean description: | A read-only field that indicates whether the zone currently is running the latest ML model. example: true readOnly: true cache-purge_Everything: type: object properties: purge_everything: type: boolean cache-purge_File: type: string example: http://www.example.com/css/styles.css cache-purge_Files: type: object properties: files: type: array items: anyOf: - $ref: '#/components/schemas/cache-purge_File' - $ref: '#/components/schemas/cache-purge_UrlAndHeaders' cache-purge_Flex: anyOf: - $ref: '#/components/schemas/cache-purge_Tags' - $ref: '#/components/schemas/cache-purge_Hosts' - $ref: '#/components/schemas/cache-purge_Prefixes' cache-purge_Hosts: type: object properties: hosts: type: array example: - www.example.com - images.example.com items: type: string cache-purge_Prefixes: type: object properties: prefixes: type: array example: - www.example.com/foo - images.example.com/bar/baz items: type: string cache-purge_Tags: type: object properties: tags: type: array example: - some-tag - another-tag items: type: string cache-purge_UrlAndHeaders: type: object properties: headers: type: object example: |- { "Origin": "https://www.cloudflare.com", "CF-IPCountry": "US", "CF-Device-Type": "desktop", "Accept-Language": "zh-CN" } url: type: string example: http://www.example.com/cat_picture.jpg cache-purge_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/cache-purge_messages' messages: $ref: '#/components/schemas/cache-purge_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true cache-purge_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/cache-purge_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/cache-purge_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false cache-purge_api-response-single-id: allOf: - $ref: '#/components/schemas/cache-purge_api-response-common' - properties: result: type: object nullable: true required: - id properties: id: $ref: '#/components/schemas/cache-purge_schemas-identifier' type: object cache-purge_identifier: type: string cache-purge_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string cache-purge_schemas-identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 cache_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/cache_messages' messages: $ref: '#/components/schemas/cache_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true cache_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/cache_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/cache_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false cache_api-response-single: allOf: - $ref: '#/components/schemas/cache_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object cache_base: required: - id - modified_on properties: id: type: string description: Identifier of the zone setting. modified_on: type: string format: date-time description: last time this setting was modified. example: "2014-01-01T05:20:00.12345Z" nullable: true readOnly: true cache_cache_reserve: allOf: - $ref: '#/components/schemas/cache_base' - properties: id: description: ID of the zone setting. enum: - cache_reserve example: cache_reserve title: Cache Reserve description: 'Increase cache lifetimes by automatically storing all cacheable files into Cloudflare''s persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.' cache_cache_reserve_clear: allOf: - $ref: '#/components/schemas/cache_base' - properties: id: description: ID of the zone setting. enum: - cache_reserve_clear example: cache_reserve_clear title: Cache Reserve Clear description: You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation. cache_cache_reserve_clear_end_ts: type: string format: date-time description: The time that the latest Cache Reserve Clear operation completed. example: "2023-10-02T12:00:00.12345Z" cache_cache_reserve_clear_post_request_body: type: string description: The POST request body does not carry any information. example: '{}' cache_cache_reserve_clear_response_value: properties: result: allOf: - $ref: '#/components/schemas/cache_cache_reserve_clear' - required: - state - start_ts properties: end_ts: $ref: '#/components/schemas/cache_cache_reserve_clear_end_ts' start_ts: $ref: '#/components/schemas/cache_cache_reserve_clear_start_ts' state: $ref: '#/components/schemas/cache_cache_reserve_clear_state' cache_cache_reserve_clear_start_ts: type: string format: date-time description: The time that the latest Cache Reserve Clear operation started. example: "2023-10-02T10:00:00.12345Z" cache_cache_reserve_clear_state: type: string description: The current state of the Cache Reserve Clear operation. enum: - In-progress - Completed example: In-progress cache_cache_reserve_response_value: properties: result: allOf: - $ref: '#/components/schemas/cache_cache_reserve' - required: - value properties: value: $ref: '#/components/schemas/cache_cache_reserve_value' cache_cache_reserve_value: type: string description: Value of the Cache Reserve zone setting. enum: - "on" - "off" default: "off" cache_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 cache_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string cache_origin_max_http_version: allOf: - $ref: '#/components/schemas/cache_base' - properties: id: description: Value of the zone setting. enum: - origin_max_http_version example: origin_max_http_version title: Origin Max HTTP Version description: Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except ENT where it is "1" cache_origin_max_http_version_response_value: properties: result: allOf: - $ref: '#/components/schemas/cache_origin_max_http_version' - required: - value properties: value: $ref: '#/components/schemas/cache_origin_max_http_version_value' cache_origin_max_http_version_value: type: string description: Value of the Origin Max HTTP Version Setting. enum: - "2" - "1" 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 title: Origin Post-Quantum Encryption 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 cache_origin_post_quantum_encryption_response_value: properties: result: allOf: - $ref: '#/components/schemas/cache_origin_post_quantum_encryption' - required: - value properties: value: $ref: '#/components/schemas/cache_origin_post_quantum_encryption' cache_origin_post_quantum_encryption_value: type: string description: Value of the Origin Post Quantum Encryption Setting. enum: - preferred - supported - "off" default: supported cache_patch: type: object description: Update enablement of Tiered Caching required: - value properties: value: $ref: '#/components/schemas/cache_value' cache_regional_tiered_cache: allOf: - $ref: '#/components/schemas/cache_base' - properties: id: description: ID of the zone setting. enum: - tc_regional example: tc_regional title: Regional Tiered Cache description: Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies. cache_regional_tiered_cache_response_value: properties: result: allOf: - $ref: '#/components/schemas/cache_regional_tiered_cache' - required: - value properties: value: $ref: '#/components/schemas/cache_regional_tiered_cache' cache_regional_tiered_cache_value: type: string description: Value of the Regional Tiered Cache zone setting. enum: - "on" - "off" default: "off" cache_response_single: allOf: - $ref: '#/components/schemas/cache_api-response-single' - type: object properties: result: type: object cache_schemas-patch: type: object description: Update enablement of Smart Tiered Cache required: - value properties: value: $ref: '#/components/schemas/cache_schemas-value' cache_schemas-value: type: string description: Enables Tiered Cache. enum: - "on" - "off" example: "on" cache_value: type: string description: Enables Tiered Caching. enum: - "on" - "off" example: "on" cache_variants: allOf: - $ref: '#/components/schemas/cache_base' - properties: id: description: ID of the zone setting. enum: - variants example: variants title: Variants Caching description: 'Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ''Vary: Accept'' response header. If the origin server sends ''Vary: Accept'' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.' cache_variants_response_value: properties: result: allOf: - $ref: '#/components/schemas/cache_variants' - required: - value properties: value: $ref: '#/components/schemas/cache_variants_value' cache_variants_value: type: object description: Value of the zone setting. properties: avif: type: array description: List of strings with the MIME types of all the variants that should be served for avif. example: - image/webp - image/jpeg uniqueItems: true items: type: string bmp: type: array description: List of strings with the MIME types of all the variants that should be served for bmp. example: - image/webp - image/jpeg uniqueItems: true items: type: string gif: type: array description: List of strings with the MIME types of all the variants that should be served for gif. example: - image/webp - image/jpeg uniqueItems: true items: type: string jp2: type: array description: List of strings with the MIME types of all the variants that should be served for jp2. example: - image/webp - image/avif uniqueItems: true items: type: string jpeg: type: array description: List of strings with the MIME types of all the variants that should be served for jpeg. example: - image/webp - image/avif uniqueItems: true items: type: string jpg: type: array description: List of strings with the MIME types of all the variants that should be served for jpg. example: - image/webp - image/avif uniqueItems: true items: type: string jpg2: type: array description: List of strings with the MIME types of all the variants that should be served for jpg2. example: - image/webp - image/avif uniqueItems: true items: type: string png: type: array description: List of strings with the MIME types of all the variants that should be served for png. example: - image/webp - image/avif uniqueItems: true items: type: string tif: type: array description: List of strings with the MIME types of all the variants that should be served for tif. example: - image/webp - image/avif uniqueItems: true items: type: string tiff: type: array description: List of strings with the MIME types of all the variants that should be served for tiff. example: - image/webp - image/avif uniqueItems: true items: type: string webp: type: array description: List of strings with the MIME types of all the variants that should be served for webp. example: - image/jpeg - image/avif uniqueItems: true items: type: string cache_zone_cache_settings_response_single: allOf: - $ref: '#/components/schemas/cache_api-response-single' - properties: result: type: object calls_account_identifier: type: string description: The account identifier tag. example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 calls_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/calls_messages' messages: $ref: '#/components/schemas/calls_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true calls_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false calls_api-response-single: allOf: - $ref: '#/components/schemas/calls_api-response-common' - properties: result: anyOf: - type: object - type: string type: object calls_app: type: object 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' calls_app_editable_fields: type: object properties: name: $ref: '#/components/schemas/calls_name' calls_app_response_collection: allOf: - $ref: '#/components/schemas/calls_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/calls_app' 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: type: object 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' calls_created: type: string format: date-time description: The date and time the item was created. example: "2014-01-02T02:20:00Z" calls_identifier: type: string description: A Cloudflare-generated unique identifier for a item. example: 2a95132c15732412d22c1476fa83f27a minLength: 32 maxLength: 32 calls_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string calls_modified: type: string format: date-time description: The date and time the item was last modified. example: "2014-01-02T02:20:00Z" calls_name: type: string description: A short description of Calls app, not shown to end users. default: "" example: production-realtime-app calls_secret: type: string description: Bearer token to use the Calls API. example: 66bcf64aa8907b9f9d90ac17746a77ce394c393b92b3916633dc02846e608ad4 minLength: 64 maxLength: 64 cloudforce-one_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/cloudforce-one_messages' messages: $ref: '#/components/schemas/cloudforce-one_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true cloudforce-one_api-response-common-failure: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: errors: example: code: 10433 message: request error success: example: false cloudforce-one_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 cloudforce-one_labels: type: array title: Labels description: List of labels example: - DoS - CVE items: type: string cloudforce-one_message-content: type: string description: Content of message example: Can you elaborate on the type of DoS that occurred? cloudforce-one_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string cloudforce-one_priority: type: string title: Request Priority enum: - routine - high - urgent cloudforce-one_priority-edit: type: object title: Priority Editable Attributes required: - labels - priority - requirement - tlp properties: labels: $ref: '#/components/schemas/cloudforce-one_labels' priority: type: integer description: Priority example: 1 requirement: type: string description: Requirement example: DoS attacks carried out by CVEs tlp: $ref: '#/components/schemas/cloudforce-one_tlp' cloudforce-one_priority-item: type: object title: Priority Item required: - id - created - updated - labels - priority - requirement - tlp 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: type: integer description: Priority example: 1 requirement: type: string description: Requirement example: DoS attacks carried out by CVEs tlp: $ref: '#/components/schemas/cloudforce-one_tlp' updated: allOf: - $ref: '#/components/schemas/cloudforce-one_time' - description: Priority last updated time cloudforce-one_priority-list: type: object title: Priority List Parameters required: - page - per_page properties: page: type: integer description: Page number of results per_page: type: integer description: Number of results per page example: 10 cloudforce-one_quota: type: object title: 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: type: integer description: Tokens for the quarter example: 120 remaining: type: integer description: Tokens remaining for the quarter example: 64 cloudforce-one_request-constants: type: object title: Request Constants properties: priority: type: array example: - routine - high - urgent items: $ref: '#/components/schemas/cloudforce-one_priority' status: type: array example: - open - accepted - reported - approved - completed - declined items: $ref: '#/components/schemas/cloudforce-one_request-status' tlp: type: array example: - clear - green - amber - amber-strict - red items: $ref: '#/components/schemas/cloudforce-one_tlp' cloudforce-one_request-content: type: string description: Request content example: What regions were most effected by the recent DoS? cloudforce-one_request-edit: type: object title: Request Editable Parameters properties: content: $ref: '#/components/schemas/cloudforce-one_request-content' priority: type: string description: Priority for analyzing the request example: routine request_type: $ref: '#/components/schemas/cloudforce-one_request-type' summary: $ref: '#/components/schemas/cloudforce-one_request-summary' tlp: $ref: '#/components/schemas/cloudforce-one_tlp' cloudforce-one_request-item: type: object title: Request Item required: - id - created - updated - content - priority - request - summary - tlp 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: type: integer description: Tokens for the request messages example: 1 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: type: integer description: Tokens for the request example: 16 updated: $ref: '#/components/schemas/cloudforce-one_time' cloudforce-one_request-list: type: object title: Request List Parameters required: - page - per_page 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: type: integer description: Page number of results per_page: type: integer description: Number of results per page example: 10 request_type: $ref: '#/components/schemas/cloudforce-one_request-type' sort_by: type: string description: Field to sort results by example: created sort_order: type: string description: Sort order (asc or desc) enum: - asc - desc status: $ref: '#/components/schemas/cloudforce-one_request-status' cloudforce-one_request-list-item: type: object title: Request List Item required: - id - created - updated - priority - request - summary - tlp 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: type: integer description: Tokens for the request messages example: 16 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: type: integer description: Tokens for the request updated: allOf: - $ref: '#/components/schemas/cloudforce-one_time' - description: Request last updated time - example: "2022-04-01T00:00:00Z" cloudforce-one_request-message-edit: type: object title: Request Message Editable Attributes properties: content: $ref: '#/components/schemas/cloudforce-one_message-content' cloudforce-one_request-message-item: type: object title: Request Message Item required: - id - updated - content - author - is_follow_on_request properties: author: type: string description: Author of message example: user@domain.com 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: type: integer description: Message ID is_follow_on_request: type: boolean description: Message is a follow-on request updated: allOf: - $ref: '#/components/schemas/cloudforce-one_time' - description: Message last updated time - example: "2022-01-01T00:00:00Z" cloudforce-one_request-message-list: type: object title: Request Message List Parameters required: - page - per_page 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: type: integer description: Page number of results per_page: type: integer description: Number of results per page example: 10 sort_by: type: string description: Field to sort results by example: created sort_order: type: string description: Sort order (asc or desc) enum: - asc - desc cloudforce-one_request-readable-id: type: string title: Request Readable ID description: Readable Request ID example: RFI-2022-000001 cloudforce-one_request-status: type: string title: Request Status description: Request Status enum: - open - accepted - reported - approved - completed - declined cloudforce-one_request-summary: type: string description: Brief description of the request example: DoS attack cloudforce-one_request-type: type: string description: Requested information from request example: Victomology cloudforce-one_request-types: type: array title: Request Types example: - Indicators of Compromise - Victomology items: type: string description: Request Types cloudforce-one_time: type: string format: date-time example: "2022-04-01T05:20:00Z" cloudforce-one_tlp: type: string title: TLP description: The CISA defined Traffic Light Protocol (TLP) enum: - clear - amber - amber-strict - green - red cloudforce-one_uuid: type: string description: UUID example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 readOnly: true maxLength: 36 custom-indicator-feeds_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/custom-indicator-feeds_messages' messages: $ref: '#/components/schemas/custom-indicator-feeds_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true custom-indicator-feeds_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false custom-indicator-feeds_api-response-single: allOf: - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common' - properties: result: anyOf: - type: object - type: string 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: type: string description: The description of the example test custom-indicator-feeds_feed_id: type: integer description: Indicator feed ID example: 12 custom-indicator-feeds_id: type: integer description: The unique identifier for the indicator feed custom-indicator-feeds_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 custom-indicator-feeds_indicator_feed_item: example: created_on: "2023-05-12T12:21:56.777653Z" description: example feed description id: 1 modified_on: "2023-06-18T03:13:34.123321Z" name: example_feed_1 properties: created_on: type: string format: date-time description: The date and time when the data entry was created description: $ref: '#/components/schemas/custom-indicator-feeds_description' id: $ref: '#/components/schemas/custom-indicator-feeds_id' modified_on: type: string format: date-time description: The date and time when the data entry was last modified 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 latest_upload_status: Complete modified_on: "2023-06-18T03:13:34.123321Z" name: example_feed_1 properties: created_on: type: string format: date-time description: The date and time when the data entry was created description: $ref: '#/components/schemas/custom-indicator-feeds_description' id: $ref: '#/components/schemas/custom-indicator-feeds_id' latest_upload_status: type: string description: Status of the latest snapshot uploaded enum: - Mirroring - Unifying - Loading - Provisioning - Complete - Error modified_on: type: string format: date-time description: The date and time when the data entry was last modified name: $ref: '#/components/schemas/custom-indicator-feeds_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: type: array 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' 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_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string custom-indicator-feeds_name: type: string description: The name of the indicator feed custom-indicator-feeds_permission_list_item: properties: description: $ref: '#/components/schemas/custom-indicator-feeds_description' id: $ref: '#/components/schemas/custom-indicator-feeds_id' 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: type: array example: - description: An important indicator list id: 1 name: indicator_list_1 - description: An even more important indicator list id: 2 name: indicator_list_2 items: $ref: '#/components/schemas/custom-indicator-feeds_permission_list_item' custom-indicator-feeds_permissions-request: properties: account_tag: type: string description: The Cloudflare account tag of the account to change permissions on example: 823f45f16fd2f7e21e1e054aga4d2859 feed_id: type: integer description: The ID of the feed to add/remove permissions on example: 1 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: type: boolean description: Whether the update succeeded or not custom-indicator-feeds_update_feed: properties: file_id: type: integer description: Feed id example: 1 filename: type: string description: Name of the file unified in our system example: snapshot_file.unified status: type: string description: Current status of upload, should be unified example: unified 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-pages_api-response-collection: allOf: - $ref: '#/components/schemas/custom-pages_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/custom-pages_result_info' type: object custom-pages_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/custom-pages_messages' messages: $ref: '#/components/schemas/custom-pages_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true custom-pages_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/custom-pages_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/custom-pages_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false 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: type: array items: type: object custom-pages_custom_pages_response_single: allOf: - $ref: '#/components/schemas/custom-pages_api-response-single' - properties: result: type: object custom-pages_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 custom-pages_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string custom-pages_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 custom-pages_state: type: string description: The custom page state. enum: - default - customized example: default custom-pages_url: type: string format: uri description: The URL associated with the custom page. default: "" example: http://www.example.com d1_account-identifier: type: string description: Account identifier tag. example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 d1_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/d1_messages' messages: $ref: '#/components/schemas/d1_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true d1_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false d1_api-response-single: allOf: - $ref: '#/components/schemas/d1_api-response-common' - properties: result: anyOf: - type: object - type: string type: object d1_create-database-response: type: object properties: created_at: description: Specifies the timestamp the resource was created as an ISO8601 string. example: "2022-11-15T18:25:44.442097Z" readOnly: true name: $ref: '#/components/schemas/d1_database-name' uuid: $ref: '#/components/schemas/d1_database-identifier' version: $ref: '#/components/schemas/d1_database-version' d1_database-details-response: type: object properties: created_at: description: Specifies the timestamp the resource was created as an ISO8601 string. example: "2022-11-15T18:25:44.442097Z" readOnly: true 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' d1_database-identifier: type: string example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx d1_database-name: type: string example: my-database pattern: ^[a-z0-9][a-z0-9-_]*$ d1_database-version: type: string example: production pattern: ^(alpha|beta|production)$ d1_deleted_response: allOf: - $ref: '#/components/schemas/d1_api-response-single' - properties: result: type: object example: {} d1_file-size: type: number description: The D1 database's size, in bytes. example: 12 d1_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string d1_params: type: array example: - firstParam - secondParam items: type: string d1_query-meta: type: object 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 d1_query-result-response: type: object properties: meta: $ref: '#/components/schemas/d1_query-meta' results: type: array items: type: object success: type: boolean d1_sql: type: string example: SELECT * FROM myTable WHERE field = ? OR field = ?; d1_table-count: type: number example: 12 data-zone-analytics-api_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/data-zone-analytics-api_messages' messages: $ref: '#/components/schemas/data-zone-analytics-api_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true data-zone-analytics-api_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false data-zone-analytics-api_api-response-single: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object data-zone-analytics-api_bandwidth: type: object description: Breakdown of totals for bandwidth in the form of bytes. properties: all: type: integer description: The total number of bytes served within the time frame. cached: type: integer description: The number of bytes that were cached (and served) by Cloudflare. content_type: type: object description: A variable list of key/value pairs where the key represents the type of content served, and the value is the number in bytes served. example: css: 237421 gif: 1.234242e+06 html: 1.23129e+06 javascript: 123245 jpeg: 784278 country: type: object description: A variable list of key/value pairs where the key is a two-digit country code and the value is the number of bytes served to that country. example: AG: 2.342483e+06 GI: 984753 US: 1.23145433e+08 ssl: type: object description: A break down of bytes served over HTTPS. properties: encrypted: type: integer description: The number of bytes served over HTTPS. unencrypted: type: integer description: The number of bytes served over HTTP. ssl_protocols: type: object description: A breakdown of requests by their SSL protocol. properties: TLSv1: type: integer description: The number of requests served over TLS v1.0. TLSv1.1: type: integer description: The number of requests served over TLS v1.1. TLSv1.2: type: integer description: The number of requests served over TLS v1.2. TLSv1.3: type: integer description: The number of requests served over TLS v1.3. none: type: integer description: The number of requests served over HTTP. uncached: type: integer description: The number of bytes that were fetched and served from the origin server. data-zone-analytics-api_bandwidth_by_colo: type: object description: Breakdown of totals for bandwidth in the form of bytes. properties: all: type: integer description: The total number of bytes served within the time frame. cached: type: integer description: The number of bytes that were cached (and served) by Cloudflare. uncached: type: integer description: The number of bytes that were fetched and served from the origin server. data-zone-analytics-api_colo_response: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_api-response-single' - properties: query: $ref: '#/components/schemas/data-zone-analytics-api_query_response' result: $ref: '#/components/schemas/data-zone-analytics-api_datacenters' data-zone-analytics-api_dashboard: type: object title: Dashboard response description: Totals and timeseries data. properties: timeseries: $ref: '#/components/schemas/data-zone-analytics-api_timeseries' totals: $ref: '#/components/schemas/data-zone-analytics-api_totals' data-zone-analytics-api_dashboard_response: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_api-response-single' - properties: query: $ref: '#/components/schemas/data-zone-analytics-api_query_response' result: $ref: '#/components/schemas/data-zone-analytics-api_dashboard' data-zone-analytics-api_datacenters: type: array title: Analytics data by datacenter description: A breakdown of all dashboard analytics data by co-locations. This is limited to Enterprise zones only. items: type: object properties: colo_id: type: string description: The airport code identifer for the co-location. example: SFO timeseries: $ref: '#/components/schemas/data-zone-analytics-api_timeseries_by_colo' totals: $ref: '#/components/schemas/data-zone-analytics-api_totals_by_colo' data-zone-analytics-api_end: anyOf: - type: string - type: integer description: Sets the (exclusive) end of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. `end` must be at least five minutes earlier than now and must be later than `start`. Difference between `start` and `end` must be not greater than one hour. example: "2018-05-20T10:01:00Z" data-zone-analytics-api_fields_response: type: object properties: key: type: string example: value data-zone-analytics-api_flag: type: boolean description: The log retention flag for Logpull API. example: true data-zone-analytics-api_flag_response: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_api-response-single' - properties: result: type: object properties: flag: type: boolean example: true data-zone-analytics-api_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 data-zone-analytics-api_logs: anyOf: - type: string - type: object example: |- {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000} {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000} {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000} data-zone-analytics-api_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string data-zone-analytics-api_pageviews: type: object description: Breakdown of totals for pageviews. properties: all: type: integer description: The total number of pageviews served within the time range. search_engine: type: object description: A variable list of key/value pairs representing the search engine and number of hits. example: baidubot: 1345 bingbot: 5372 googlebot: 35272 pingdom: 13435 data-zone-analytics-api_query_response: type: object description: The exact parameters/timestamps the analytics service used to return data. readOnly: true properties: since: $ref: '#/components/schemas/data-zone-analytics-api_since' time_delta: type: integer description: The amount of time (in minutes) that each data point in the timeseries represents. The granularity of the time-series returned (e.g. each bucket in the time series representing 1-minute vs 1-day) is calculated by the API based on the time-range provided to the API. until: $ref: '#/components/schemas/data-zone-analytics-api_until' data-zone-analytics-api_ray_identifier: type: string description: Ray identifier. example: 41ddf1740f67442d readOnly: true maxLength: 16 data-zone-analytics-api_requests: type: object description: Breakdown of totals for requests. properties: all: type: integer description: Total number of requests served. cached: type: integer description: Total number of cached requests served. content_type: type: object description: A variable list of key/value pairs where the key represents the type of content served, and the value is the number of requests. example: css: 15343 gif: 23178 html: 1.234213e+06 javascript: 318236 jpeg: 1.982048e+06 country: type: object description: A variable list of key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country. example: AG: 37298 GI: 293846 US: 4.181364e+06 http_status: type: object description: Key/value pairs where the key is a HTTP status code and the value is the number of requests served with that code. example: "200": 1.3496983e+07 "301": 283 "400": 187936 "402": 1828 "404": 1293 ssl: type: object description: A break down of requests served over HTTPS. properties: encrypted: type: integer description: The number of requests served over HTTPS. unencrypted: type: integer description: The number of requests served over HTTP. ssl_protocols: type: object description: A breakdown of requests by their SSL protocol. properties: TLSv1: type: integer description: The number of requests served over TLS v1.0. TLSv1.1: type: integer description: The number of requests served over TLS v1.1. TLSv1.2: type: integer description: The number of requests served over TLS v1.2. TLSv1.3: type: integer description: The number of requests served over TLS v1.3. none: type: integer description: The number of requests served over HTTP. uncached: type: integer description: Total number of requests served from the origin. data-zone-analytics-api_requests_by_colo: type: object description: Breakdown of totals for requests. properties: all: type: integer description: Total number of requests served. cached: type: integer description: Total number of cached requests served. country: type: object description: Key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country. example: AG: 37298 GI: 293846 US: 4.181364e+06 http_status: type: object description: A variable list of key/value pairs where the key is a HTTP status code and the value is the number of requests with that code served. example: "200": 1.3496983e+07 "301": 283 "400": 187936 "402": 1828 "404": 1293 uncached: type: integer description: Total number of requests served from the origin. data-zone-analytics-api_sample: type: number description: 'When `?sample=` is provided, a sample of matching records is returned. If `sample=0.1` then 10% of records will be returned. Sampling is random: repeated calls will not only return different records, but likely will also vary slightly in number of returned records. When `?count=` is also specified, `count` is applied to the number of returned records, not the sampled records. So, with `sample=0.05` and `count=7`, when there is a total of 100 records available, approximately five will be returned. When there are 1000 records, seven will be returned. When there are 10,000 records, seven will be returned.' example: 0.1 minimum: 0 maximum: 1 data-zone-analytics-api_since: anyOf: - type: string - type: integer description: |- The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year. Ranges that the Cloudflare web application provides will provide the following period length for each point: - Last 60 minutes (from -59 to -1): 1 minute resolution - Last 7 hours (from -419 to -60): 15 minutes resolution - Last 15 hours (from -899 to -420): 30 minutes resolution - Last 72 hours (from -4320 to -900): 1 hour resolution - Older than 3 days (-525600 to -4320): 1 day resolution. default: -10080 example: "2015-01-01T12:23:00Z" data-zone-analytics-api_threats: type: object description: Breakdown of totals for threats. properties: all: type: integer description: The total number of identifiable threats received over the time frame. country: type: object description: A list of key/value pairs where the key is a two-digit country code and the value is the number of malicious requests received from that country. example: AU: 91 CN: 523423 US: 123 type: type: object description: The list of key/value pairs where the key is a threat category and the value is the number of requests. example: hot.ban.unknown: 5324 macro.chl.captchaErr: 1341 macro.chl.jschlErr: 5323 user.ban.ip: 123 data-zone-analytics-api_timeseries: type: array description: Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters. items: type: object properties: bandwidth: $ref: '#/components/schemas/data-zone-analytics-api_bandwidth' pageviews: $ref: '#/components/schemas/data-zone-analytics-api_pageviews' requests: $ref: '#/components/schemas/data-zone-analytics-api_requests' since: $ref: '#/components/schemas/data-zone-analytics-api_since' threats: $ref: '#/components/schemas/data-zone-analytics-api_threats' uniques: $ref: '#/components/schemas/data-zone-analytics-api_uniques' until: $ref: '#/components/schemas/data-zone-analytics-api_until' data-zone-analytics-api_timeseries_by_colo: type: array description: Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters. items: type: object properties: bandwidth: $ref: '#/components/schemas/data-zone-analytics-api_bandwidth_by_colo' requests: $ref: '#/components/schemas/data-zone-analytics-api_requests_by_colo' since: $ref: '#/components/schemas/data-zone-analytics-api_since' threats: $ref: '#/components/schemas/data-zone-analytics-api_threats' until: $ref: '#/components/schemas/data-zone-analytics-api_until' data-zone-analytics-api_timestamps: type: string description: 'By default, timestamps in responses are returned as Unix nanosecond integers. The `?timestamps=` argument can be set to change the format in which response timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns timestamps as strings.' enum: - unix - unixnano - rfc3339 default: unixnano example: unixnano data-zone-analytics-api_totals: type: object description: Breakdown of totals by data type. properties: bandwidth: $ref: '#/components/schemas/data-zone-analytics-api_bandwidth' pageviews: $ref: '#/components/schemas/data-zone-analytics-api_pageviews' requests: $ref: '#/components/schemas/data-zone-analytics-api_requests' since: $ref: '#/components/schemas/data-zone-analytics-api_since' threats: $ref: '#/components/schemas/data-zone-analytics-api_threats' uniques: $ref: '#/components/schemas/data-zone-analytics-api_uniques' until: $ref: '#/components/schemas/data-zone-analytics-api_until' data-zone-analytics-api_totals_by_colo: type: object description: Breakdown of totals by data type. properties: bandwidth: $ref: '#/components/schemas/data-zone-analytics-api_bandwidth_by_colo' requests: $ref: '#/components/schemas/data-zone-analytics-api_requests_by_colo' since: $ref: '#/components/schemas/data-zone-analytics-api_since' threats: $ref: '#/components/schemas/data-zone-analytics-api_threats' until: $ref: '#/components/schemas/data-zone-analytics-api_until' data-zone-analytics-api_uniques: type: object properties: all: type: integer description: Total number of unique IP addresses within the time range. data-zone-analytics-api_until: anyOf: - type: string - type: integer description: The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used. default: 0 example: "2015-01-02T12:23:00Z" digital-experience-monitoring_account_identifier: type: string example: 01a7362d577a6c3019a474fd6f485823 readOnly: true maxLength: 32 digital-experience-monitoring_aggregate_stat: type: object required: - timePeriod properties: avgMs: type: integer nullable: true deltaPct: type: number format: float nullable: true timePeriod: $ref: '#/components/schemas/digital-experience-monitoring_aggregate_time_period' digital-experience-monitoring_aggregate_time_period: type: object required: - value - units properties: units: type: string enum: - hours - days - testRuns value: type: integer digital-experience-monitoring_aggregate_time_slot: type: object required: - timestamp - avgMs properties: avgMs: type: integer timestamp: type: string digital-experience-monitoring_api-response-collection: allOf: - $ref: '#/components/schemas/digital-experience-monitoring_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/digital-experience-monitoring_result_info' type: object digital-experience-monitoring_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/digital-experience-monitoring_messages' messages: $ref: '#/components/schemas/digital-experience-monitoring_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true digital-experience-monitoring_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false digital-experience-monitoring_api-response-single: allOf: - $ref: '#/components/schemas/digital-experience-monitoring_api-response-common' - properties: result: anyOf: - type: object - type: string type: object digital-experience-monitoring_colo: type: string description: Cloudflare colo example: SJC digital-experience-monitoring_colos_response: type: array description: array of colos. items: type: object required: - airportCode - countryCode - city properties: airportCode: type: string description: Airport code example: SFO city: type: string description: City example: San Francisco countryCode: type: string description: Country code example: US digital-experience-monitoring_device: type: object required: - colo - deviceId - mode - platform - status - timestamp - version properties: colo: $ref: '#/components/schemas/digital-experience-monitoring_colo' deviceId: type: string description: Device identifier (UUID v4) deviceName: type: string description: Device identifier (human readable) 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' digital-experience-monitoring_device_id: type: string description: Device-specific ID, given as UUID v4 example: cb49c27f-7f97-49c5-b6f3-f7c01ead0fd7 digital-experience-monitoring_fleet_status_devices_response: allOf: - $ref: '#/components/schemas/digital-experience-monitoring_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/digital-experience-monitoring_device' digital-experience-monitoring_fleet_status_live_response: allOf: - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single' - type: object properties: result: type: object properties: deviceStats: type: object properties: byColo: type: array nullable: true items: $ref: '#/components/schemas/digital-experience-monitoring_live_stat' byMode: type: array nullable: true items: $ref: '#/components/schemas/digital-experience-monitoring_live_stat' byPlatform: type: array nullable: true items: $ref: '#/components/schemas/digital-experience-monitoring_live_stat' byStatus: type: array nullable: true items: $ref: '#/components/schemas/digital-experience-monitoring_live_stat' byVersion: type: array nullable: true items: $ref: '#/components/schemas/digital-experience-monitoring_live_stat' uniqueDevicesTotal: $ref: '#/components/schemas/digital-experience-monitoring_uniqueDevicesTotal' digital-experience-monitoring_http_details_percentiles_response: type: object 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' digital-experience-monitoring_http_details_response: type: object properties: host: type: string description: The url of the HTTP synthetic application test example: http://example.com httpStats: type: object nullable: true required: - uniqueDevicesTotal - resourceFetchTimeMs - serverResponseTimeMs - dnsResponseTimeMs - httpStatusCode - availabilityPct 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: type: array items: type: object required: - timestamp - status200 - status300 - status400 - status500 properties: status200: type: integer status300: type: integer status400: type: integer status500: type: integer timestamp: type: string example: 2023-07-16 15:00:00+00 resourceFetchTimeMs: $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time' serverResponseTimeMs: $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time' uniqueDevicesTotal: type: integer description: Count of unique devices that have run this test in the given time period example: 57 httpStatsByColo: type: array items: type: object required: - colo - uniqueDevicesTotal - resourceFetchTimeMs - serverResponseTimeMs - dnsResponseTimeMs - httpStatusCode - availabilityPct properties: availabilityPct: $ref: '#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time' colo: type: string example: DFW dnsResponseTimeMs: $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time' httpStatusCode: type: array items: type: object required: - timestamp - status200 - status300 - status400 - status500 properties: status200: type: integer status300: type: integer status400: type: integer status500: type: integer timestamp: type: string example: 2023-07-16 15:00:00+00 resourceFetchTimeMs: $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time' serverResponseTimeMs: $ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time' uniqueDevicesTotal: type: integer description: Count of unique devices that have run this test in the given time period example: 57 interval: type: string description: The interval at which the HTTP synthetic application test is set to run. example: 0h5m0s kind: enum: - http method: type: string description: The HTTP method to use when running the test example: GET name: type: string description: The name of the HTTP synthetic application test example: Atlassian Sign In Page target_policies: type: array nullable: true items: type: object required: - id - name - default properties: default: type: boolean description: Whether the policy is the default for the account id: type: string name: type: string targeted: type: boolean digital-experience-monitoring_live_stat: type: object properties: uniqueDevicesTotal: $ref: '#/components/schemas/digital-experience-monitoring_uniqueDevicesTotal' value: type: string digital-experience-monitoring_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string digital-experience-monitoring_mode: type: string description: The mode under which the WARP client is run example: proxy digital-experience-monitoring_page: type: number description: Page number of paginated results default: 1 example: 1 minimum: 1 digital-experience-monitoring_per_page: type: number description: Number of items per page example: 10 minimum: 1 maximum: 50 digital-experience-monitoring_percentiles: type: object properties: p50: type: number description: p50 observed in the time period nullable: true p90: type: number description: p90 observed in the time period nullable: true p95: type: number description: p95 observed in the time period nullable: true p99: type: number description: p99 observed in the time period nullable: true digital-experience-monitoring_personEmail: type: string description: User contact email address digital-experience-monitoring_platform: type: string description: Operating system example: windows digital-experience-monitoring_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 digital-experience-monitoring_since_minutes: type: number description: Number of minutes before current time default: 10 example: 10 minimum: 1 maximum: 60 digital-experience-monitoring_sort_by: type: string description: Dimension to sort results by enum: - colo - device_id - mode - platform - status - timestamp - version default: timestamp digital-experience-monitoring_status: type: string description: Network status example: connected digital-experience-monitoring_test_stat_over_time: type: object required: - slots properties: avg: type: integer description: average observed in the time period nullable: true max: type: integer description: highest observed in the time period nullable: true min: type: integer description: lowest observed in the time period nullable: true slots: type: array items: type: object required: - timestamp - value properties: timestamp: type: string example: 2023-07-16 15:00:00+00 value: type: integer digital-experience-monitoring_test_stat_pct_over_time: type: object required: - slots properties: avg: type: number format: float description: average observed in the time period nullable: true max: type: number format: float description: highest observed in the time period nullable: true min: type: number format: float description: lowest observed in the time period nullable: true slots: type: array items: type: object required: - timestamp - value properties: timestamp: type: string example: 2023-07-16 15:00:00+00 value: type: number format: float digital-experience-monitoring_tests_response: type: object required: - overviewMetrics - tests properties: overviewMetrics: type: object required: - testsTotal properties: avgHttpAvailabilityPct: type: number format: float description: percentage availability for all HTTP test results in response nullable: true avgTracerouteAvailabilityPct: type: number format: float description: percentage availability for all traceroutes results in response nullable: true testsTotal: type: integer description: number of tests. tests: type: array description: array of test results objects. items: type: object required: - id - name - kind - interval - enabled - description - updated - created - host properties: created: type: string description: date the test was created. description: type: string description: the test description defined during configuration enabled: type: boolean description: if true, then the test will run on targeted devices. Else, the test will not run. host: type: string httpResults: type: object nullable: true required: - resourceFetchTime properties: resourceFetchTime: $ref: '#/components/schemas/digital-experience-monitoring_timing_aggregates' httpResultsByColo: type: array items: type: object required: - colo - resourceFetchTime properties: colo: type: string description: Cloudflare colo example: SJC resourceFetchTime: $ref: '#/components/schemas/digital-experience-monitoring_timing_aggregates' id: $ref: '#/components/schemas/digital-experience-monitoring_uuid' interval: type: string description: The interval at which the synthetic application test is set to run. kind: type: string description: test type, http or traceroute enum: - http - traceroute method: type: string description: for HTTP, the method to use when running the test name: type: string description: name given to this test target_policies: type: array nullable: true items: type: object required: - id - name - default properties: default: type: boolean description: Whether the policy is the default for the account id: type: string name: type: string targeted: type: boolean tracerouteResults: type: object nullable: true required: - roundTripTime properties: roundTripTime: $ref: '#/components/schemas/digital-experience-monitoring_timing_aggregates' tracerouteResultsByColo: type: array items: type: object required: - colo - roundTripTime properties: colo: type: string description: Cloudflare colo example: SJC roundTripTime: $ref: '#/components/schemas/digital-experience-monitoring_timing_aggregates' updated: type: string digital-experience-monitoring_timestamp: type: string description: Timestamp in ISO format example: "2023-10-11T00:00:00Z" digital-experience-monitoring_timing_aggregates: type: object required: - history properties: avgMs: type: integer nullable: true history: type: array items: $ref: '#/components/schemas/digital-experience-monitoring_aggregate_stat' overTime: type: object nullable: true required: - values - timePeriod properties: timePeriod: $ref: '#/components/schemas/digital-experience-monitoring_aggregate_time_period' values: type: array items: $ref: '#/components/schemas/digital-experience-monitoring_aggregate_time_slot' digital-experience-monitoring_traceroute_details_percentiles_response: type: object 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' digital-experience-monitoring_traceroute_details_response: type: object required: - kind - name - host - interval properties: host: type: string description: The host of the Traceroute synthetic application test example: 1.1.1.1 interval: type: string description: The interval at which the Traceroute synthetic application test is set to run. example: 0h5m0s kind: enum: - traceroute name: type: string description: The name of the Traceroute synthetic application test example: Atlassian Sign In Page target_policies: type: array nullable: true items: type: object required: - id - name - default properties: default: type: boolean description: Whether the policy is the default for the account id: type: string name: type: string targeted: type: boolean tracerouteStats: type: object nullable: true required: - uniqueDevicesTotal - roundTripTimeMs - hopsCount - packetLossPct - availabilityPct 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: type: integer description: Count of unique devices that have run this test in the given time period example: 57 tracerouteStatsByColo: type: array items: type: object required: - colo - uniqueDevicesTotal - roundTripTimeMs - hopsCount - packetLossPct - availabilityPct properties: availabilityPct: $ref: '#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time' colo: type: string example: DFW 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: type: integer description: Count of unique devices that have run this test in the given time period example: 57 digital-experience-monitoring_traceroute_test_network_path_response: type: object required: - id properties: deviceName: type: string id: $ref: '#/components/schemas/digital-experience-monitoring_uuid' interval: type: string description: The interval at which the Traceroute synthetic application test is set to run. example: 0h5m0s kind: enum: - traceroute name: type: string networkPath: type: object nullable: true required: - slots properties: sampling: type: object 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 required: - value - unit properties: unit: enum: - hours value: type: integer slots: type: array items: type: object required: - id - timestamp - clientToAppRttMs - clientToCfIngressRttMs - clientToCfEgressRttMs properties: clientToAppRttMs: type: integer description: Round trip time in ms of the client to app mile nullable: true clientToCfEgressRttMs: type: integer description: Round trip time in ms of the client to Cloudflare egress mile nullable: true clientToCfIngressRttMs: type: integer description: Round trip time in ms of the client to Cloudflare ingress mile nullable: true clientToIspRttMs: type: integer description: Round trip time in ms of the client to ISP mile nullable: true id: $ref: '#/components/schemas/digital-experience-monitoring_uuid' timestamp: type: string example: 2023-07-16 15:00:00+00 url: type: string description: The host of the Traceroute synthetic application test example: 1.1.1.1 digital-experience-monitoring_traceroute_test_result_network_path_response: type: object required: - resultId - time_start - hops properties: deviceName: type: string description: name of the device associated with this network path response hops: type: array description: an array of the hops taken by the device to reach the end destination items: type: object required: - ttl properties: asn: type: integer nullable: true aso: type: string nullable: true ipAddress: type: string nullable: true location: type: object nullable: true properties: city: type: string nullable: true state: type: string nullable: true zip: type: string nullable: true mile: type: string enum: - client-to-app - client-to-cf-egress - client-to-cf-ingress - client-to-isp nullable: true name: type: string nullable: true packetLossPct: type: number format: float nullable: true rttMs: type: integer nullable: true ttl: type: integer resultId: $ref: '#/components/schemas/digital-experience-monitoring_uuid' testId: $ref: '#/components/schemas/digital-experience-monitoring_uuid' testName: type: string description: name of the tracroute test time_start: type: string description: date time of this traceroute test example: 2023-07-16 15:00:00+00 digital-experience-monitoring_unique_devices_response: type: object required: - uniqueDevicesTotal properties: uniqueDevicesTotal: type: integer description: total number of unique devices digital-experience-monitoring_uniqueDevicesTotal: type: number description: Number of unique devices digital-experience-monitoring_uuid: type: string description: API Resource UUID tag. example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 maxLength: 36 digital-experience-monitoring_version: type: string description: WARP client version example: 1.0.0 dlp_ContextAwareness: type: object description: Scan the context of predefined entries to only return matches surrounded by keywords. required: - enabled - skip properties: enabled: type: boolean description: If true, scan the context of predefined entries to only return matches surrounded by keywords. skip: $ref: '#/components/schemas/dlp_SkipConfig' dlp_Dataset: type: object required: - name - id - status - num_cells - created_at - updated_at - uploads - secret properties: created_at: type: string format: date-time description: type: string nullable: true id: type: string format: uuid name: type: string num_cells: type: integer format: int64 secret: type: boolean status: $ref: '#/components/schemas/dlp_DatasetUploadStatus' updated_at: type: string format: date-time uploads: type: array items: $ref: '#/components/schemas/dlp_DatasetUpload' dlp_DatasetArray: type: array items: $ref: '#/components/schemas/dlp_Dataset' dlp_DatasetArrayResponse: allOf: - $ref: '#/components/schemas/dlp_V4Response' - type: object properties: result: $ref: '#/components/schemas/dlp_DatasetArray' dlp_DatasetCreation: type: object required: - version - max_cells - dataset properties: dataset: $ref: '#/components/schemas/dlp_Dataset' max_cells: type: integer format: int64 minimum: 0 secret: type: string format: password description: |- The secret to use for Exact Data Match datasets. This is not present in Custom Wordlists. version: type: integer format: int64 description: The version to use when uploading the dataset. dlp_DatasetCreationResponse: allOf: - $ref: '#/components/schemas/dlp_V4Response' - type: object properties: result: $ref: '#/components/schemas/dlp_DatasetCreation' dlp_DatasetNewVersion: type: object required: - version - max_cells properties: max_cells: type: integer format: int64 minimum: 0 secret: type: string format: password version: type: integer format: int64 dlp_DatasetNewVersionResponse: allOf: - $ref: '#/components/schemas/dlp_V4Response' - type: object properties: result: $ref: '#/components/schemas/dlp_DatasetNewVersion' dlp_DatasetResponse: allOf: - $ref: '#/components/schemas/dlp_V4Response' - type: object properties: result: $ref: '#/components/schemas/dlp_Dataset' dlp_DatasetUpdate: type: object properties: description: type: string nullable: true name: type: string nullable: true dlp_DatasetUpload: type: object required: - version - status - num_cells properties: num_cells: type: integer format: int64 status: $ref: '#/components/schemas/dlp_DatasetUploadStatus' version: type: integer format: int64 dlp_DatasetUploadStatus: type: string enum: - empty - uploading - failed - complete dlp_NewDataset: type: object required: - name properties: description: type: string nullable: true name: type: string secret: type: boolean 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. dlp_OcrEnabled: type: boolean description: If true, scan images via OCR to determine if any text present matches filters. dlp_SkipConfig: type: object description: Content types to exclude from context analysis and return all matches. required: - files properties: files: type: boolean description: If the content type is a file, skip context analysis and return all matches. dlp_V4Response: type: object required: - success - errors - messages properties: errors: type: array items: $ref: '#/components/schemas/dlp_V4ResponseMessage' messages: type: array items: $ref: '#/components/schemas/dlp_V4ResponseMessage' result_info: allOf: - $ref: '#/components/schemas/dlp_V4ResponsePagination' success: type: boolean dlp_V4ResponseError: type: object required: - success - errors - messages properties: errors: type: array items: $ref: '#/components/schemas/dlp_V4ResponseMessage' messages: type: array items: $ref: '#/components/schemas/dlp_V4ResponseMessage' result: type: object nullable: true success: type: boolean dlp_V4ResponseMessage: type: object required: - code - message properties: code: type: integer format: int32 minimum: 1000 message: type: string dlp_V4ResponsePagination: type: object required: - page - per_page - count - total_count properties: count: type: integer format: int32 description: total number of pages minimum: 0 page: type: integer format: int32 description: current page minimum: 0 per_page: type: integer format: int32 description: number of items per page minimum: 0 total_count: type: integer format: int32 description: total number of items minimum: 0 dlp_account_risk_summary_response: allOf: - $ref: '#/components/schemas/dlp_api-response-paginated' - properties: result: properties: users: type: array items: type: object required: - user_id - name - email - max_risk_level - event_count - last_event properties: email: type: string event_count: type: integer last_event: $ref: '#/components/schemas/dlp_timestamp' max_risk_level: $ref: '#/components/schemas/dlp_risk_level' name: type: string user_id: $ref: '#/components/schemas/dlp_user_id' dlp_allowed_match_count: type: number description: Related DLP policies will trigger when the match count exceeds the number set. default: 0 example: 5 minimum: 0 maximum: 1000 dlp_api-response-collection: allOf: - $ref: '#/components/schemas/dlp_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/dlp_result_info' type: object dlp_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/dlp_messages' messages: $ref: '#/components/schemas/dlp_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true dlp_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false dlp_api-response-paginated: allOf: - $ref: '#/components/schemas/dlp_api-response-common' - properties: result_info: type: object required: - page - per_page - count - total_count properties: count: type: integer page: type: integer minimum: 1 per_page: type: integer total_count: type: integer type: object dlp_api-response-single: allOf: - $ref: '#/components/schemas/dlp_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object dlp_create_custom_profile_response: allOf: - $ref: '#/components/schemas/dlp_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/dlp_custom_profile' dlp_create_custom_profiles: required: - profiles properties: profiles: type: array items: $ref: '#/components/schemas/dlp_new_custom_profile' required: - name - entries dlp_custom_entry: type: object title: Custom entry description: A custom entry that matches a profile properties: created_at: $ref: '#/components/schemas/dlp_timestamp' enabled: type: boolean description: Whether the entry is enabled or not. example: true id: $ref: '#/components/schemas/dlp_entry_id' name: type: string description: The name of the entry. example: Credit card (Visa) pattern: $ref: '#/components/schemas/dlp_pattern' profile_id: description: ID of the parent profile updated_at: $ref: '#/components/schemas/dlp_timestamp' dlp_custom_profile: type: object title: Custom profile properties: allowed_match_count: $ref: '#/components/schemas/dlp_allowed_match_count' context_awareness: $ref: '#/components/schemas/dlp_ContextAwareness' created_at: $ref: '#/components/schemas/dlp_timestamp' description: type: string description: The description of the profile. example: A standard CVV card number entries: type: array description: The entries for this profile. items: $ref: '#/components/schemas/dlp_custom_entry' id: $ref: '#/components/schemas/dlp_profile_id' name: type: string description: The name of the profile. example: Generic CVV Card Number ocr_enabled: $ref: '#/components/schemas/dlp_OcrEnabled' type: type: string description: The type of the profile. enum: - custom example: custom updated_at: $ref: '#/components/schemas/dlp_timestamp' dlp_custom_profile_response: allOf: - $ref: '#/components/schemas/dlp_api-response-single' - properties: result: allOf: - $ref: '#/components/schemas/dlp_custom_profile' dlp_either_profile_response: allOf: - $ref: '#/components/schemas/dlp_api-response-single' - properties: result: anyOf: - $ref: '#/components/schemas/dlp_predefined_profile' - $ref: '#/components/schemas/dlp_custom_profile' - $ref: '#/components/schemas/dlp_integration_profile' dlp_entry_id: allOf: - $ref: '#/components/schemas/dlp_uuid' description: The ID for this entry example: 719d1215-260f-41d0-8c32-eb320ad107f7 dlp_get_behaviors_response: allOf: - $ref: '#/components/schemas/dlp_api-response-single' - properties: result: properties: behaviors: type: object dlp_get_settings_response: allOf: - $ref: '#/components/schemas/dlp_api-response-single' - properties: result: required: - public_key properties: public_key: type: string example: EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0= nullable: true dlp_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 dlp_integration_entry: type: object title: Integration entry description: An entry derived from an integration properties: created_at: $ref: '#/components/schemas/dlp_timestamp' enabled: type: boolean description: Whether the entry is enabled or not. example: true id: $ref: '#/components/schemas/dlp_entry_id' name: type: string description: The name of the entry. example: Top Secret profile_id: description: ID of the parent profile updated_at: $ref: '#/components/schemas/dlp_timestamp' dlp_integration_profile: type: object title: Integration profile properties: created_at: $ref: '#/components/schemas/dlp_timestamp' description: type: string description: The description of the profile. entries: type: array description: The entries for this profile. items: $ref: '#/components/schemas/dlp_integration_entry' id: $ref: '#/components/schemas/dlp_profile_id' name: type: string description: The name of the profile. example: 'MIP Sensitivity Labels: Profile 1' type: type: string description: The type of the profile. enum: - integration example: integration updated_at: $ref: '#/components/schemas/dlp_timestamp' dlp_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string dlp_new_custom_entry: type: object title: Custom entry description: A custom entry create payload required: - name - enabled - pattern properties: enabled: type: boolean description: Whether the entry is enabled or not. example: true name: type: string description: The name of the entry. example: Credit card (Visa) pattern: $ref: '#/components/schemas/dlp_pattern' dlp_new_custom_profile: type: object properties: allowed_match_count: $ref: '#/components/schemas/dlp_allowed_match_count' context_awareness: $ref: '#/components/schemas/dlp_ContextAwareness' description: type: string description: The description of the profile. example: A standard CVV card number entries: type: array description: The entries for this profile. items: $ref: '#/components/schemas/dlp_new_custom_entry' name: type: string description: The name of the profile. example: Generic CVV Card Number ocr_enabled: $ref: '#/components/schemas/dlp_OcrEnabled' dlp_pattern: type: object title: Pattern description: A pattern that matches an entry required: - regex properties: regex: type: string description: The regex pattern. example: ^4[0-9]{6,14}$ validation: type: string description: Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched. enum: - luhn example: luhn dlp_predefined_entry: type: object title: Predefined entry description: A predefined entry that matches a profile properties: enabled: type: boolean description: Whether the entry is enabled or not. example: true id: $ref: '#/components/schemas/dlp_entry_id' name: type: string description: The name of the entry. example: Credit card (Visa) profile_id: description: ID of the parent profile dlp_predefined_profile: type: object title: Predefined profile properties: allowed_match_count: $ref: '#/components/schemas/dlp_allowed_match_count' context_awareness: $ref: '#/components/schemas/dlp_ContextAwareness' entries: type: array description: The entries for this profile. items: $ref: '#/components/schemas/dlp_predefined_entry' id: $ref: '#/components/schemas/dlp_profile_id' name: type: string description: The name of the profile. example: Generic CVV Card Number ocr_enabled: $ref: '#/components/schemas/dlp_OcrEnabled' type: type: string description: The type of the profile. enum: - predefined example: predefined dlp_predefined_profile_response: allOf: - $ref: '#/components/schemas/dlp_api-response-single' - properties: result: allOf: - $ref: '#/components/schemas/dlp_predefined_profile' dlp_profile_id: allOf: - $ref: '#/components/schemas/dlp_uuid' description: The ID for this profile example: 384e129d-25bd-403c-8019-bc19eb7a8a5f dlp_profiles: anyOf: - $ref: '#/components/schemas/dlp_predefined_profile' - $ref: '#/components/schemas/dlp_custom_profile' - $ref: '#/components/schemas/dlp_integration_profile' dlp_reset_user_response: allOf: - $ref: '#/components/schemas/dlp_api-response-single' - properties: result: type: object nullable: true dlp_response_collection: allOf: - $ref: '#/components/schemas/dlp_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/dlp_profiles' dlp_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 dlp_risk_level: type: string enum: - low - medium - high example: low dlp_shared_entry_update_integration: type: object title: Update integration entry description: Properties of an integration entry in a custom profile properties: enabled: type: boolean description: Whether the entry is enabled or not. entry_id: $ref: '#/components/schemas/dlp_entry_id' dlp_shared_entry_update_predefined: type: object title: Update predefined entry description: Properties of a predefined entry in a custom profile properties: enabled: type: boolean description: Whether the entry is enabled or not. example: true entry_id: $ref: '#/components/schemas/dlp_entry_id' dlp_timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true dlp_update_behaviors_request: type: object properties: behaviors: type: object dlp_update_custom_profile: type: object title: Update custom profile properties: allowed_match_count: $ref: '#/components/schemas/dlp_allowed_match_count' context_awareness: $ref: '#/components/schemas/dlp_ContextAwareness' description: type: string description: The description of the profile. example: A standard CVV card number entries: type: array description: The custom entries for this profile. Array elements with IDs are modifying the existing entry with that ID. Elements without ID will create new entries. Any entry not in the list will be deleted. items: $ref: '#/components/schemas/dlp_custom_entry' name: type: string description: The name of the profile. example: Generic CVV Card Number ocr_enabled: $ref: '#/components/schemas/dlp_OcrEnabled' shared_entries: type: array description: Entries from other profiles (e.g. pre-defined Cloudflare profiles, or your Microsoft Information Protection profiles). items: oneOf: - $ref: '#/components/schemas/dlp_shared_entry_update_predefined' - $ref: '#/components/schemas/dlp_shared_entry_update_integration' dlp_update_predefined_profile: type: object title: Update predefined profile properties: allowed_match_count: $ref: '#/components/schemas/dlp_allowed_match_count' context_awareness: $ref: '#/components/schemas/dlp_ContextAwareness' entries: type: array description: The entries for this profile. items: properties: enabled: type: boolean description: Whether the entry is enabled or not. example: true id: $ref: '#/components/schemas/dlp_entry_id' ocr_enabled: $ref: '#/components/schemas/dlp_OcrEnabled' dlp_update_settings: type: object title: Settings description: Payload log settings required: - public_key properties: public_key: type: string description: The public key to use when encrypting extracted payloads, as a base64 string example: EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0= nullable: true dlp_update_settings_response: allOf: - $ref: '#/components/schemas/dlp_api-response-single' - properties: result: required: - public_key properties: public_key: type: string example: EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0= nullable: true dlp_user_id: allOf: - $ref: '#/components/schemas/dlp_uuid' description: The ID for a user example: f2108713-1206-4e84-8b80-0e71a6a1c67b dlp_user_risk_summary_response: allOf: - $ref: '#/components/schemas/dlp_api-response-paginated' - properties: result: properties: email: type: string events: type: array items: type: object required: - id - name - risk_level - timestamp properties: event_details: type: object id: type: string name: type: string risk_level: $ref: '#/components/schemas/dlp_risk_level' timestamp: $ref: '#/components/schemas/dlp_timestamp' last_reset_time: allOf: - $ref: '#/components/schemas/dlp_timestamp' type: string nullable: true name: type: string risk_level: allOf: - $ref: '#/components/schemas/dlp_risk_level' type: string nullable: true dlp_uuid: type: string description: UUID example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 readOnly: true maxLength: 36 dlp_validate_pattern: type: object title: Pattern description: A request to validate a pattern required: - regex properties: regex: type: string description: The regex pattern. example: ^4[0-9]{6,}$ dlp_validate_response: allOf: - $ref: '#/components/schemas/dlp_api-response-single' - properties: result: properties: valid: type: boolean example: true dns-analytics_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/dns-analytics_messages' messages: $ref: '#/components/schemas/dns-analytics_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true dns-analytics_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false dns-analytics_api-response-single: allOf: - $ref: '#/components/schemas/dns-analytics_api-response-common' - properties: result: anyOf: - type: object - type: string type: object dns-analytics_data: type: array description: Array with one row per combination of dimension values. items: type: object required: - dimensions properties: dimensions: type: array description: Array of dimension values, representing the combination of dimension values corresponding to this row. items: type: string description: Dimension value. example: NODATA dns-analytics_dimensions: type: string description: A comma-separated list of dimensions to group results by. example: queryType dns-analytics_filters: type: string description: Segmentation filter in 'attribute operator value' format. example: responseCode==NOERROR,queryType==A dns-analytics_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 dns-analytics_limit: type: integer description: Limit number of returned metrics. default: 100000 example: 100 dns-analytics_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string dns-analytics_metrics: type: string description: A comma-separated list of metrics to query. example: queryCount,uncachedCount dns-analytics_query: type: object required: - dimensions - metrics - since - until - limit properties: dimensions: type: array description: Array of dimension names. example: - responseCode - queryName items: type: string description: Dimension name. example: responseCode filters: $ref: '#/components/schemas/dns-analytics_filters' limit: $ref: '#/components/schemas/dns-analytics_limit' metrics: type: array description: Array of metric names. example: - queryCount - responseTimeAvg items: type: string description: Metric name. example: queries since: $ref: '#/components/schemas/dns-analytics_since' sort: type: array description: Array of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending). example: - +responseCode - -queryName items: type: string description: Dimension name (may be prefixed by - (descending) or + (ascending). example: +responseCode until: $ref: '#/components/schemas/dns-analytics_until' dns-analytics_report: allOf: - $ref: '#/components/schemas/dns-analytics_result' - required: - data properties: data: items: required: - metrics properties: metrics: type: array description: Array with one item per requested metric. Each item is a single value. items: type: number description: Nominal metric value. dns-analytics_report_bytime: allOf: - $ref: '#/components/schemas/dns-analytics_result' - required: - time_intervals - query - data properties: data: items: required: - metrics properties: metrics: type: array description: Array with one item per requested metric. Each item is an array of values, broken down by time interval. items: type: array description: Nominal metric values, broken down by time interval. items: {} properties: items: type: number description: Nominal metric value. query: type: object required: - time_delta properties: time_delta: $ref: '#/components/schemas/dns-analytics_time_delta' time_intervals: type: array description: | Array of time intervals in the response data. Each interval is represented as an array containing two values: the start time, and the end time. items: type: array description: Array with exactly two items, representing the start and end time (respectively) of this time interval. items: type: string format: date-time description: Time value. example: "2023-11-11T12:00:00Z" dns-analytics_result: type: object required: - rows - totals - min - max - data_lag - query - data properties: data: $ref: '#/components/schemas/dns-analytics_data' data_lag: type: number description: Number of seconds between current time and last processed event, in another words how many seconds of data could be missing. example: 60 minimum: 0 max: type: object description: Maximum results for each metric (object mapping metric names to values). Currently always an empty object. min: type: object description: Minimum results for each metric (object mapping metric names to values). Currently always an empty object. query: $ref: '#/components/schemas/dns-analytics_query' rows: type: number description: Total number of rows in the result. example: 100 minimum: 0 totals: type: object description: Total results for metrics across all data (object mapping metric names to values). dns-analytics_since: type: string format: date-time description: Start date and time of requesting data period in ISO 8601 format. example: "2023-11-11T12:00:00Z" dns-analytics_sort: type: string description: A comma-separated list of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending). example: +responseCode,-queryName dns-analytics_time_delta: type: string description: Unit of time to group data by. enum: - all - auto - year - quarter - month - week - day - hour - dekaminute - minute example: hour dns-analytics_until: type: string format: date-time description: End date and time of requesting data period in ISO 8601 format. example: "2023-11-11T13:00:00Z" dns-custom-nameservers_CustomNS: title: Custom NS description: A single account custom nameserver. required: - dns_records - ns_name - status - zone_tag properties: dns_records: type: array description: A and AAAA records associated with the nameserver. items: properties: type: type: string description: DNS record type. enum: - A - AAAA example: A value: type: string description: DNS record contents (an IPv4 or IPv6 address). example: 1.1.1.1 ns_name: $ref: '#/components/schemas/dns-custom-nameservers_ns_name' ns_set: $ref: '#/components/schemas/dns-custom-nameservers_ns_set' status: type: string description: Verification status of the nameserver. enum: - moved - pending - verified example: verified deprecated: true zone_tag: $ref: '#/components/schemas/dns-custom-nameservers_schemas-identifier' dns-custom-nameservers_CustomNSInput: title: Custom NS Input required: - ns_name properties: ns_name: $ref: '#/components/schemas/dns-custom-nameservers_ns_name' ns_set: $ref: '#/components/schemas/dns-custom-nameservers_ns_set' dns-custom-nameservers_acns_response_collection: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/dns-custom-nameservers_CustomNS' dns-custom-nameservers_acns_response_single: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_api-response-single' - type: object properties: result: $ref: '#/components/schemas/dns-custom-nameservers_CustomNS' dns-custom-nameservers_api-response-collection: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/dns-custom-nameservers_result_info' type: object dns-custom-nameservers_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/dns-custom-nameservers_messages' messages: $ref: '#/components/schemas/dns-custom-nameservers_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true dns-custom-nameservers_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false dns-custom-nameservers_api-response-single: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common' - properties: result: anyOf: - type: object - type: string type: object dns-custom-nameservers_availability_response: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection' - type: object properties: result: type: array items: type: string format: hostname description: Name of zone based on which account custom nameservers can be created. For example, if example.com is returned, then ns1.example.com can be used as an account custom nameserver. example: example.com readOnly: true dns-custom-nameservers_empty_response: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection' - type: object properties: result: type: array maxItems: 0 items: {} 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: type: string description: Account identifier tag. example: 372e67954025e0ba6aaa6d586b9e0b59 readOnly: true maxLength: 32 dns-custom-nameservers_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string dns-custom-nameservers_ns_name: type: string format: hostname description: The FQDN of the name server. example: ns1.example.com dns-custom-nameservers_ns_set: type: number description: The number of the set that this name server belongs to. default: 1 example: 1 minimum: 1 maximum: 5 dns-custom-nameservers_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 dns-custom-nameservers_schemas-empty_response: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection' - type: object properties: result: type: array maxItems: 0 items: {} dns-custom-nameservers_schemas-identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 dns-custom-nameservers_zone_metadata: type: object properties: enabled: type: boolean description: Whether zone uses account-level custom nameservers. example: true ns_set: type: number description: The number of the name server set to assign to the zone. default: 1 example: 1 minimum: 1 maximum: 5 dns-firewall_api-response-collection: allOf: - $ref: '#/components/schemas/dns-firewall_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/dns-firewall_result_info' type: object dns-firewall_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/dns-firewall_messages' messages: $ref: '#/components/schemas/dns-firewall_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true dns-firewall_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false dns-firewall_api-response-single: allOf: - $ref: '#/components/schemas/dns-firewall_api-response-common' - properties: result: anyOf: - type: object - type: string type: object dns-firewall_attack_mitigation: type: object description: Attack mitigation settings. nullable: true properties: enabled: type: boolean description: When enabled, random-prefix attacks are automatically mitigated and the upstream DNS servers protected. example: true only_when_upstream_unhealthy: type: boolean description: Only mitigate attacks when upstream servers seem unhealthy. default: true example: false dns-firewall_deprecate_any_requests: type: boolean description: Deprecate the response to ANY requests. example: true dns-firewall_dns-firewall: type: object required: - id - name - upstream_ips - dns_firewall_ips - minimum_cache_ttl - maximum_cache_ttl - deprecate_any_requests - ecs_fallback - modified_on properties: attack_mitigation: $ref: '#/components/schemas/dns-firewall_attack_mitigation' deprecate_any_requests: $ref: '#/components/schemas/dns-firewall_deprecate_any_requests' dns_firewall_ips: $ref: '#/components/schemas/dns-firewall_dns_firewall_ips' ecs_fallback: $ref: '#/components/schemas/dns-firewall_ecs_fallback' id: $ref: '#/components/schemas/dns-firewall_identifier' maximum_cache_ttl: $ref: '#/components/schemas/dns-firewall_maximum_cache_ttl' minimum_cache_ttl: $ref: '#/components/schemas/dns-firewall_minimum_cache_ttl' modified_on: $ref: '#/components/schemas/dns-firewall_modified_on' 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' dns-firewall_dns_firewall_ips: type: array example: - 203.0.113.1 - 203.0.113.254 - 2001:DB8:AB::CF - 2001:DB8:CD::CF items: anyOf: - type: string format: ipv4 description: Cloudflare-assigned DNS IPv4 Address. example: 203.0.113.1 - type: string format: ipv6 description: Cloudflare-assigned DNS IPv6 Address. example: 2001:DB8:ab::CF dns-firewall_dns_firewall_response_collection: allOf: - $ref: '#/components/schemas/dns-firewall_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/dns-firewall_dns-firewall' dns-firewall_dns_firewall_single_response: allOf: - $ref: '#/components/schemas/dns-firewall_api-response-single' - properties: result: $ref: '#/components/schemas/dns-firewall_dns-firewall' dns-firewall_ecs_fallback: type: boolean description: Forward client IP (resolver) subnet if no EDNS Client Subnet is sent. example: false dns-firewall_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 dns-firewall_maximum_cache_ttl: type: number description: Maximum DNS Cache TTL. default: 900 example: 900 minimum: 30 maximum: 36000 dns-firewall_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string dns-firewall_minimum_cache_ttl: type: number description: Minimum DNS Cache TTL. default: 60 example: 60 minimum: 30 maximum: 36000 dns-firewall_modified_on: type: string format: date-time description: Last modification of DNS Firewall cluster. example: "2014-01-01T05:20:00.12345Z" readOnly: true dns-firewall_name: type: string description: DNS Firewall Cluster Name. example: My Awesome DNS Firewall cluster maxLength: 160 dns-firewall_negative_cache_ttl: type: number description: Negative DNS Cache TTL. example: 900 nullable: true minimum: 30 maximum: 36000 dns-firewall_ratelimit: type: number description: Ratelimit in queries per second per datacenter (applies to DNS queries sent to the upstream nameservers configured on the cluster). example: 600 nullable: true minimum: 100 maximum: 1e+09 dns-firewall_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 dns-firewall_retries: type: number description: Number of retries for fetching DNS responses from upstream nameservers (not counting the initial attempt). default: 2 example: 2 minimum: 0 maximum: 2 dns-firewall_schemas-dns-firewall: allOf: - $ref: '#/components/schemas/dns-firewall_dns-firewall' type: object dns-firewall_upstream_ips: type: array example: - 192.0.2.1 - 198.51.100.1 - 2001:DB8:100::CF items: anyOf: - type: string format: ipv4 description: Upstream DNS Server IPv4 Address. example: 192.0.2.1 - type: string format: ipv6 description: Upstream DNS Server IPv6 Address. example: 2001:DB8:100::CF dns-records_AAAARecord: allOf: - properties: content: type: string format: ipv6 description: A valid IPv6 address. example: 2400:cb00:2049::1 name: $ref: '#/components/schemas/dns-records_name' proxied: $ref: '#/components/schemas/dns-records_proxied' type: type: string description: Record type. enum: - AAAA example: AAAA - $ref: '#/components/schemas/dns-records_base' title: AAAA Record required: - type - name - content dns-records_ARecord: allOf: - properties: content: type: string format: ipv4 description: A valid IPv4 address. example: 198.51.100.4 name: $ref: '#/components/schemas/dns-records_name' proxied: $ref: '#/components/schemas/dns-records_proxied' type: type: string description: Record type. enum: - A example: A - $ref: '#/components/schemas/dns-records_base' title: A Record required: - type - name - content dns-records_CAARecord: allOf: - properties: content: type: string description: Formatted CAA content. See 'data' to set CAA properties. readOnly: true data: type: object description: Components of a CAA record. properties: flags: type: number description: Flags for the CAA record. example: 1 minimum: 0 maximum: 255 tag: type: string description: 'Name of the property controlled by this record (e.g.: issue, issuewild, iodef).' example: issue value: type: string description: Value of the record. This field's semantics depend on the chosen tag. name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - CAA example: CAA - $ref: '#/components/schemas/dns-records_base' title: CAA Record required: - type - name - data dns-records_CERTRecord: allOf: - properties: content: type: string description: Formatted CERT content. See 'data' to set CERT properties. readOnly: true data: type: object description: Components of a CERT record. properties: algorithm: type: number description: Algorithm. example: 8 minimum: 0 maximum: 255 certificate: type: string description: Certificate. key_tag: type: number description: Key Tag. example: 1 minimum: 0 maximum: 65535 type: type: number description: Type. example: 9 minimum: 0 maximum: 65535 name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - CERT example: CERT - $ref: '#/components/schemas/dns-records_base' title: CERT Record required: - type - name - data dns-records_CNAMERecord: allOf: - properties: content: description: A valid hostname. Must not match the record's name. name: $ref: '#/components/schemas/dns-records_name' proxied: $ref: '#/components/schemas/dns-records_proxied' type: type: string description: Record type. enum: - CNAME example: CNAME - $ref: '#/components/schemas/dns-records_base' title: CNAME Record required: - type - name - content dns-records_DNSKEYRecord: allOf: - properties: content: type: string description: Formatted DNSKEY content. See 'data' to set DNSKEY properties. readOnly: true data: type: object description: Components of a DNSKEY record. properties: algorithm: type: number description: Algorithm. example: 5 minimum: 0 maximum: 255 flags: type: number description: Flags. example: 1 minimum: 0 maximum: 65535 protocol: type: number description: Protocol. example: 3 minimum: 0 maximum: 255 public_key: type: string description: Public Key. name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - DNSKEY example: DNSKEY - $ref: '#/components/schemas/dns-records_base' title: DNSKEY Record required: - type - name - data dns-records_DSRecord: allOf: - properties: content: type: string description: Formatted DS content. See 'data' to set DS properties. readOnly: true data: type: object description: Components of a DS record. properties: algorithm: type: number description: Algorithm. example: 3 minimum: 0 maximum: 255 digest: type: string description: Digest. digest_type: type: number description: Digest Type. example: 1 minimum: 0 maximum: 255 key_tag: type: number description: Key Tag. example: 1 minimum: 0 maximum: 65535 name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - DS example: DS - $ref: '#/components/schemas/dns-records_base' title: DS Record required: - type - name - data dns-records_HTTPSRecord: allOf: - properties: content: type: string description: Formatted HTTPS content. See 'data' to set HTTPS properties. readOnly: true data: type: object description: Components of a HTTPS record. properties: priority: type: number description: priority. example: 1 minimum: 0 maximum: 65535 target: type: string description: target. example: . value: type: string description: value. example: alpn="h3,h2" ipv4hint="127.0.0.1" ipv6hint="::1" name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - HTTPS example: HTTPS - $ref: '#/components/schemas/dns-records_base' title: HTTPS Record required: - type - name - data dns-records_LOCRecord: allOf: - properties: content: type: string description: Formatted LOC content. See 'data' to set LOC properties. example: IN LOC 37 46 46 N 122 23 35 W 0m 100m 0m 0m readOnly: true data: type: object description: Components of a LOC record. properties: altitude: type: number description: Altitude of location in meters. example: 0 minimum: -100000 maximum: 4.284967295e+07 lat_degrees: type: number description: Degrees of latitude. example: 37 minimum: 0 maximum: 90 lat_direction: description: Latitude direction. enum: - "N" - S example: "N" lat_minutes: type: number description: Minutes of latitude. default: 0 example: 46 minimum: 0 maximum: 59 lat_seconds: type: number description: Seconds of latitude. default: 0 example: 46 minimum: 0 maximum: 59.999 long_degrees: type: number description: Degrees of longitude. example: 122 minimum: 0 maximum: 180 long_direction: description: Longitude direction. enum: - E - W example: W long_minutes: type: number description: Minutes of longitude. default: 0 example: 23 minimum: 0 maximum: 59 long_seconds: type: number description: Seconds of longitude. default: 0 example: 35 minimum: 0 maximum: 59.999 precision_horz: type: number description: Horizontal precision of location. default: 0 example: 0 minimum: 0 maximum: 9e+07 precision_vert: type: number description: Vertical precision of location. default: 0 example: 0 minimum: 0 maximum: 9e+07 size: type: number description: Size of location in meters. default: 0 example: 100 minimum: 0 maximum: 9e+07 name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - LOC example: LOC - $ref: '#/components/schemas/dns-records_base' title: LOC Record required: - type - name - data dns-records_MXRecord: allOf: - properties: content: type: string format: hostname description: A valid mail server hostname. example: mx.example.com name: $ref: '#/components/schemas/dns-records_name' priority: $ref: '#/components/schemas/dns-records_priority' type: type: string description: Record type. enum: - MX example: MX - $ref: '#/components/schemas/dns-records_base' title: MX Record required: - type - name - content - priority dns-records_NAPTRRecord: allOf: - properties: content: type: string description: Formatted NAPTR content. See 'data' to set NAPTR properties. readOnly: true data: type: object description: Components of a NAPTR record. properties: flags: type: string description: Flags. order: type: number description: Order. example: 100 minimum: 0 maximum: 65535 preference: type: number description: Preference. example: 10 minimum: 0 maximum: 65535 regex: type: string description: Regex. replacement: type: string description: Replacement. service: type: string description: Service. name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - NAPTR example: NAPTR - $ref: '#/components/schemas/dns-records_base' title: NAPTR Record required: - type - name - data dns-records_NSRecord: allOf: - properties: content: description: A valid name server host name. example: ns1.example.com name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - NS example: NS - $ref: '#/components/schemas/dns-records_base' title: NS Record required: - type - name - content dns-records_PTRRecord: allOf: - properties: content: type: string description: Domain name pointing to the address. example: example.com name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - PTR example: PTR - $ref: '#/components/schemas/dns-records_base' title: PTR Record required: - type - name - content dns-records_SMIMEARecord: allOf: - properties: content: type: string description: Formatted SMIMEA content. See 'data' to set SMIMEA properties. readOnly: true data: type: object description: Components of a SMIMEA record. properties: certificate: type: string description: Certificate. matching_type: type: number description: Matching Type. example: 0 minimum: 0 maximum: 255 selector: type: number description: Selector. example: 0 minimum: 0 maximum: 255 usage: type: number description: Usage. example: 3 minimum: 0 maximum: 255 name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - SMIMEA example: SMIMEA - $ref: '#/components/schemas/dns-records_base' title: SMIMEA Record required: - type - name - data dns-records_SRVRecord: allOf: - properties: content: type: string description: Priority, weight, port, and SRV target. See 'data' for setting the individual component values. example: 10 IN SRV 5 8806 example.com. readOnly: true data: type: object description: Components of a SRV record. properties: name: type: string format: hostname description: A valid hostname. Deprecated in favor of the regular 'name' outside the data map. This data map field represents the remainder of the full 'name' after the service and protocol. example: example.com deprecated: true port: type: number description: The port of the service. example: 8806 minimum: 0 maximum: 65535 priority: $ref: '#/components/schemas/dns-records_priority' proto: type: string description: A valid protocol, prefixed with an underscore. Deprecated in favor of the regular 'name' outside the data map. This data map field normally represents the second label of that 'name'. example: _tcp deprecated: true service: type: string description: A service type, prefixed with an underscore. Deprecated in favor of the regular 'name' outside the data map. This data map field normally represents the first label of that 'name'. example: _sip deprecated: true target: type: string format: hostname description: A valid hostname. example: example.com weight: type: number description: The record weight. example: 5 minimum: 0 maximum: 65535 name: type: string description: DNS record name (or @ for the zone apex) in Punycode. For SRV records, the first label is normally a service and the second a protocol name, each starting with an underscore. example: _sip._tcp.example.com maxLength: 255 type: type: string description: Record type. enum: - SRV example: SRV - $ref: '#/components/schemas/dns-records_base' title: SRV Record required: - type - name - data dns-records_SSHFPRecord: allOf: - properties: content: type: string description: Formatted SSHFP content. See 'data' to set SSHFP properties. readOnly: true data: type: object description: Components of a SSHFP record. properties: algorithm: type: number description: algorithm. example: 2 minimum: 0 maximum: 255 fingerprint: type: string description: fingerprint. type: type: number description: type. example: 1 minimum: 0 maximum: 255 name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - SSHFP example: SSHFP - $ref: '#/components/schemas/dns-records_base' title: SSHFP Record required: - type - name - data dns-records_SVCBRecord: allOf: - properties: content: type: string description: Formatted SVCB content. See 'data' to set SVCB properties. readOnly: true data: type: object description: Components of a SVCB record. properties: priority: type: number description: priority. example: 1 minimum: 0 maximum: 65535 target: type: string description: target. example: . value: type: string description: value. example: alpn="h3,h2" ipv4hint="127.0.0.1" ipv6hint="::1" name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - SVCB example: SVCB - $ref: '#/components/schemas/dns-records_base' title: SVCB Record required: - type - name - data dns-records_TLSARecord: allOf: - properties: content: type: string description: Formatted TLSA content. See 'data' to set TLSA properties. readOnly: true data: type: object description: Components of a TLSA record. properties: certificate: type: string description: certificate. matching_type: type: number description: Matching Type. example: 1 minimum: 0 maximum: 255 selector: type: number description: Selector. example: 0 minimum: 0 maximum: 255 usage: type: number description: Usage. example: 0 minimum: 0 maximum: 255 name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - TLSA example: TLSA - $ref: '#/components/schemas/dns-records_base' title: TLSA Record required: - type - name - data dns-records_TXTRecord: allOf: - properties: content: type: string description: Text content for the record. example: example text content name: $ref: '#/components/schemas/dns-records_name' type: type: string description: Record type. enum: - TXT example: TXT - $ref: '#/components/schemas/dns-records_base' title: TXT Record required: - type - name - content dns-records_URIRecord: allOf: - properties: content: type: string description: Formatted URI content. See 'data' to set URI properties. readOnly: true data: type: object description: Components of a URI record. properties: content: type: string description: The record content. example: http://example.com/example.html weight: type: number description: The record weight. example: 20 minimum: 0 maximum: 65535 name: $ref: '#/components/schemas/dns-records_name' priority: $ref: '#/components/schemas/dns-records_priority' type: type: string description: Record type. enum: - URI example: URI - $ref: '#/components/schemas/dns-records_base' title: URI Record required: - type - name - data - priority dns-records_api-response-collection: allOf: - $ref: '#/components/schemas/dns-records_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/dns-records_result_info' type: object dns-records_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/dns-records_messages' messages: $ref: '#/components/schemas/dns-records_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true dns-records_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/dns-records_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/dns-records_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false dns-records_api-response-single: allOf: - $ref: '#/components/schemas/dns-records_api-response-common' - properties: result: anyOf: - type: object - type: string type: object dns-records_base: properties: comment: $ref: '#/components/schemas/dns-records_comment' created_on: type: string format: date-time description: When the record was created. example: "2014-01-01T05:20:00.12345Z" readOnly: true id: $ref: '#/components/schemas/dns-records_identifier' locked: type: boolean description: Whether this record can be modified/deleted (true means it's managed by Cloudflare). example: false readOnly: true meta: type: object description: Extra Cloudflare-specific information about the record. readOnly: true properties: auto_added: type: boolean description: Will exist if Cloudflare automatically added this DNS record during initial setup. example: true source: type: string description: Where the record originated from. example: primary modified_on: type: string format: date-time description: When the record was last modified. example: "2014-01-01T05:20:00.12345Z" readOnly: true proxiable: type: boolean description: Whether the record can be proxied by Cloudflare or not. example: true readOnly: true tags: $ref: '#/components/schemas/dns-records_tags' ttl: $ref: '#/components/schemas/dns-records_ttl' zone_id: $ref: '#/components/schemas/dns-records_identifier' zone_name: type: string format: hostname description: The domain of the record. example: example.com readOnly: true dns-records_comment: type: string description: Comments or notes about the DNS record. This field has no effect on DNS responses. example: Domain verification record dns-records_content: type: string description: DNS record content. example: 127.0.0.1 dns-records_direction: type: string description: Direction to order DNS records in. enum: - asc - desc default: asc dns-records_dns-record: oneOf: - $ref: '#/components/schemas/dns-records_ARecord' - $ref: '#/components/schemas/dns-records_AAAARecord' - $ref: '#/components/schemas/dns-records_CAARecord' - $ref: '#/components/schemas/dns-records_CERTRecord' - $ref: '#/components/schemas/dns-records_CNAMERecord' - $ref: '#/components/schemas/dns-records_DNSKEYRecord' - $ref: '#/components/schemas/dns-records_DSRecord' - $ref: '#/components/schemas/dns-records_HTTPSRecord' - $ref: '#/components/schemas/dns-records_LOCRecord' - $ref: '#/components/schemas/dns-records_MXRecord' - $ref: '#/components/schemas/dns-records_NAPTRRecord' - $ref: '#/components/schemas/dns-records_NSRecord' - $ref: '#/components/schemas/dns-records_PTRRecord' - $ref: '#/components/schemas/dns-records_SMIMEARecord' - $ref: '#/components/schemas/dns-records_SRVRecord' - $ref: '#/components/schemas/dns-records_SSHFPRecord' - $ref: '#/components/schemas/dns-records_SVCBRecord' - $ref: '#/components/schemas/dns-records_TLSARecord' - $ref: '#/components/schemas/dns-records_TXTRecord' - $ref: '#/components/schemas/dns-records_URIRecord' type: object required: - id - type - name - content - proxiable - locked - zone_name - created_on - modified_on dns-records_dns_response_collection: allOf: - $ref: '#/components/schemas/dns-records_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/dns-records_dns-record' dns-records_dns_response_import_scan: allOf: - $ref: '#/components/schemas/dns-records_api-response-single' - type: object properties: result: type: object properties: recs_added: type: number description: Number of DNS records added. example: 5 total_records_parsed: type: number description: Total number of DNS records parsed. example: 5 timing: type: object properties: end_time: type: string format: date-time description: When the file parsing ended. example: "2014-03-01T12:20:01Z" process_time: type: number description: Processing time of the file in seconds. example: 1 start_time: type: string format: date-time description: When the file parsing started. example: "2014-03-01T12:20:00Z" dns-records_dns_response_single: allOf: - $ref: '#/components/schemas/dns-records_api-response-single' - type: object properties: result: $ref: '#/components/schemas/dns-records_dns-record' dns-records_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 dns-records_match: type: string description: | Whether to match all search requirements or at least one (any). If set to `all`, acts like a logical AND between filters. If set to `any`, acts like a logical OR instead. Note that the interaction between tag filters is controlled by the `tag-match` parameter instead. enum: - any - all default: all example: any dns-records_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string dns-records_name: type: string description: DNS record name (or @ for the zone apex) in Punycode. example: example.com maxLength: 255 dns-records_order: type: string description: Field to order DNS records by. enum: - type - name - content - ttl - proxied default: type dns-records_page: type: number description: Page number of paginated results. default: 1 minimum: 1 dns-records_per_page: type: number description: Number of DNS records per page. default: 100 example: 5 minimum: 1 maximum: 5e+06 dns-records_priority: type: number description: Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred. example: 10 minimum: 0 maximum: 65535 dns-records_proxied: type: boolean description: Whether the record is receiving the performance and security benefits of Cloudflare. example: false dns-records_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 dns-records_search: type: string description: | Allows searching in multiple properties of a DNS record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future. This parameter works independently of the `match` setting. For automated searches, please use the other available parameters. example: www.cloudflare.com dns-records_tag_match: type: string description: | Whether to match all tag search requirements or at least one (any). If set to `all`, acts like a logical AND between tag filters. If set to `any`, acts like a logical OR instead. Note that the regular `match` parameter is still used to combine the resulting condition with other filters that aren't related to tags. enum: - any - all default: all example: any dns-records_tags: type: array description: Custom tags for the DNS record. This field has no effect on DNS responses. items: type: string description: Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens) example: owner:dns-team dns-records_ttl: anyOf: - type: number example: 3600 minimum: 30 maximum: 86400 - type: number enum: - 1 type: number description: Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones. default: 1 example: 3600 dns-records_type: type: string description: Record type. enum: - A - AAAA - CAA - CERT - CNAME - DNSKEY - DS - HTTPS - LOC - MX - NAPTR - NS - PTR - SMIMEA - SRV - SSHFP - SVCB - TLSA - TXT - URI example: A dns-settings_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/dns-settings_messages' messages: $ref: '#/components/schemas/dns-settings_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true dns-settings_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false dns-settings_api-response-single: allOf: - $ref: '#/components/schemas/dns-settings_api-response-common' - properties: result: anyOf: - type: object - type: string type: object dns-settings_dns-settings: type: object properties: 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' secondary_overrides: $ref: '#/components/schemas/dns-settings_secondary_overrides' dns-settings_dns_response_single: allOf: - $ref: '#/components/schemas/dns-settings_api-response-single' - type: object required: - nameservers - foundation_dns - multi_provider - secondary_overrides properties: result: $ref: '#/components/schemas/dns-settings_dns-settings' dns-settings_foundation_dns: type: boolean description: Whether to enable Foundation DNS Advanced Nameservers on the zone. example: false dns-settings_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 dns-settings_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string dns-settings_multi_provider: type: boolean 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 dns-settings_nameservers: type: object description: Settings determining the nameservers through which the zone should be available. required: - type properties: type: type: string description: Nameserver type enum: - cloudflare.standard example: cloudflare.standard dns-settings_secondary_overrides: type: boolean description: Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex. example: false dnssec_algorithm: type: string description: Algorithm key code. example: "13" nullable: true readOnly: true dnssec_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/dnssec_messages' messages: $ref: '#/components/schemas/dnssec_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true dnssec_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/dnssec_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/dnssec_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false 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: type: string example: "" dnssec_digest: type: string description: Digest hash. example: 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45 nullable: true readOnly: true dnssec_digest_algorithm: type: string description: Type of digest algorithm. example: SHA256 nullable: true readOnly: true dnssec_digest_type: type: string description: Coded type for digest algorithm. example: "2" nullable: true readOnly: true dnssec_dnssec: type: object properties: algorithm: $ref: '#/components/schemas/dnssec_algorithm' digest: $ref: '#/components/schemas/dnssec_digest' digest_algorithm: $ref: '#/components/schemas/dnssec_digest_algorithm' digest_type: $ref: '#/components/schemas/dnssec_digest_type' dnssec_multi_signer: $ref: '#/components/schemas/dnssec_dnssec_multi_signer' dnssec_presigned: $ref: '#/components/schemas/dnssec_dnssec_presigned' ds: $ref: '#/components/schemas/dnssec_ds' flags: $ref: '#/components/schemas/dnssec_flags' key_tag: $ref: '#/components/schemas/dnssec_key_tag' key_type: $ref: '#/components/schemas/dnssec_key_type' modified_on: $ref: '#/components/schemas/dnssec_modified_on' public_key: $ref: '#/components/schemas/dnssec_public_key' status: $ref: '#/components/schemas/dnssec_status' dnssec_dnssec_multi_signer: type: boolean description: |- If true, multi-signer DNSSEC is enabled on the zone, allowing multiple providers to serve a DNSSEC-signed zone at the same time. This is required for DNSKEY records (except those automatically generated by Cloudflare) to be added to the zone. See [Multi-signer DNSSEC](https://developers.cloudflare.com/dns/dnssec/multi-signer-dnssec/) for details. example: false dnssec_dnssec_presigned: type: boolean description: |- If true, allows Cloudflare to transfer in a DNSSEC-signed zone including signatures from an external provider, without requiring Cloudflare to sign any records on the fly. Note that this feature has some limitations. See [Cloudflare as Secondary](https://developers.cloudflare.com/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup/#dnssec) for details. example: true dnssec_dnssec_response_single: allOf: - $ref: '#/components/schemas/dnssec_api-response-single' - properties: result: $ref: '#/components/schemas/dnssec_dnssec' dnssec_ds: type: string description: Full DS record. example: example.com. 3600 IN DS 16953 13 2 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45 nullable: true readOnly: true dnssec_flags: type: number description: Flag for DNSSEC record. example: 257 nullable: true readOnly: true dnssec_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 dnssec_key_tag: type: number description: Code for key tag. example: 42 nullable: true readOnly: true dnssec_key_type: type: string description: Algorithm key type. example: ECDSAP256SHA256 nullable: true readOnly: true dnssec_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string dnssec_modified_on: type: string format: date-time description: When DNSSEC was last modified. example: "2014-01-01T05:20:00Z" nullable: true readOnly: true dnssec_public_key: type: string description: Public key for DS record. example: oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA== nullable: true readOnly: true 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 dweb-config_api-response-collection: allOf: - $ref: '#/components/schemas/dweb-config_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/dweb-config_result_info' type: object dweb-config_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/dweb-config_messages' messages: $ref: '#/components/schemas/dweb-config_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true dweb-config_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/dweb-config_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/dweb-config_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false dweb-config_api-response-single: allOf: - $ref: '#/components/schemas/dweb-config_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object dweb-config_api-response-single-id: allOf: - $ref: '#/components/schemas/dweb-config_api-response-common' - properties: result: type: object nullable: true required: - id properties: id: $ref: '#/components/schemas/dweb-config_identifier' type: object dweb-config_collection_response: allOf: - $ref: '#/components/schemas/dweb-config_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/dweb-config_web3-hostname' dweb-config_content_list_action: type: string description: Behavior of the content list. enum: - block example: block dweb-config_content_list_details: type: object properties: action: $ref: '#/components/schemas/dweb-config_content_list_action' dweb-config_content_list_details_response: allOf: - $ref: '#/components/schemas/dweb-config_api-response-single' - properties: result: $ref: '#/components/schemas/dweb-config_content_list_details' dweb-config_content_list_entries: type: array description: Content list entries. items: $ref: '#/components/schemas/dweb-config_content_list_entry' dweb-config_content_list_entry: type: object description: Content list entry to be blocked. properties: content: $ref: '#/components/schemas/dweb-config_content_list_entry_content' created_on: $ref: '#/components/schemas/dweb-config_timestamp' description: $ref: '#/components/schemas/dweb-config_content_list_entry_description' id: $ref: '#/components/schemas/dweb-config_identifier' modified_on: $ref: '#/components/schemas/dweb-config_timestamp' type: $ref: '#/components/schemas/dweb-config_content_list_entry_type' dweb-config_content_list_entry_collection_response: allOf: - $ref: '#/components/schemas/dweb-config_api-response-collection' - properties: result: type: object properties: entries: $ref: '#/components/schemas/dweb-config_content_list_entries' dweb-config_content_list_entry_content: type: string description: CID or content path of content to block. example: QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB maxLength: 500 dweb-config_content_list_entry_create_request: type: object required: - type - content properties: content: $ref: '#/components/schemas/dweb-config_content_list_entry_content' description: $ref: '#/components/schemas/dweb-config_content_list_entry_description' type: $ref: '#/components/schemas/dweb-config_content_list_entry_type' dweb-config_content_list_entry_description: type: string description: An optional description of the content list entry. example: this is my content list entry maxLength: 500 dweb-config_content_list_entry_single_response: allOf: - $ref: '#/components/schemas/dweb-config_api-response-single' - properties: result: $ref: '#/components/schemas/dweb-config_content_list_entry' dweb-config_content_list_entry_type: type: string description: Type of content list entry to block. enum: - cid - content_path example: cid dweb-config_content_list_update_request: type: object required: - action - entries properties: action: $ref: '#/components/schemas/dweb-config_content_list_action' entries: $ref: '#/components/schemas/dweb-config_content_list_entries' dweb-config_create_request: type: object required: - name - target properties: description: $ref: '#/components/schemas/dweb-config_description' dnslink: $ref: '#/components/schemas/dweb-config_dnslink' name: $ref: '#/components/schemas/dweb-config_name' target: $ref: '#/components/schemas/dweb-config_target' dweb-config_description: type: string description: An optional description of the hostname. example: This is my IPFS gateway. maxLength: 500 dweb-config_dnslink: type: string description: DNSLink value used if the target is ipfs. example: /ipns/onboarding.ipfs.cloudflare.com dweb-config_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 dweb-config_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string dweb-config_modify_request: type: object properties: description: $ref: '#/components/schemas/dweb-config_description' dnslink: $ref: '#/components/schemas/dweb-config_dnslink' dweb-config_name: type: string description: The hostname that will point to the target gateway via CNAME. example: gateway.example.com readOnly: true maxLength: 255 dweb-config_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 dweb-config_single_response: allOf: - $ref: '#/components/schemas/dweb-config_api-response-single' - properties: result: $ref: '#/components/schemas/dweb-config_web3-hostname' dweb-config_status: type: string description: Status of the hostname's activation. enum: - active - pending - deleting - error example: active readOnly: true dweb-config_target: type: string description: Target gateway of the hostname. enum: - ethereum - ipfs - ipfs_universal_path example: ipfs dweb-config_timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true dweb-config_web3-hostname: type: object properties: created_on: $ref: '#/components/schemas/dweb-config_timestamp' description: $ref: '#/components/schemas/dweb-config_description' dnslink: $ref: '#/components/schemas/dweb-config_dnslink' id: $ref: '#/components/schemas/dweb-config_identifier' modified_on: $ref: '#/components/schemas/dweb-config_timestamp' name: $ref: '#/components/schemas/dweb-config_name' status: $ref: '#/components/schemas/dweb-config_status' target: $ref: '#/components/schemas/dweb-config_target' email_account_identifier: $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: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/email_result_info' type: object email_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/email_messages' messages: $ref: '#/components/schemas/email_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true email_api-response-single: allOf: - $ref: '#/components/schemas/email_api-response-common' - properties: result: anyOf: - type: object - type: string type: object email_catch_all_rule: type: object properties: actions: $ref: '#/components/schemas/email_rule_catchall-actions' enabled: $ref: '#/components/schemas/email_rule_enabled' id: $ref: '#/components/schemas/email_rule_identifier' matchers: $ref: '#/components/schemas/email_rule_catchall-matchers' name: $ref: '#/components/schemas/email_rule_name' tag: $ref: '#/components/schemas/email_rule_tag' 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: type: object required: - email properties: email: $ref: '#/components/schemas/email_email' email_create_rule_properties: type: object required: - actions - matchers properties: actions: $ref: '#/components/schemas/email_rule_actions' enabled: $ref: '#/components/schemas/email_rule_enabled' matchers: $ref: '#/components/schemas/email_rule_matchers' name: $ref: '#/components/schemas/email_rule_name' priority: $ref: '#/components/schemas/email_rule_priority' email_created: type: string format: date-time description: The date and time the destination address has been created. example: "2014-01-02T02:20:00Z" readOnly: true email_destination_address_identifier: type: string description: Destination address identifier. example: ea95132c15732412d22c1476fa83f27a readOnly: true maxLength: 32 email_destination_address_properties: type: object 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' email_destination_address_response_single: allOf: - $ref: '#/components/schemas/email_api-response-single' - properties: result: $ref: '#/components/schemas/email_addresses' email_destination_address_tag: type: string description: Destination address tag. (Deprecated, replaced by destination address identifier) example: ea95132c15732412d22c1476fa83f27a readOnly: true deprecated: true maxLength: 32 email_destination_addresses_response_collection: allOf: - $ref: '#/components/schemas/email_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/email_addresses' result_info: type: object properties: count: example: 1 page: example: 1 per_page: example: 20 total_count: example: 1 email_dns_record: type: object description: List of records needed to enable an Email Routing zone. properties: content: type: string description: DNS record content. example: route1.mx.cloudflare.net name: type: string description: DNS record name (or @ for the zone apex). example: example.com maxLength: 255 priority: type: number description: Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred. example: 12 minimum: 0 maximum: 65535 ttl: anyOf: - type: number example: 3600 minimum: 1 maximum: 86400 - type: number enum: - 1 type: number description: Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'. example: 1 type: type: string description: DNS record type. enum: - A - AAAA - CNAME - HTTPS - TXT - SRV - LOC - MX - NS - CERT - DNSKEY - DS - NAPTR - SMIMEA - SSHFP - SVCB - TLSA - URI example: NS readOnly: true email_dns_settings_response_collection: allOf: - $ref: '#/components/schemas/email_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/email_dns_record' email_email: type: string description: The contact email address of the user. example: user@example.com maxLength: 90 email_email_setting_created: type: string format: date-time description: The date and time the settings have been created. example: "2014-01-02T02:20:00Z" readOnly: true email_email_setting_enabled: type: boolean description: State of the zone settings for Email Routing. enum: - true - false default: true example: true email_email_setting_identifier: type: string description: Email Routing settings identifier. example: 75610dab9e69410a82cf7e400a09ecec readOnly: true maxLength: 32 email_email_setting_modified: type: string format: date-time description: The date and time the settings have been modified. example: "2014-01-02T02:20:00Z" readOnly: true email_email_setting_name: type: string description: Domain of your zone. example: example.net readOnly: true email_email_setting_skip-wizard: type: boolean description: Flag to check if the user skipped the configuration wizard. enum: - true - false default: true example: true email_email_setting_status: type: string description: Show the state of your account, and the type or configuration error. enum: - ready - unconfigured - misconfigured - misconfigured/locked - unlocked example: ready readOnly: true email_email_setting_tag: type: string description: Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier) example: 75610dab9e69410a82cf7e400a09ecec readOnly: true deprecated: true maxLength: 32 email_email_settings_properties: type: object properties: created: $ref: '#/components/schemas/email_email_setting_created' enabled: $ref: '#/components/schemas/email_email_setting_enabled' id: $ref: '#/components/schemas/email_email_setting_identifier' modified: $ref: '#/components/schemas/email_email_setting_modified' name: $ref: '#/components/schemas/email_email_setting_name' skip_wizard: $ref: '#/components/schemas/email_email_setting_skip-wizard' status: $ref: '#/components/schemas/email_email_setting_status' tag: $ref: '#/components/schemas/email_email_setting_tag' email_email_settings_response_single: allOf: - $ref: '#/components/schemas/email_api-response-single' - properties: result: $ref: '#/components/schemas/email_settings' email_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 email_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string email_modified: type: string format: date-time description: The date and time the destination address was last modified. example: "2014-01-02T02:20:00Z" readOnly: true email_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 email_rule_action: type: object description: Actions pattern. required: - type - value properties: type: type: string description: Type of supported action. enum: - drop - forward - worker example: forward value: type: array items: type: string description: Value for action. example: destinationaddress@example.net maxLength: 90 email_rule_actions: type: array description: List actions patterns. items: $ref: '#/components/schemas/email_rule_action' email_rule_catchall-action: type: object description: Action for the catch-all routing rule. required: - type properties: type: type: string description: Type of action for catch-all rule. enum: - drop - forward - worker example: forward value: type: array items: type: string description: Input value for action. example: destinationaddress@example.net maxLength: 90 email_rule_catchall-actions: type: array description: List actions for the catch-all routing rule. items: $ref: '#/components/schemas/email_rule_catchall-action' email_rule_catchall-matcher: type: object description: Matcher for catch-all routing rule. required: - type properties: type: type: string description: Type of matcher. Default is 'all'. enum: - all example: all email_rule_catchall-matchers: type: array description: List of matchers for the catch-all routing rule. items: $ref: '#/components/schemas/email_rule_catchall-matcher' email_rule_enabled: type: boolean description: Routing rule status. enum: - true - false default: true example: true email_rule_identifier: type: string description: Routing rule identifier. example: a7e6fb77503c41d8a7f3113c6918f10c readOnly: true maxLength: 32 email_rule_matcher: type: object description: Matching pattern to forward your actions. required: - type - field - value properties: field: type: string description: Field for type matcher. enum: - to example: to type: type: string description: Type of matcher. enum: - literal example: literal value: type: string description: Value for matcher. example: test@example.com maxLength: 90 email_rule_matchers: type: array description: Matching patterns to forward to your actions. items: $ref: '#/components/schemas/email_rule_matcher' email_rule_name: type: string description: Routing rule name. example: Send to user@example.net rule. maxLength: 256 email_rule_priority: type: number description: Priority of the routing rule. default: 0 minimum: 0 email_rule_properties: type: object properties: actions: $ref: '#/components/schemas/email_rule_actions' enabled: $ref: '#/components/schemas/email_rule_enabled' id: $ref: '#/components/schemas/email_rule_identifier' matchers: $ref: '#/components/schemas/email_rule_matchers' name: $ref: '#/components/schemas/email_rule_name' priority: $ref: '#/components/schemas/email_rule_priority' tag: $ref: '#/components/schemas/email_rule_tag' email_rule_response_single: allOf: - $ref: '#/components/schemas/email_api-response-single' - properties: result: $ref: '#/components/schemas/email_rules' email_rule_tag: type: string description: Routing rule tag. (Deprecated, replaced by routing rule identifier) example: a7e6fb77503c41d8a7f3113c6918f10c readOnly: true deprecated: true maxLength: 32 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: type: array items: $ref: '#/components/schemas/email_rules' result_info: type: object properties: count: example: 1 page: example: 1 per_page: example: 20 total_count: example: 1 email_settings: allOf: - $ref: '#/components/schemas/email_email_settings_properties' type: object email_update_catch_all_rule_properties: type: object required: - actions - matchers properties: actions: $ref: '#/components/schemas/email_rule_catchall-actions' enabled: $ref: '#/components/schemas/email_rule_enabled' matchers: $ref: '#/components/schemas/email_rule_catchall-matchers' name: $ref: '#/components/schemas/email_rule_name' email_update_rule_properties: type: object required: - actions - matchers properties: actions: $ref: '#/components/schemas/email_rule_actions' enabled: $ref: '#/components/schemas/email_rule_enabled' matchers: $ref: '#/components/schemas/email_rule_matchers' name: $ref: '#/components/schemas/email_rule_name' priority: $ref: '#/components/schemas/email_rule_priority' email_verified: type: string format: date-time description: The date and time the destination address has been verified. Null means not verified yet. example: "2014-01-02T02:20:00Z" readOnly: true email_zone_identifier: $ref: '#/components/schemas/email_identifier' firewall_account_identifier: {} firewall_action: anyOf: - type: object 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. firewall_action_mode: type: string description: The default action performed by the rules in the WAF package. enum: - simulate - block - challenge default: challenge firewall_action_parameters: oneOf: - $ref: '#/components/schemas/firewall_action_parameters_route' type: object description: The parameters configuring the action. firewall_action_parameters_redirect: description: The configuration parameters for the redirect action. properties: from_value: type: object description: The parameters that control the redirect. properties: preserve_query_string: type: boolean description: Whether the query string for the request should be carried to the redirect's target url. example: true status_code: type: integer description: The status code to use for the redirect. target_url: oneOf: - type: object properties: expression: type: string description: An expression defining a dynamic value for the target url of the redirect. example: concat(http.request.full_uri, "/latest") - type: object properties: value: type: string description: The value defining the target url of the redirect. example: https://example.com/blog/latest firewall_action_parameters_rewrite: description: The configuration parameters for the rewrite action. properties: uri: type: object description: The URI rewrite configuration to rewrite the URI path, the query string, or both. properties: path: description: The new URI path sent to the origin. query: description: The new query string sent to the origin. firewall_action_parameters_route: description: The configuration parameters for the route action. properties: host_header: type: string description: The value of the Host header. example: foo.example.com origin: type: object description: The parameters that control where the origin is. properties: host: type: string description: The host to use for origin. example: foo.example.com port: type: integer description: The port to use for origin. sni: type: object description: The parameters that control the SNI. properties: value: type: string description: The SNI used to connect to the origin. example: foo.example.com firewall_action_parameters_set_cache_settings: description: The configuration parameters for the set_cache_settings action. properties: browser_ttl: type: object description: Set the Browser TTL. properties: default: type: integer mode: type: string example: override_origin cache_key: type: object description: Set the Cache TTL. properties: cache_deception_armor: type: boolean example: true custom_key: type: object properties: cookie: type: object properties: check_presence: type: array example: - cookie_1 items: {} include: type: array example: - cookie1 items: {} header: type: object properties: check_presence: type: array example: - header_1 items: {} include: type: array example: - header1 items: {} host: type: object properties: resolved: type: boolean example: false query_string: type: object properties: include: type: string example: '*' user: type: object properties: device_type: type: boolean example: true geo: type: boolean example: false lang: type: boolean example: false ignore_query_strings_order: type: boolean example: true edge_ttl: type: object description: Set the Cache TTL. properties: mode: type: string example: respect_origin status_code_ttl: type: object properties: status_code: type: integer value: type: integer origin_error_page_passthru: type: boolean example: true respect_strong_etags: type: boolean example: true serve_stale: type: object properties: disable_stale_while_updating: type: boolean example: true firewall_action_parameters_set_config: description: The configuration parameters for the set_config action. properties: automatic_https_rewrites: type: boolean description: Enable or disable Automatic HTTPS Rewrites for matching requests example: true autominify: type: object description: Select which file extensions to minify automatically. properties: css: type: boolean example: true html: type: boolean example: true js: type: boolean example: true bic: type: boolean description: Enable or disable Browser Integrity Check example: true disable_apps: type: boolean description: Disable all active Cloudflare Apps example: true disable_railgun: type: boolean description: Disable Cloudflare Railgun example: true disable_zaraz: type: boolean description: Disable Cloudflare Railgun example: true email_obfuscation: type: boolean description: Enable or disable Email Obfuscation example: false hotlink_protection: type: boolean description: Enable or disable Hotlink Protection example: false mirage: type: boolean description: Enable or disable Mirage example: false opportunistic_encryption: type: boolean description: Enable or disableOpportunistic Encryption example: false polish: type: string description: Set Polish compression options example: lossless rocket_loader: type: boolean description: Enable or disable Rocket Loader example: false security_level: type: string description: Set the Security Level example: low server_side_excludes: type: boolean description: Enable or disable Server Side Excludes example: false ssl: type: string description: Select the SSL encryption mode example: flexible sxg: type: boolean description: Enable or disable Signed Exchangesn(SXG) example: false firewall_anomaly_description: type: string description: A summary of the purpose/function of the WAF package. example: Covers OWASP Top 10 vulnerabilities and more. readOnly: true firewall_anomaly_detection_mode: type: string description: When a WAF package uses anomaly detection, each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined on the WAF package, the action defined on the package will be taken. example: anomaly readOnly: true firewall_anomaly_name: type: string description: The name of the WAF package. example: OWASP ModSecurity Core Rule Set readOnly: true 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' title: Anomaly detection WAF package (OWASP) required: - id - name - description - zone_id - detection_mode - sensitivity - action_mode firewall_api-response-collection: allOf: - $ref: '#/components/schemas/firewall_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/firewall_result_info' type: object firewall_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/firewall_messages' messages: $ref: '#/components/schemas/firewall_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true firewall_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false firewall_api-response-single: allOf: - $ref: '#/components/schemas/firewall_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object firewall_api-response-single-id: allOf: - $ref: '#/components/schemas/firewall_api-response-common' - properties: result: type: object nullable: true required: - id properties: id: $ref: '#/components/schemas/firewall_identifier' type: object firewall_asn_configuration: title: An ASN configuration. properties: target: description: The configuration target. You must set the target to `asn` when specifying an Autonomous System Number (ASN) in the rule. enum: - asn example: asn value: type: string description: The AS number to match. example: AS12345 firewall_body: type: string description: The response body to return. The value must conform to the configured content type. example: This request has been rate-limited. maxLength: 10240 firewall_bypass: type: array description: Criteria specifying when the current rate limit should be bypassed. You can specify that the rate limit should not apply to one or more URLs. items: type: object properties: name: type: string enum: - url example: url value: type: string description: The URL to bypass. example: api.example.com/* firewall_cache-rules_components-schemas-action_parameters: oneOf: - $ref: '#/components/schemas/firewall_action_parameters_set_cache_settings' type: object description: The parameters configuring the action. 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: type: array description: The rules in the ruleset. items: $ref: '#/components/schemas/firewall_cache-rules_components-schemas-rule' firewall_cidr_configuration: title: An IP address range configuration. properties: target: description: The configuration target. You must set the target to `ip_range` when specifying an IP address range in the rule. enum: - ip_range example: ip_range value: type: string description: The IP address range to match. You can only use prefix lengths `/16` and `/24` for IPv4 ranges, and prefix lengths `/32`, `/48`, and `/64` for IPv6 ranges. example: 198.51.100.4/16 firewall_components-schemas-action: type: string description: The action to perform when the rule matches. example: execute pattern: ^[a-z_]+$ firewall_components-schemas-action_parameters: oneOf: - $ref: '#/components/schemas/firewall_action_parameters_redirect' type: object description: The parameters configuring the action. firewall_components-schemas-description: type: string description: An informative summary of the current URI-based WAF override. example: Enable Cloudflare Magento ruleset for shop.example.com nullable: true maxLength: 1024 firewall_components-schemas-id: type: string description: The unique identifier of the User Agent Blocking rule. example: 372e67954025e0ba6aaa6d586b9e0b59 readOnly: true maxLength: 32 firewall_components-schemas-identifier: {} 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: type: boolean description: When true, indicates that the firewall rule is currently paused. example: false firewall_components-schemas-priority: type: number description: The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority. example: 50 minimum: 0 maximum: 2.147483647e+09 firewall_components-schemas-ref: type: string description: The reference of the rule (the rule ID by default). example: my_ref 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: type: array description: The rules in the ruleset. items: $ref: '#/components/schemas/firewall_config-rules_components-schemas-rule' firewall_config-rules_components-schemas-action_parameters: oneOf: - $ref: '#/components/schemas/firewall_action_parameters_set_config' type: object description: The parameters configuring the action. 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: 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 description: The rule configuration. firewall_configurations: anyOf: - $ref: '#/components/schemas/firewall_schemas-ip_configuration' - $ref: '#/components/schemas/firewall_schemas-cidr_configuration' type: array description: A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations. items: anyOf: - $ref: '#/components/schemas/firewall_schemas-ip_configuration' - $ref: '#/components/schemas/firewall_schemas-cidr_configuration' firewall_content_type: type: string description: 'The content type of the body. Must be one of the following: `text/plain`, `text/xml`, or `application/json`.' example: text/xml maxLength: 50 firewall_country_configuration: title: A country configuration. properties: target: description: The configuration target. You must set the target to `country` when specifying a country code in the rule. enum: - country example: country value: type: string description: 'The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to [IP Access rules: Parameters](https://developers.cloudflare.com/waf/tools/ip-access-rules/parameters/#country).' example: US firewall_create_update_rule: type: object description: A rule object. required: - expression - action 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' firewall_create_update_rules: type: array description: The list of rules in the ruleset. items: anyOf: - $ref: '#/components/schemas/firewall_create_update_rule' - description: The unique ID of a rule. firewall_created_on: type: string format: date-time description: The timestamp of when the rule was created. example: "2014-01-01T05:20:00.12345Z" readOnly: true firewall_custom_response: anyOf: - type: object 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. firewall_delete_filter_if_unused: type: boolean description: When true, indicates that Cloudflare should also delete the associated filter if there are no other firewall rules referencing the filter. firewall_deleted: type: boolean description: When true, indicates that the firewall rule was deleted. example: true firewall_deleted-filter: required: - id - deleted properties: deleted: $ref: '#/components/schemas/firewall_deleted' id: $ref: '#/components/schemas/firewall_filters_components-schemas-id' firewall_description: type: string description: An informative summary of the rate limit. This value is sanitized and any tags will be removed. example: Prevent multiple login failures to mitigate brute force attacks maxLength: 1024 firewall_description_search: type: string description: A string to search for in the description of existing rules. example: abusive firewall_detection_mode: type: string description: The mode that defines how rules within the package are evaluated during the course of a request. When a package uses anomaly detection mode (`anomaly` value), each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined in the WAF package, the action configured in the package will be performed. Traditional detection mode (`traditional` value) will decide the action to take when it is triggered by the request. If multiple rules are triggered, the action providing the highest protection will be applied (for example, a 'block' action will win over a 'challenge' action). enum: - anomaly - traditional example: traditional readOnly: true firewall_disabled: type: boolean description: When true, indicates that the rate limit is currently disabled. example: false 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_egs-pagination: type: object properties: page: type: number description: The page number of paginated results. default: 1 minimum: 1 per_page: type: number description: The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`. default: 20 minimum: 1 maximum: 1000 firewall_email: type: string description: The contact email address of the user. example: user@example.com maxLength: 90 firewall_enabled: type: boolean description: Whether the rule should be executed. default: "true" example: true firewall_expression: type: string description: The filter expression. For more information, refer to [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/). example: (http.request.uri.path ~ ".*wp-login.php" or http.request.uri.path ~ ".*xmlrpc.php") and ip.addr ne 172.16.22.155 firewall_filter: type: object 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' firewall_filter-delete-response-collection: allOf: - $ref: '#/components/schemas/firewall_api-response-collection' - type: object properties: result: type: array items: allOf: - $ref: '#/components/schemas/firewall_filter' - type: object required: - id firewall_filter-delete-response-single: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - type: object required: - result properties: result: allOf: - $ref: '#/components/schemas/firewall_filter' - type: object required: - id firewall_filter-response-collection: allOf: - $ref: '#/components/schemas/firewall_api-response-collection' - type: object properties: result: type: array items: allOf: - $ref: '#/components/schemas/firewall_filter' - type: object required: - id - expression - paused firewall_filter-response-single: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - type: object required: - result properties: result: $ref: '#/components/schemas/firewall_filter' firewall_filter-rule-base: type: object 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' 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' - type: object required: - result properties: result: type: array items: allOf: - $ref: '#/components/schemas/firewall_filter-rule-response' - type: object required: - id - filter - action - paused firewall_filter-rules-response-collection-delete: allOf: - $ref: '#/components/schemas/firewall_api-response-collection' - type: object required: - result properties: result: type: array items: allOf: - $ref: '#/components/schemas/firewall_filter-rule-response' - type: object required: - id firewall_filter-rules-single-response: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - type: object required: - result properties: result: allOf: - $ref: '#/components/schemas/firewall_filter-rule-response' - type: object required: - id - filter - action - paused firewall_filter-rules-single-response-delete: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - type: object required: - result properties: result: allOf: - $ref: '#/components/schemas/firewall_filter-rule-response' - type: object required: - id firewall_filters: type: object properties: configuration.target: type: string description: The target to search in existing rules. enum: - ip - ip_range - asn - country example: ip configuration.value: type: string description: |- The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`. Notes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code. example: 198.51.100.4 match: type: string description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match. enum: - any - all default: all mode: $ref: '#/components/schemas/firewall_schemas-mode' notes: type: string description: |- The string to search for in the notes of existing IP Access rules. Notes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive. example: my note firewall_filters_components-schemas-description: type: string description: An informative summary of the filter. example: Restrict access from these browsers on this address range. maxLength: 500 firewall_filters_components-schemas-id: type: string description: The unique identifier of the filter. example: 372e67954025e0ba6aaa6d586b9e0b61 readOnly: true minLength: 32 maxLength: 32 firewall_filters_components-schemas-paused: type: boolean description: When true, indicates that the filter is currently paused. example: false firewall_firewall-rules_components-schemas-description: type: string description: An informative summary of the firewall rule. example: Blocks traffic identified during investigation for MIR-31 maxLength: 500 firewall_firewall-rules_components-schemas-id: type: string description: The unique identifier of the firewall rule. example: 372e67954025e0ba6aaa6d586b9e0b60 readOnly: true maxLength: 32 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' - type: object properties: result: type: array items: $ref: '#/components/schemas/firewall_ua-rules' firewall_firewalluablock_response_single: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - type: object properties: result: type: object firewall_groups: type: object description: An object that allows you to enable or disable WAF rule groups for the current WAF override. Each key of this object must be the ID of a WAF rule group, and each value must be a valid WAF action (usually `default` or `disable`). When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object. example: ea8687e59929c1fd05ba97574ad43f77: default firewall_header_name: type: string description: The name of the response header to match. example: Cf-Cache-Status firewall_header_op: type: string description: 'The operator used when matching: `eq` means "equal" and `ne` means "not equal".' enum: - eq - ne example: ne firewall_header_value: type: string description: The value of the response header, which must match exactly. example: HIT firewall_id: type: string description: The unique identifier of the rate limit. example: 372e67954025e0ba6aaa6d586b9e0b59 readOnly: true maxLength: 32 firewall_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 firewall_ip_configuration: title: An IP address configuration. properties: target: description: The configuration target. You must set the target to `ip` when specifying an IP address in the rule. enum: - ip example: ip value: type: string description: The IP address to match. This address will be compared to the IP address of incoming requests. example: 198.51.100.4 firewall_ip_range_search: type: string description: A single IP address range to search for in existing rules. example: 1.2.3.0/16 firewall_ip_search: type: string description: A single IP address to search for in existing rules. example: 1.2.3.4 firewall_ipv6_configuration: title: An IPv6 address configuration. properties: target: description: The configuration target. You must set the target to `ip6` when specifying an IPv6 address in the rule. enum: - ip6 example: ip6 value: type: string description: The IPv6 address to match. example: 2001:DB8:100::CF firewall_lockdowns_components-schemas-description: type: string description: An informative summary of the rule. example: Restrict access to these endpoints to requests from a known IP address maxLength: 1024 firewall_lockdowns_components-schemas-id: type: string description: The unique identifier of the Zone Lockdown rule. example: 372e67954025e0ba6aaa6d586b9e0b59 readOnly: true maxLength: 32 firewall_logging: type: object description: An object configuring the rule's logging behavior. example: enabled: true properties: enabled: type: boolean description: Whether to generate a log when the rule matches. example: true firewall_match: oneOf: - type: object properties: headers: type: array items: type: object properties: name: $ref: '#/components/schemas/firewall_header_name' op: $ref: '#/components/schemas/firewall_header_op' value: $ref: '#/components/schemas/firewall_header_value' request: type: object properties: methods: $ref: '#/components/schemas/firewall_methods' schemes: $ref: '#/components/schemas/firewall_schemes' url: $ref: '#/components/schemas/firewall_url' response: type: object properties: origin_traffic: $ref: '#/components/schemas/firewall_origin_traffic' type: object description: Determines which traffic the rate limit counts towards the threshold. firewall_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string firewall_methods: type: array description: The HTTP methods to match. You can specify a subset (for example, `['POST','PUT']`) or all methods (`['_ALL_']`). This field is optional when creating a rate limit. example: - GET - POST items: type: string description: An HTTP method or `_ALL_` to indicate all methods. enum: - GET - POST - PUT - DELETE - PATCH - HEAD - _ALL_ example: GET firewall_mode: type: string description: The action to perform. enum: - simulate - ban - challenge - js_challenge - managed_challenge example: challenge firewall_modified_on: type: string format: date-time description: The timestamp of when the rule was last modified. example: "2014-01-01T05:20:00.12345Z" readOnly: true firewall_name: type: string description: The name of the WAF package. example: USER readOnly: true firewall_notes: type: string description: An informative summary of the rule, typically used as a reminder or explanation. example: This rule is enabled because of an event that occurred on date X. firewall_origin_traffic: type: boolean description: |- When true, only the uncached traffic served from your origin servers will count towards rate limiting. In this case, any cached traffic served by Cloudflare will not count towards rate limiting. This field is optional. Notes: This field is deprecated. Instead, use response headers and set "origin_traffic" to "false" to avoid legacy behaviour interacting with the "response_headers" property. 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' - type: object required: - result properties: result: type: array items: allOf: - $ref: '#/components/schemas/firewall_override' - type: object required: - id - paused - urls - priority firewall_override_response_single: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - type: object required: - result properties: result: $ref: '#/components/schemas/firewall_override' firewall_package: oneOf: - $ref: '#/components/schemas/firewall_package_definition' - $ref: '#/components/schemas/firewall_anomaly_package' type: object firewall_package_definition: title: Traditional WAF package required: - id - name - description - detection_mode - zone_id 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' firewall_package_response_collection: anyOf: - $ref: '#/components/schemas/firewall_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/firewall_package' firewall_package_response_single: oneOf: - $ref: '#/components/schemas/firewall_api-response-single' - properties: result: type: object firewall_paused: type: boolean description: When true, indicates that the WAF package is currently paused. firewall_period: type: number description: The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action. example: 900 minimum: 10 maximum: 86400 firewall_phase: type: string description: The phase where the ruleset is executed. enum: - http_request_transform - http_request_late_transform - http_response_headers_transform firewall_priority: type: number description: The relative priority of the current URI-based WAF override when multiple overrides match a single URL. A lower number indicates higher priority. Higher priority overrides may overwrite values set by lower priority overrides. example: 1 minimum: -1e+09 maximum: 1e+09 firewall_products: type: array items: type: string description: A list of products to bypass for a request when using the `bypass` action. enum: - zoneLockdown - uaBlock - bic - hot - securityLevel - rateLimit - waf example: waf 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' - type: object properties: result: type: array items: $ref: '#/components/schemas/firewall_rate-limits' firewall_ratelimit_response_single: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - type: object properties: result: type: object firewall_ref: type: string description: A short reference tag. Allows you to select related firewall rules. example: MIR-31 maxLength: 50 firewall_response_collection: allOf: - $ref: '#/components/schemas/firewall_api-response-collection' - type: object properties: result: type: array items: type: object firewall_response_single: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - type: object properties: result: type: object firewall_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 firewall_rewrite_action: type: object description: Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object. properties: block: $ref: '#/components/schemas/firewall_waf_rewrite_action' challenge: example: block default: example: block disable: $ref: '#/components/schemas/firewall_waf_rewrite_action' simulate: example: disable firewall_rule: type: object required: - id - mode - allowed_modes - configuration properties: allowed_modes: type: array description: The available actions that a rule can apply to a matched request. example: - whitelist - block - challenge - js_challenge - managed_challenge readOnly: true items: $ref: '#/components/schemas/firewall_schemas-mode' configuration: $ref: '#/components/schemas/firewall_configuration' created_on: type: string format: date-time description: The timestamp of when the rule was created. example: "2014-01-01T05:20:00.12345Z" readOnly: true id: $ref: '#/components/schemas/firewall_schemas-identifier' mode: $ref: '#/components/schemas/firewall_schemas-mode' modified_on: type: string format: date-time description: The timestamp of when the rule was last modified. example: "2014-01-01T05:20:00.12345Z" readOnly: true notes: $ref: '#/components/schemas/firewall_notes' firewall_rule_collection_response: allOf: - $ref: '#/components/schemas/firewall_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/firewall_rule' firewall_rule_single_id_response: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/firewall_schemas-identifier' firewall_rule_single_response: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - properties: result: $ref: '#/components/schemas/firewall_rule' firewall_rules: type: object description: An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object. example: "100015": disable firewall_rules_components-schemas-description: type: string description: An informative description of the rule. default: "" example: Execute the OWASP ruleset when the IP address is not 1.1.1.1 firewall_ruleset: properties: description: example: "" id: example: 2f2feab2026849078ba485f918791bdc kind: example: zone name: example: default phase: example: http_request_origin rules: type: array description: The rules in the ruleset. items: $ref: '#/components/schemas/firewall_components-schemas-rule' firewall_rulesets_components-schemas-description: type: string description: An informative description of the ruleset. default: "" example: My ruleset to execute managed rulesets firewall_schemas-action: type: string description: The action to apply to a matched request. The `log` action is only available on an Enterprise plan. enum: - block - challenge - js_challenge - managed_challenge - allow - log - bypass example: block firewall_schemas-action_parameters: type: object description: The parameters configuring the rule action. example: id: 4814384a9e5d4991b9815dcfc25d2f1f firewall_schemas-cidr_configuration: title: An IP address range configuration. properties: target: description: The configuration target. You must set the target to `ip_range` when specifying an IP address range in the Zone Lockdown rule. enum: - ip_range example: ip_range value: type: string description: The IP address range to match. You can only use prefix lengths `/16` and `/24`. example: 198.51.100.4/16 firewall_schemas-configuration: type: object description: The configuration object for the current rule. properties: target: type: string description: The configuration target for this rule. You must set the target to `ua` for User Agent Blocking rules. example: ua value: type: string description: The exact user agent string to match. This value will be compared to the received `User-Agent` HTTP header value. example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4 firewall_schemas-description: type: string description: A summary of the purpose/function of the WAF package. example: "null" readOnly: true firewall_schemas-description_search: type: string description: A string to search for in the description of existing rules. example: endpoints firewall_schemas-expression: type: string description: The expression defining which traffic will match the rule. example: ip.src ne 1.1.1.1 firewall_schemas-id: type: string description: The unique identifier of the WAF override. example: de677e5818985db1285d0e80225f06e5 readOnly: true maxLength: 32 firewall_schemas-identifier: type: string description: The unique identifier of the IP Access rule. example: 92f17202ed8bd63d69a66b86a49a8f6b readOnly: true maxLength: 32 firewall_schemas-ip_configuration: title: An IP address configuration. properties: target: description: The configuration target. You must set the target to `ip` when specifying an IP address in the Zone Lockdown rule. enum: - ip example: ip value: type: string description: The IP address to match. This address will be compared to the IP address of incoming requests. example: 198.51.100.4 firewall_schemas-mode: type: string description: The action to apply to a matched request. enum: - block - challenge - whitelist - js_challenge - managed_challenge example: challenge firewall_schemas-paused: type: boolean description: When true, indicates that the rule is currently paused. example: false firewall_schemas-priority: type: number description: The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority. example: 5 firewall_schemas-ref: type: string description: A short reference tag. Allows you to select related filters. example: FIL-100 maxLength: 50 firewall_schemas-rule: allOf: - $ref: '#/components/schemas/firewall_rule' - properties: scope: type: object description: All zones owned by the user will have the rule applied. readOnly: true 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 type: object required: - id - mode - allowed_modes - configuration - scope firewall_schemas-ruleset: properties: description: example: "" id: example: 2f2feab2026849078ba485f918791bdc kind: example: zone name: example: default phase: example: http_request_dynamic_redirect rules: type: array description: The rules in the ruleset. items: $ref: '#/components/schemas/firewall_dynamic-redirect-rules_components-schemas-rule' firewall_schemas-urls: type: array description: The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns. items: type: string example: api.mysite.com/some/endpoint* firewall_schemes: type: array description: The HTTP schemes to match. You can specify one scheme (`['HTTPS']`), both schemes (`['HTTP','HTTPS']`), or all schemes (`['_ALL_']`). This field is optional. example: - HTTP - HTTPS items: type: string description: An HTTP scheme or `_ALL_` to indicate all schemes. example: HTTPS firewall_sensitivity: type: string description: The sensitivity of the WAF package. enum: - high - medium - low - "off" default: high firewall_status: type: string description: When set to `active`, indicates that the WAF package will be applied to the zone. enum: - active default: active readOnly: true firewall_threshold: type: number description: The threshold that will trigger the configured mitigation action. Configure this value along with the `period` property to establish a threshold per period. example: 60 minimum: 1 firewall_timeout: type: number description: |- The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period. Notes: If "mode" is "challenge", "managed_challenge", or "js_challenge", Cloudflare will use the zone's Challenge Passage time and you should not provide this value. example: 86400 minimum: 1 maximum: 86400 firewall_transform-rules_components-schemas-action_parameters: oneOf: - $ref: '#/components/schemas/firewall_action_parameters_rewrite' type: object description: The parameters configuring the action. 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: type: array description: The rules in the ruleset. items: $ref: '#/components/schemas/firewall_transform-rules_components-schemas-rule' firewall_ua-rules: allOf: - $ref: '#/components/schemas/firewall_firewalluablock' type: object firewall_ua-rules_components-schemas-description: type: string description: An informative summary of the rule. example: Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack maxLength: 1024 firewall_update_ruleset: type: object description: A ruleset object. required: - rules properties: description: $ref: '#/components/schemas/firewall_rulesets_components-schemas-description' rules: $ref: '#/components/schemas/firewall_create_update_rules' firewall_uri_search: type: string description: A single URI to search for in the list of URLs of existing rules. example: /some/path firewall_url: type: string description: The URL pattern to match, composed of a host and a path such as `example.org/path*`. Normalization is applied before the pattern is matched. `*` wildcards are expanded to match applicable traffic. Query strings are not matched. Set the value to `*` to match all traffic to your zone. example: '*.example.org/path*' maxLength: 1024 firewall_urls: type: array description: The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns. items: type: string example: shop.example.com/* 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: required: - id - created_on - modified_on - paused - description - urls - configurations 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' firewall_zonelockdown_response_collection: allOf: - $ref: '#/components/schemas/firewall_api-response-collection' - type: object required: - result properties: result: type: array items: $ref: '#/components/schemas/firewall_zonelockdown' firewall_zonelockdown_response_single: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - type: object required: - result properties: result: $ref: '#/components/schemas/firewall_zonelockdown' healthchecks_address: type: string description: The hostname or IP address of the origin server to run health checks on. example: www.example.com healthchecks_api-response-collection: allOf: - $ref: '#/components/schemas/healthchecks_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/healthchecks_result_info' type: object healthchecks_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/healthchecks_messages' messages: $ref: '#/components/schemas/healthchecks_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true healthchecks_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/healthchecks_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/healthchecks_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false healthchecks_api-response-single: allOf: - $ref: '#/components/schemas/healthchecks_api-response-common' - properties: result: oneOf: - type: object - type: string type: object healthchecks_check_regions: type: array description: A list of regions from which to run health checks. Null means Cloudflare will pick a default region. example: - WEU - ENAM nullable: true items: type: string description: 'WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, IN: India, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (BUSINESS and ENTERPRISE customers only).' enum: - WNAM - ENAM - WEU - EEU - NSAM - SSAM - OC - ME - NAF - SAF - IN - SEAS - NEAS - ALL_REGIONS healthchecks_consecutive_fails: type: integer description: The number of consecutive fails required from a health check before changing the health to unhealthy. default: 1 healthchecks_consecutive_successes: type: integer description: The number of consecutive successes required from a health check before changing the health to healthy. default: 1 healthchecks_description: type: string description: A human-readable description of the health check. example: Health check for www.example.com healthchecks_failure_reason: type: string description: The current failure reason if status is unhealthy. example: "" readOnly: true healthchecks_healthchecks: type: object properties: address: $ref: '#/components/schemas/healthchecks_address' check_regions: $ref: '#/components/schemas/healthchecks_check_regions' consecutive_fails: $ref: '#/components/schemas/healthchecks_consecutive_fails' consecutive_successes: $ref: '#/components/schemas/healthchecks_consecutive_successes' created_on: $ref: '#/components/schemas/healthchecks_timestamp' description: $ref: '#/components/schemas/healthchecks_description' failure_reason: $ref: '#/components/schemas/healthchecks_failure_reason' http_config: $ref: '#/components/schemas/healthchecks_http_config' id: $ref: '#/components/schemas/healthchecks_identifier' interval: $ref: '#/components/schemas/healthchecks_interval' modified_on: $ref: '#/components/schemas/healthchecks_timestamp' name: $ref: '#/components/schemas/healthchecks_name' retries: $ref: '#/components/schemas/healthchecks_retries' status: $ref: '#/components/schemas/healthchecks_status' suspended: $ref: '#/components/schemas/healthchecks_suspended' tcp_config: $ref: '#/components/schemas/healthchecks_tcp_config' timeout: $ref: '#/components/schemas/healthchecks_timeout' type: $ref: '#/components/schemas/healthchecks_type' healthchecks_http_config: type: object description: Parameters specific to an HTTP or HTTPS health check. nullable: true properties: allow_insecure: type: boolean description: Do not validate the certificate when the health check uses HTTPS. default: false expected_body: type: string description: A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. example: success expected_codes: type: array description: The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check. default: "200" example: - 2xx - "302" nullable: true items: type: string follow_redirects: type: boolean description: Follow redirects if the origin returns a 3xx status code. default: false header: type: object description: The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. example: Host: - example.com X-App-ID: - abc123 nullable: true method: type: string description: The HTTP method to use for the health check. enum: - GET - HEAD default: GET path: type: string description: The endpoint path to health check against. default: / example: /health port: type: integer description: Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS. default: 80 healthchecks_id_response: allOf: - $ref: '#/components/schemas/healthchecks_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/healthchecks_identifier' healthchecks_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 healthchecks_interval: type: integer description: The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations. default: 60 healthchecks_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string healthchecks_name: type: string description: A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed. example: server-1 healthchecks_query_healthcheck: type: object required: - name - address properties: address: $ref: '#/components/schemas/healthchecks_address' check_regions: $ref: '#/components/schemas/healthchecks_check_regions' consecutive_fails: $ref: '#/components/schemas/healthchecks_consecutive_fails' consecutive_successes: $ref: '#/components/schemas/healthchecks_consecutive_successes' description: $ref: '#/components/schemas/healthchecks_description' http_config: $ref: '#/components/schemas/healthchecks_http_config' interval: $ref: '#/components/schemas/healthchecks_interval' name: $ref: '#/components/schemas/healthchecks_name' retries: $ref: '#/components/schemas/healthchecks_retries' suspended: $ref: '#/components/schemas/healthchecks_suspended' tcp_config: $ref: '#/components/schemas/healthchecks_tcp_config' timeout: $ref: '#/components/schemas/healthchecks_timeout' type: $ref: '#/components/schemas/healthchecks_type' healthchecks_response_collection: allOf: - $ref: '#/components/schemas/healthchecks_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/healthchecks_healthchecks' healthchecks_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 healthchecks_retries: type: integer description: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. default: 2 healthchecks_single_response: allOf: - $ref: '#/components/schemas/healthchecks_api-response-single' - properties: result: $ref: '#/components/schemas/healthchecks_healthchecks' healthchecks_status: type: string description: The current status of the origin server according to the health check. enum: - unknown - healthy - unhealthy - suspended example: healthy readOnly: true healthchecks_suspended: type: boolean description: If suspended, no health checks are sent to the origin. default: false healthchecks_tcp_config: type: object description: Parameters specific to TCP health check. nullable: true properties: method: type: string description: The TCP connection method to use for the health check. enum: - connection_established default: connection_established port: type: integer description: Port number to connect to for the health check. Defaults to 80. default: 80 healthchecks_timeout: type: integer description: The timeout (in seconds) before marking the health check as failed. default: 5 healthchecks_timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true healthchecks_type: type: string description: The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'. default: HTTP example: HTTPS hyperdrive_api-response-collection: allOf: - $ref: '#/components/schemas/hyperdrive_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/hyperdrive_result_info' type: object hyperdrive_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/hyperdrive_messages' messages: $ref: '#/components/schemas/hyperdrive_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true hyperdrive_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false hyperdrive_api-response-single: allOf: - $ref: '#/components/schemas/hyperdrive_api-response-common' - properties: result: anyOf: - type: object - type: string type: object nullable: true type: object hyperdrive_create-update-hyperdrive-config: allOf: - $ref: '#/components/schemas/hyperdrive_hyperdrive' type: object required: - name - origin properties: origin: $ref: '#/components/schemas/hyperdrive_hyperdrive-origin-with-password' hyperdrive_hyperdrive: type: object properties: caching: $ref: '#/components/schemas/hyperdrive_hyperdrive-caching' name: $ref: '#/components/schemas/hyperdrive_hyperdrive-name' origin: $ref: '#/components/schemas/hyperdrive_hyperdrive-origin' hyperdrive_hyperdrive-caching: type: object properties: disabled: type: boolean description: 'When set to true, disables the caching of SQL responses. (Default: false)' example: false max_age: type: integer description: 'When present, specifies max duration for which items should persist in the cache. (Default: 60)' example: 60 stale_while_revalidate: type: integer description: 'When present, indicates the number of seconds cache may serve the response after it becomes stale. (Default: 15)' example: 15 hyperdrive_hyperdrive-name: type: string example: example-hyperdrive hyperdrive_hyperdrive-origin: type: object required: - host - port - scheme - database - user properties: database: type: string description: The name of your origin database. example: postgres host: type: string description: The host (hostname or IP) of your origin database. example: database.example.com port: type: integer description: 'The port (default: 5432 for Postgres) of your origin database.' example: "5432" scheme: $ref: '#/components/schemas/hyperdrive_hyperdrive-scheme' user: type: string description: The user of your origin database. example: postgres hyperdrive_hyperdrive-origin-with-password: allOf: - $ref: '#/components/schemas/hyperdrive_hyperdrive-origin' type: object required: - password properties: password: type: string description: The password required to access your origin database. This value is write-only and never returned by the API. example: password1234! hyperdrive_hyperdrive-scheme: type: string description: Specifies the URL scheme used to connect to your origin database. enum: - postgres - postgresql - mysql default: postgres hyperdrive_hyperdrive-with-identifier: allOf: - $ref: '#/components/schemas/hyperdrive_hyperdrive' type: object properties: id: $ref: '#/components/schemas/hyperdrive_identifier' hyperdrive_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 hyperdrive_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string hyperdrive_patch-hyperdrive-config: allOf: - $ref: '#/components/schemas/hyperdrive_hyperdrive' type: object properties: origin: $ref: '#/components/schemas/hyperdrive_hyperdrive-origin-with-password' hyperdrive_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 iam_access-policy: oneOf: - $ref: '#/components/schemas/iam_policy_with_permission_groups' type: object iam_account: type: object required: - id - name properties: created_on: type: string format: date-time description: Timestamp for the creation of the account example: "2014-03-01T12:21:02.0000Z" readOnly: true id: $ref: '#/components/schemas/iam_common_components-schemas-identifier' name: type: string description: Account name example: Demo Account maxLength: 100 settings: type: object description: Account settings properties: default_nameservers: type: string 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 default: cloudflare.standard enforce_twofactor: type: boolean description: |- Indicates whether membership in this account requires that Two-Factor Authentication is enabled default: false use_account_custom_ns_by_default: type: boolean description: |- Indicates whether new zones should use the account-level custom nameservers by default. Deprecated in favor of `default_nameservers`. default: false deprecated: true iam_account_identifier: {} iam_api-response-collection: allOf: - $ref: '#/components/schemas/iam_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/iam_result_info' type: object iam_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/iam_messages' messages: $ref: '#/components/schemas/iam_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true iam_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false iam_api-response-single: allOf: - $ref: '#/components/schemas/iam_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object iam_api-response-single-id: allOf: - $ref: '#/components/schemas/iam_api-response-common' - properties: result: type: object nullable: true required: - id properties: id: $ref: '#/components/schemas/iam_common_components-schemas-identifier' type: object iam_api_access_enabled: type: boolean description: Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account. example: true nullable: true iam_base: type: object required: - invited_member_id - organization_id 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: type: string description: ID of the user to add to the organization. example: 5a7805061c76ada191ed06f989cc3dac nullable: true readOnly: true maxLength: 32 invited_on: $ref: '#/components/schemas/iam_invited_on' organization_id: type: string description: ID of the organization the user will be added to. example: 5a7805061c76ada191ed06f989cc3dac readOnly: true maxLength: 32 organization_name: type: string description: Organization name. example: Cloudflare, Inc. readOnly: true maxLength: 100 roles: type: array description: Roles to be assigned to this user. items: $ref: '#/components/schemas/iam_schemas-role' iam_cidr_list: type: array description: List of IPv4/IPv6 CIDR addresses. example: - 199.27.128.0/21 - 2400:cb00::/32 items: type: string description: IPv4/IPv6 CIDR. example: 199.27.128.0/21 iam_code: type: string description: The unique activation code for the account membership. example: 05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0 readOnly: true maxLength: 64 iam_collection_invite_response: allOf: - $ref: '#/components/schemas/iam_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/iam_invite' iam_collection_member_response: allOf: - $ref: '#/components/schemas/iam_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/iam_components-schemas-member' iam_collection_membership_response: allOf: - $ref: '#/components/schemas/iam_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/iam_membership' iam_collection_organization_response: allOf: - $ref: '#/components/schemas/iam_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/iam_organization' iam_collection_role_response: allOf: - $ref: '#/components/schemas/iam_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/iam_schemas-role' iam_common_components-schemas-identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 iam_components-schemas-account: allOf: - $ref: '#/components/schemas/iam_account' iam_components-schemas-identifier: type: string description: Token identifier tag. example: ed17574386854bf78a67040be0a770b0 readOnly: true maxLength: 32 iam_components-schemas-member: type: object required: - id - name - email - status - roles properties: email: $ref: '#/components/schemas/iam_email' id: $ref: '#/components/schemas/iam_common_components-schemas-identifier' name: $ref: '#/components/schemas/iam_member_components-schemas-name' roles: type: array description: Roles assigned to this Member. items: $ref: '#/components/schemas/iam_schemas-role' status: description: A member's status in the organization. enum: - accepted - invited example: accepted iam_components-schemas-name: type: string description: Role Name. example: Organization Admin readOnly: true maxLength: 120 iam_components-schemas-status: type: string description: Whether the user is a member of the organization or has an inivitation pending. enum: - member - invited example: member iam_condition: type: object properties: request_ip: $ref: '#/components/schemas/iam_request_ip' iam_country: type: string description: The country in which the user lives. example: US nullable: true maxLength: 30 iam_create: type: object required: - email - roles properties: email: $ref: '#/components/schemas/iam_email' roles: type: array description: Array of roles associated with this member. items: $ref: '#/components/schemas/iam_role_components-schemas-identifier' status: enum: - accepted - pending default: pending iam_create_payload: type: object required: - name - policies 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_policies' iam_description: type: string description: Description of role's permissions. example: Administrative access to the entire Organization readOnly: true iam_effect: type: string description: Allow or deny operations against the resources. enum: - allow - deny example: allow iam_email: type: string description: The contact email address of the user. example: user@example.com maxLength: 90 iam_expires_on: type: string format: date-time description: The expiration time on or after which the JWT MUST NOT be accepted for processing. example: "2020-01-01T00:00:00Z" iam_first_name: type: string description: User's first name example: John nullable: true maxLength: 60 iam_grants: type: object example: read: true write: false properties: read: type: boolean example: true write: type: boolean example: true iam_identifier: type: string description: Policy identifier. example: f267e341f3dd4697bd3b9f71dd96247f readOnly: true iam_invite: allOf: - $ref: '#/components/schemas/iam_organization_invite' type: object iam_invite_components-schemas-identifier: type: string description: Invite identifier tag. example: 4f5f0c14a2a41d5063dd301b2f829f04 readOnly: true maxLength: 32 iam_invited_by: type: string description: The email address of the user who created the invite. example: user@example.com maxLength: 90 iam_invited_member_email: type: string description: Email address of the user to add to the organization. example: user@example.com maxLength: 90 iam_invited_on: type: string format: date-time description: When the invite was sent. example: "2014-01-01T05:20:00Z" readOnly: true iam_issued_on: type: string format: date-time description: The time on which the token was created. example: "2018-07-01T05:20:00Z" readOnly: true iam_last_name: type: string description: User's last name example: Appleseed nullable: true maxLength: 60 iam_member: type: object required: - id - user - status - roles properties: id: $ref: '#/components/schemas/iam_membership_components-schemas-identifier' roles: type: array description: Roles assigned to this member. items: $ref: '#/components/schemas/iam_role' status: readOnly: true user: type: object readOnly: true required: - email 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' iam_member_components-schemas-name: type: string description: Member Name. example: John Smith nullable: true maxLength: 100 iam_member_with_code: allOf: - $ref: '#/components/schemas/iam_member' - type: object properties: code: $ref: '#/components/schemas/iam_code' iam_membership: type: object properties: account: $ref: '#/components/schemas/iam_schemas-account' api_access_enabled: $ref: '#/components/schemas/iam_api_access_enabled' code: $ref: '#/components/schemas/iam_code' 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' iam_membership_components-schemas-identifier: type: string description: Membership identifier tag. example: 4536bcfad5faccb111b47003c79917fa readOnly: true maxLength: 32 iam_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string iam_modified_on: type: string format: date-time description: Last time the token was modified. example: "2018-07-02T05:20:00Z" readOnly: true iam_name: type: string description: Token name. example: readonly token maxLength: 120 iam_not_before: type: string format: date-time description: The time before which the token MUST NOT be accepted for processing. example: "2018-07-01T05:20:00Z" iam_organization: type: object 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: type: array description: List of roles that a user has within an organization. readOnly: true items: type: string example: All Privileges - Super Administrator maxLength: 120 status: $ref: '#/components/schemas/iam_components-schemas-status' iam_organization_components-schemas-identifier: type: string description: Organization identifier tag. example: 01a7362d577a6c3019a474fd6f485823 readOnly: true maxLength: 32 iam_organization_invite: allOf: - $ref: '#/components/schemas/iam_base' - properties: organization_is_enforcing_twofactor: type: boolean description: Current status of two-factor enforcement on the organization. default: false example: true status: type: string description: Current status of the invitation. enum: - pending - accepted - rejected - canceled - left - expired example: accepted iam_permission_group: type: object description: A named group of permissions that map to a group of operations against resources. required: - id properties: id: type: string description: Identifier of the group. example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 readOnly: true name: type: string description: Name of the group. example: Load Balancers Write readOnly: true iam_permission_groups: type: array description: A set of permission groups that are specified to the policy. example: - id: c8fed203ed3043cba015a93ad1616f1f name: Zone Read - id: 82e64a83756745bbbb1c9c2701bf816b name: DNS Read items: $ref: '#/components/schemas/iam_permission_group' iam_permissions: type: object 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' iam_policies: type: array description: List of access policies assigned to the token. items: $ref: '#/components/schemas/iam_access-policy' iam_policy_with_permission_groups: title: policy_with_permission_groups required: - id - effect - resources - permission_groups 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' iam_properties-name: type: string description: Account name example: Demo Account maxLength: 100 iam_request_ip: type: object description: Client IP restrictions. example: in: - 123.123.123.0/24 - 2606:4700::/32 not_in: - 123.123.123.100/24 - 2606:4700:4700::/48 properties: in: $ref: '#/components/schemas/iam_cidr_list' not_in: $ref: '#/components/schemas/iam_cidr_list' iam_resources: type: object description: A list of resource names that the policy applies to. example: com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43: '*' com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4: '*' iam_response_collection: allOf: - $ref: '#/components/schemas/iam_api-response-collection' - type: object properties: result: type: array items: type: object iam_response_create: allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: allOf: - type: object - type: object properties: value: $ref: '#/components/schemas/iam_value' iam_response_single: allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: type: object iam_response_single_segment: allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: required: - id - status properties: expires_on: $ref: '#/components/schemas/iam_expires_on' id: $ref: '#/components/schemas/iam_components-schemas-identifier' not_before: $ref: '#/components/schemas/iam_not_before' status: $ref: '#/components/schemas/iam_status' iam_response_single_value: allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: $ref: '#/components/schemas/iam_value' iam_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 iam_role: type: object required: - id - name - description - permissions properties: description: type: string description: Description of role's permissions. example: Administrative access to the entire Account readOnly: true id: $ref: '#/components/schemas/iam_role_components-schemas-identifier' name: type: string description: Role name. example: Account Administrator readOnly: true maxLength: 120 permissions: allOf: - $ref: '#/components/schemas/iam_permissions' - readOnly: true iam_role_components-schemas-identifier: type: string description: Role identifier tag. example: 3536bcfad5faccb999b47003c79917fb maxLength: 32 iam_roles: type: array description: List of role names for the user at the account. readOnly: true items: type: string example: Account Administrator maxLength: 120 iam_schemas-account: allOf: - $ref: '#/components/schemas/iam_account' readOnly: true iam_schemas-collection_invite_response: allOf: - $ref: '#/components/schemas/iam_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/iam_schemas-invite' iam_schemas-expires_on: type: string format: date-time description: When the invite is no longer active. example: "2014-01-01T05:20:00Z" readOnly: true iam_schemas-identifier: {} iam_schemas-invite: allOf: - $ref: '#/components/schemas/iam_user_invite' type: object iam_schemas-member: allOf: - $ref: '#/components/schemas/iam_member' iam_schemas-name: type: string description: Organization name. example: Cloudflare, Inc. maxLength: 100 iam_schemas-permissions: type: array description: Access permissions for this User. readOnly: true items: type: string example: '#zones:read' maxLength: 160 iam_schemas-response_collection: allOf: - $ref: '#/components/schemas/iam_api-response-collection' - type: object properties: result: type: array example: - id: 7cf72faf220841aabcfdfab81c43c4f6 name: Billing Read scopes: - com.cloudflare.api.account - id: 9d24387c6e8544e2bc4024a03991339f name: 'Load Balancing: Monitors and Pools Read' scopes: - com.cloudflare.api.account - id: d2a1802cc9a34e30852f8b33869b2f3c name: 'Load Balancing: Monitors and Pools Write' scopes: - com.cloudflare.api.account - id: 8b47d2786a534c08a1f94ee8f9f599ef name: Workers KV Storage Read scopes: - com.cloudflare.api.account - id: f7f0eda5697f475c90846e879bab8666 name: Workers KV Storage Write scopes: - com.cloudflare.api.account - id: 1a71c399035b4950a1bd1466bbe4f420 name: Workers Scripts Read scopes: - com.cloudflare.api.account - id: e086da7e2179491d91ee5f35b3ca210a name: Workers Scripts Write scopes: - com.cloudflare.api.account items: type: object iam_schemas-role: type: object required: - id - name - description - permissions 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' iam_schemas-status: type: string description: Status of this membership. enum: - accepted - pending - rejected example: accepted iam_schemas-token: allOf: - $ref: '#/components/schemas/iam_token' iam_single_invite_response: allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: type: object iam_single_member_response: allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: $ref: '#/components/schemas/iam_member' iam_single_member_response_with_code: allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: $ref: '#/components/schemas/iam_member_with_code' iam_single_membership_response: allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: type: object iam_single_organization_response: allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: type: object iam_single_role_response: allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: type: object iam_single_user_response: allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: type: object iam_status: type: string description: Status of the token. enum: - active - disabled - expired example: active iam_telephone: type: string description: User's telephone number example: +1 123-123-1234 nullable: true maxLength: 20 iam_token: type: object required: - id - name - status - policies properties: condition: $ref: '#/components/schemas/iam_condition' expires_on: $ref: '#/components/schemas/iam_expires_on' id: $ref: '#/components/schemas/iam_components-schemas-identifier' issued_on: $ref: '#/components/schemas/iam_issued_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_policies' status: $ref: '#/components/schemas/iam_status' iam_two_factor_authentication_enabled: type: boolean description: Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication. default: false readOnly: true 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: type: string description: The token value. example: 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T readOnly: true minLength: 40 maxLength: 80 iam_zipcode: type: string description: The zipcode or postal code where the user lives. example: "12345" nullable: true maxLength: 20 images_account_identifier: type: string description: Account identifier tag. example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 images_api-response-collection-v2: allOf: - $ref: '#/components/schemas/images_api-response-common' - properties: result: type: object properties: continuation_token: $ref: '#/components/schemas/images_images_list_continuation_token' type: object images_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/images_messages' messages: $ref: '#/components/schemas/images_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true images_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false 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: type: object example: {} images_image: type: object 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' images_image_basic_upload: type: object properties: file: format: binary description: An image binary data. Only needed when type is uploading a file. metadata: type: object description: User modifiable key-value store. Can use used for keeping references to another system of record for managing images. requireSignedURLs: type: boolean description: Indicates whether the image requires a signature token for the access. default: false example: true url: type: string description: A URL to fetch an image from origin. Only needed when type is uploading from a URL. example: https://example.com/path/to/logo.png images_image_direct_upload_request_v2: type: object properties: expiry: type: string format: date-time description: 'The date after which the upload will not be accepted. Minimum: Now + 2 minutes. Maximum: Now + 6 hours.' default: Now + 30 minutes example: "2021-01-02T02:20:00Z" id: type: string 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 metadata: type: object description: User modifiable key-value store. Can be used for keeping references to another system of record, for managing images. requireSignedURLs: type: boolean description: Indicates whether the image requires a signature token to be accessed. default: false example: true images_image_direct_upload_response_v2: allOf: - $ref: '#/components/schemas/images_api-response-single' - properties: result: properties: id: type: string description: Image unique identifier. example: e22e9e6b-c02b-42fd-c405-6c32af5fe600 readOnly: true maxLength: 32 uploadURL: type: string description: The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request. example: https://upload.imagedelivery.net/FxUufywByo0m2v3xhKSiU8/e22e9e6b-c02b-42fd-c405-6c32af5fe600 images_image_filename: type: string description: Image file name. example: logo.png readOnly: true maxLength: 255 images_image_hero_url: type: string format: uri description: URI to hero variant for an image. example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero readOnly: true images_image_identifier: type: string description: Image unique identifier. example: 107b9558-dd06-4bbd-5fef-9c2c16bb7900 readOnly: true maxLength: 32 images_image_key_name: type: string description: Key name. example: default readOnly: true 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: type: string description: Key value. example: Oix0bbNaT8Rge9PuyxUBrjI6zrgnsyJ5= readOnly: true images_image_keys: type: object properties: name: $ref: '#/components/schemas/images_image_key_name' value: $ref: '#/components/schemas/images_image_key_value' images_image_keys_response: type: object properties: keys: type: array items: $ref: '#/components/schemas/images_image_keys' images_image_metadata: type: object description: User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes. example: key: value images_image_original_url: type: string format: uri description: URI to original variant for an image. example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original readOnly: true images_image_patch_request: type: object properties: metadata: type: object description: User modifiable key-value store. Can be used for keeping references to another system of record for managing images. No change if not specified. requireSignedURLs: type: boolean description: Indicates whether the image can be accessed using only its UID. If set to `true`, a signed token needs to be generated with a signing key to view the image. Returns a new UID on a change. No change if not specified. example: true images_image_requireSignedURLs: type: boolean description: Indicates whether the image can be a accessed only using it's UID. If set to true, a signed token needs to be generated with a signing key to view the image. default: false example: true images_image_response_blob: anyOf: - type: string - type: object example: images_image_response_single: allOf: - $ref: '#/components/schemas/images_api-response-single' - properties: result: $ref: '#/components/schemas/images_image' images_image_thumbnail_url: type: string format: uri description: URI to thumbnail variant for an image. example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail readOnly: true images_image_uploaded: type: string format: date-time description: When the media item was uploaded. example: "2014-01-02T02:20:00.123Z" readOnly: true images_image_variant_definition: type: object required: - id - options 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' images_image_variant_fit: type: string description: The fit property describes how the width and height dimensions should be interpreted. enum: - scale-down - contain - cover - crop - pad example: scale-down images_image_variant_height: type: number description: Maximum height in image pixels. example: 768 minimum: 1 images_image_variant_identifier: example: hero maxLength: 99 pattern: ^[a-zA-Z0-9]$ 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: type: boolean description: Indicates whether the variant can access an image without a signature, regardless of image access control. default: false example: true images_image_variant_options: type: object description: Allows you to define image resizing sizes for different use cases. required: - fit - metadata - width - height properties: fit: $ref: '#/components/schemas/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' images_image_variant_patch_request: type: object required: - options properties: neverRequireSignedURLs: $ref: '#/components/schemas/images_image_variant_neverRequireSignedURLs' options: $ref: '#/components/schemas/images_image_variant_options' images_image_variant_public_request: type: object properties: hero: type: object required: - id - options 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' images_image_variant_response: type: object properties: variant: $ref: '#/components/schemas/images_image_variant_definition' images_image_variant_schemas_metadata: type: string description: What EXIF data should be preserved in the output image. enum: - keep - copyright - none example: none 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: type: number description: Maximum width in image pixels. example: 1366 minimum: 1 images_image_variants: type: array description: Object specifying available variants for an image. example: - https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail - https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero - https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original readOnly: true items: anyOf: - $ref: '#/components/schemas/images_image_thumbnail_url' - $ref: '#/components/schemas/images_image_hero_url' - $ref: '#/components/schemas/images_image_original_url' images_image_variants_response: type: object properties: variants: $ref: '#/components/schemas/images_image_variant_public_request' images_images_list_continuation_token: type: string description: Continuation token to fetch next page. Passed as a query param when requesting List V2 api endpoint. example: iD0bxlWFSVUWsDHbzIqvDkgBW4otifAAuGXLz1n8BQA nullable: true readOnly: true maxLength: 32 images_images_list_response: allOf: - $ref: '#/components/schemas/images_api-response-common' - properties: result: type: object properties: images: type: array items: $ref: '#/components/schemas/images_image' images_images_list_response_v2: allOf: - $ref: '#/components/schemas/images_api-response-collection-v2' - properties: result: type: object properties: images: type: array items: $ref: '#/components/schemas/images_image' images_images_stats: type: object properties: count: $ref: '#/components/schemas/images_images_stats_count' images_images_stats_allowed: type: number description: Cloudflare Images allowed usage. example: 100000 readOnly: true images_images_stats_count: type: object properties: allowed: $ref: '#/components/schemas/images_images_stats_allowed' current: $ref: '#/components/schemas/images_images_stats_current' images_images_stats_current: type: number description: Cloudflare Images current usage. example: 1000 readOnly: true images_images_stats_response: allOf: - $ref: '#/components/schemas/images_api-response-single' - properties: result: $ref: '#/components/schemas/images_images_stats' images_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string images_signing_key_identifier: example: someKey maxLength: 20 pattern: ^[a-zA-Z0-9]$ intel-sinkholes_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/intel-sinkholes_messages' messages: $ref: '#/components/schemas/intel-sinkholes_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true intel-sinkholes_empty_object_response: type: object intel-sinkholes_get_sinkholes_response: allOf: - $ref: '#/components/schemas/intel-sinkholes_api-response-common' - properties: result: type: array 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: - 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: items: $ref: '#/components/schemas/intel-sinkholes_sinkhole_item' intel-sinkholes_id: type: integer description: The unique identifier for the sinkhole intel-sinkholes_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 intel-sinkholes_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string intel-sinkholes_name: type: string description: The name of the sinkhole 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: properties: account_tag: type: string description: The account tag that owns this sinkhole created_on: type: string format: date-time description: The date and time when the sinkhole was created id: $ref: '#/components/schemas/intel-sinkholes_id' modified_on: type: string format: date-time description: The date and time when the sinkhole was last modified name: $ref: '#/components/schemas/intel-sinkholes_name' r2_bucket: type: string description: The name of the R2 bucket to store results r2_id: type: string description: The id of the R2 instance intel_additional_information: type: object description: Additional information related to the host name. properties: suspected_malware_family: type: string description: Suspected DGA malware family. example: "" intel_api-response-collection: allOf: - $ref: '#/components/schemas/intel_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/intel_result_info' type: object intel_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/intel_messages' messages: $ref: '#/components/schemas/intel_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true intel_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false intel_api-response-single: allOf: - $ref: '#/components/schemas/intel_api-response-common' - properties: result: anyOf: - type: object - type: string type: object intel_application: type: object description: Application that the hostname belongs to. properties: id: type: integer name: type: string example: CLOUDFLARE 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: type: string example: US intel_asn_description: type: string example: CLOUDFLARENET intel_asn_type: type: string description: Infrastructure type of this ASN. enum: - hosting_provider - isp - organization example: hosting_provider intel_categories_with_super_category_ids_example_empty: type: array example: [] items: $ref: '#/components/schemas/intel_category_with_super_category_id' 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: type: array 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' intel_components-schemas-response: allOf: - $ref: '#/components/schemas/intel_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/intel_ip-list' 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: type: number description: Total results returned based on your search parameters. example: 1 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: type: array items: type: object properties: categories: example: - id: 155 name: Technology end: type: string format: date example: "2021-04-30" start: type: string format: date example: "2021-04-01" domain: $ref: '#/components/schemas/intel_domain_name' intel_domain_name: type: string example: cloudflare.com intel_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 intel_inherited_content_categories: $ref: '#/components/schemas/intel_categories_with_super_category_ids_example_empty' intel_inherited_from: type: string description: Domain from which `inherited_content_categories` and `inherited_risk_types` are inherited, if applicable. 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: type: string example: Malware intel_ipv4: type: string format: ipv4 example: 192.0.2.0 intel_ipv6: type: string format: ipv6 example: '2001:0DB8::' intel_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string intel_miscategorization: properties: content_adds: description: Content category IDs to add. example: - 82 content_removes: description: Content category IDs to remove. example: - 155 indicator_type: enum: - domain - ipv4 - ipv6 - url example: domain ip: description: Provide only if indicator_type is `ipv4` or `ipv6`. security_adds: description: Security category IDs to add. example: - 117 - 131 security_removes: description: Security category IDs to remove. example: - 83 url: type: string description: 'Provide only if indicator_type is `domain` or `url`. Example if indicator_type is `domain`: `example.com`. Example if indicator_type is `url`: `https://example.com/news/`.' intel_page: type: number description: Current page within paginated list of results. example: 1 intel_passive-dns-by-ip: properties: count: type: number description: Total results returned based on your search parameters. example: 1 page: type: number description: Current page within paginated list of results. example: 1 per_page: type: number description: Number of results per page of results. example: 20 reverse_records: type: array description: Reverse DNS look-ups observed during the time period. items: type: object properties: first_seen: type: string format: date description: First seen date of the DNS record during the time period. example: "2021-04-01" hostname: description: Hostname that the IP was observed resolving to. last_seen: type: string format: date description: Last seen date of the DNS record during the time period. example: "2021-04-30" intel_per_page: type: number description: Number of results per page of results. example: 20 intel_phishing-url-info: properties: categorizations: type: array description: List of categorizations applied to this submission. items: type: object properties: category: type: string description: Name of the category applied. example: PHISHING verification_status: type: string description: Result of human review for this categorization. example: confirmed model_results: type: array description: List of model results for completed scans. items: type: object properties: model_name: type: string description: Name of the model. example: MACHINE_LEARNING_v2 model_score: type: number description: Score output by the model for this submission. example: 0.024 rule_matches: type: array description: List of signatures that matched against site content found when crawling the URL. items: type: object properties: banning: type: boolean description: For internal use. blocking: type: boolean description: For internal use. description: type: string description: Description of the signature that matched. example: Match frequently used social followers phishing kit name: type: string description: Name of the signature that matched. example: phishkit.social_followers scan_status: type: object description: Status of the most recent scan found. properties: last_processed: type: string description: Timestamp of when the submission was processed. example: Wed, 26 Oct 2022 16:04:51 GMT scan_complete: type: boolean description: For internal use. status_code: type: integer description: Status code that the crawler received when loading the submitted URL. submission_id: type: integer description: ID of the most recent submission. screenshot_download_signature: type: string description: For internal use. screenshot_path: type: string description: For internal use. url: type: string description: URL that was submitted. example: https://www.cloudflare.com 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: type: array description: URLs that were excluded from scanning because their domain is in our no-scan list. items: type: object properties: url: type: string description: URL that was excluded. example: https://developers.cloudflare.com skipped_urls: type: array description: URLs that were skipped because the same URL is currently being scanned items: type: object properties: url: type: string description: URL that was skipped. example: https://www.cloudflare.com/developer-week/ url_id: type: integer description: ID of the submission of that URL that is currently scanning. example: 2 submitted_urls: type: array description: URLs that were successfully submitted for scanning. items: type: object properties: url: type: string description: URL that was submitted. example: https://www.cloudflare.com url_id: type: integer description: ID assigned to this URL submission. Used to retrieve scanning results. example: 1 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: type: integer description: Global Cloudflare 100k ranking for the last 30 days, if available for the hostname. The top ranked domain is 1, the lowest ranked domain is 100,000. intel_resolves_to_ref: type: object properties: id: $ref: '#/components/schemas/intel_stix_identifier' value: type: string description: IP address or domain name. example: 192.0.2.0 intel_resolves_to_refs: type: array description: Specifies a list of references to one or more IP addresses or domain names that the domain name currently resolves to. items: $ref: '#/components/schemas/intel_resolves_to_ref' intel_response: allOf: - $ref: '#/components/schemas/intel_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/intel_domain-history' intel_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 intel_risk_score: type: number description: Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest risk). intel_risk_types: example: [] 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: type: array example: - example.com items: type: string type: $ref: '#/components/schemas/intel_asn_type' intel_schemas-ip: properties: belongs_to_ref: type: object description: Specifies a reference to the autonomous systems (AS) that the IP address belongs to. properties: country: type: string example: US description: type: string example: CLOUDFLARENET id: example: autonomous-system--2fa28d71-3549-5a38-af05-770b79ad6ea8 type: type: string description: Infrastructure type of this ASN. enum: - hosting_provider - isp - organization example: hosting_provider value: type: string ip: $ref: '#/components/schemas/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: type: array items: $ref: '#/components/schemas/intel_schemas-ip' 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: type: object properties: end: type: string format: date description: Defaults to the current date. example: "2021-04-30" start: type: string format: date description: Defaults to 30 days before the end parameter value. example: "2021-04-01" intel_stix_identifier: type: string description: 'STIX 2.1 identifier: https://docs.oasis-open.org/cti/stix/v2.1/cs02/stix-v2.1-cs02.html#_64yvzeku5a5c' example: ipv4-addr--baa568ec-6efe-5902-be55-0663833db537 intel_url: type: string format: uri description: URL(s) to filter submissions results by example: https://www.cloudflare.com intel_url_id: type: integer description: Submission ID(s) to filter submission results by. intel_url_id_param: type: object properties: url_id: $ref: '#/components/schemas/intel_url_id' intel_url_param: type: object properties: url: $ref: '#/components/schemas/intel_url' intel_whois: properties: created_date: type: string format: date example: "2009-02-17" domain: $ref: '#/components/schemas/intel_domain_name' nameservers: type: array example: - ns3.cloudflare.com - ns4.cloudflare.com - ns5.cloudflare.com - ns6.cloudflare.com - ns7.cloudflare.com items: type: string registrant: type: string example: DATA REDACTED registrant_country: type: string example: United States registrant_email: type: string example: https://domaincontact.cloudflareregistrar.com/cloudflare.com registrant_org: type: string example: DATA REDACTED registrar: type: string example: Cloudflare, Inc. updated_date: type: string format: date example: "2017-05-24" legacy-jhs_api-response-collection: allOf: - $ref: '#/components/schemas/legacy-jhs_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/legacy-jhs_result_info' type: object legacy-jhs_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/legacy-jhs_messages' messages: $ref: '#/components/schemas/legacy-jhs_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true legacy-jhs_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/legacy-jhs_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/legacy-jhs_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false 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: type: string description: Application identifier. example: ea95132c15732412d22c1476fa83f27a readOnly: true maxLength: 32 legacy-jhs_app_id_param: type: string description: Comma-delimited list of Spectrum Application Id(s). If provided, the response will be limited to Spectrum Application Id(s) that match. example: ea95132c15732412d22c1476fa83f27a,d122c5f4bb71e25cc9e86ab43b142e2f legacy-jhs_argo_smart_routing: type: boolean description: |- Enables Argo Smart Routing for this application. Notes: Only available for TCP applications with traffic_type set to "direct". default: false example: true legacy-jhs_created: type: string format: date-time description: When the Application was created. example: "2014-01-02T02:20:00Z" readOnly: true legacy-jhs_dimensions: type: array description: "Can be used to break down the data by given attributes. Options are: \n\nDimension | Name | Example\n--------------------------|---------------------------------|--------------------------\nevent \ | Connection Event | connect, progress, disconnect, originError, clientFiltered\nappID | Application ID | 40d67c87c6cd4b889a4fd57805225e85\ncoloName | Colo Name | SFO\nipVersion | IP version used by the client | 4, 6." example: - event - appID items: type: string enum: - event - appID - coloName - ipVersion legacy-jhs_dns: type: object description: The name and type of DNS record for the Spectrum application. properties: name: $ref: '#/components/schemas/legacy-jhs_dns_name' type: $ref: '#/components/schemas/legacy-jhs_dns_type' legacy-jhs_dns_name: type: string format: hostname description: The name of the DNS record associated with the application. example: ssh.example.com legacy-jhs_dns_ttl: type: integer description: The TTL of our resolution of your DNS record in seconds. minimum: 600 legacy-jhs_dns_type: type: string description: The type of DNS record associated with the application. enum: - CNAME - ADDRESS example: CNAME legacy-jhs_edge_ips: oneOf: - type: object properties: connectivity: type: string description: The IP versions supported for inbound connections on Spectrum anycast IPs. enum: - all - ipv4 - ipv6 example: all type: type: string description: The type of edge IP configuration specified. Dynamically allocated edge IPs use Spectrum anycast IPs in accordance with the connectivity you specify. Only valid with CNAME DNS names. enum: - dynamic example: dynamic - type: object properties: ips: type: array description: The array of customer owned IPs we broadcast via anycast for this hostname and application. example: - 192.0.2.1 items: type: string description: Edge anycast IPs. example: 192.0.2.1 type: type: string description: The type of edge IP configuration specified. Statically allocated edge IPs use customer IPs in accordance with the ips array you specify. Only valid with ADDRESS DNS names. enum: - static example: static description: The anycast edge IP configuration for the hostname of this application. default: connectivity: all type: dynamic legacy-jhs_id: type: string description: Identifier of a recommedation result. example: ssl_recommendation legacy-jhs_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 legacy-jhs_ip_firewall: type: boolean description: |- Enables IP Access Rules for this application. Notes: Only available for TCP applications. example: true legacy-jhs_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string legacy-jhs_modified: type: string format: date-time description: When the Application was last modified. example: "2014-01-02T02:20:00Z" readOnly: true legacy-jhs_origin_dns: type: object description: The name and type of DNS record for the Spectrum application. properties: name: $ref: '#/components/schemas/legacy-jhs_origin_dns_name' ttl: $ref: '#/components/schemas/legacy-jhs_dns_ttl' type: $ref: '#/components/schemas/legacy-jhs_origin_dns_type' legacy-jhs_origin_dns_name: type: string format: hostname description: The name of the DNS record associated with the origin. example: origin.example.com legacy-jhs_origin_dns_type: type: string description: The type of DNS record associated with the origin. "" is used to specify a combination of A/AAAA records. enum: - "" - A - AAAA - SRV example: "" legacy-jhs_origin_port: anyOf: - type: integer - type: string description: |- The destination port at the origin. Only specified in conjunction with origin_dns. May use an integer to specify a single origin port, for example `1000`, or a string to specify a range of origin ports, for example `"1000-2000"`. Notes: If specifying a port range, the number of ports in the range must match the number of ports specified in the "protocol" field. example: 22 minimum: 1 maximum: 65535 legacy-jhs_protocol: type: string description: The port configuration at Cloudflare’s edge. May specify a single port, for example `"tcp/1000"`, or a range of ports, for example `"tcp/1000-2000"`. example: tcp/22 legacy-jhs_proxy_protocol: type: string description: Enables Proxy Protocol to the origin. Refer to [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/) for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol. enum: - "off" - v1 - v2 - simple default: "off" example: "off" legacy-jhs_response_collection: allOf: - $ref: '#/components/schemas/legacy-jhs_api-response-collection' - properties: result: type: array items: type: object legacy-jhs_response_single: allOf: - $ref: '#/components/schemas/legacy-jhs_api-response-single' - type: object properties: result: 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: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 legacy-jhs_schemas-response_collection: allOf: - $ref: '#/components/schemas/legacy-jhs_api-response-common' - properties: result: type: array items: type: object legacy-jhs_sort: type: array description: The sort order for the result set; sort fields must be included in `metrics` or `dimensions`. example: - +count - -bytesIngress items: {} legacy-jhs_timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true legacy-jhs_tls: type: string description: The type of TLS termination associated with the application. enum: - "off" - flexible - full - strict example: full legacy-jhs_traffic_type: type: string description: Determines how data travels from the edge to your origin. When set to "direct", Spectrum will send traffic directly to your origin, and the application's type is derived from the `protocol`. When set to "http" or "https", Spectrum will apply Cloudflare's HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly. enum: - direct - http - https default: direct example: direct legacy-jhs_until: type: string format: date-time description: End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified. example: "2014-01-02T03:20:00Z" legacy-jhs_value: type: string enum: - flexible - full - strict example: strict lists_api-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-common' - properties: result: type: array nullable: true items: {} type: object lists_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/lists_messages' messages: $ref: '#/components/schemas/lists_messages' result: anyOf: - type: object - type: array items: {} success: type: boolean description: Whether the API call was successful enum: - true example: true lists_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false lists_bulk-operation-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - type: object properties: result: $ref: '#/components/schemas/lists_operation' lists_created_on: type: string description: The RFC 3339 timestamp of when the list was created. example: "2020-01-01T08:00:00Z" lists_description: type: string description: An informative summary of the list. example: This is a note maxLength: 500 lists_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 lists_item: 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' type: object example: comment: Private IP address created_on: "2020-01-01T08:00:00Z" id: 2c0fc9fa937b11eaa1b71c4d701ab86e ip: 10.0.0.1 modified_on: "2020-01-10T14:00:00Z" properties: asn: $ref: '#/components/schemas/lists_item_asn' comment: $ref: '#/components/schemas/lists_item_comment' created_on: type: string description: The RFC 3339 timestamp of when the item was created. example: "2020-01-01T08:00:00Z" readOnly: true hostname: $ref: '#/components/schemas/lists_item_hostname' id: $ref: '#/components/schemas/lists_list_id' ip: $ref: '#/components/schemas/lists_item_ip' modified_on: type: string description: The RFC 3339 timestamp of when the item was last modified. example: "2020-01-10T14:00:00Z" readOnly: true redirect: $ref: '#/components/schemas/lists_item_redirect' lists_item-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - type: object properties: result: $ref: '#/components/schemas/lists_item' lists_item_asn: type: integer description: A non-negative 32 bit integer example: 5567 lists_item_comment: type: string description: An informative summary of the list item. example: Private IP address 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 (-). required: - url_hostname properties: url_hostname: type: string example: example.com lists_item_id: type: string description: The unique ID of the item in the List. example: 34b12448945f11eaa1b71c4d701ab86e lists_item_ip: type: string description: An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64. example: 10.0.0.1 lists_item_redirect: description: The definition of the redirect. required: - source_url - target_url properties: include_subdomains: type: boolean default: false preserve_path_suffix: type: boolean default: false preserve_query_string: type: boolean default: false source_url: type: string example: example.com/arch status_code: type: integer enum: - 301 - 302 - 307 - 308 default: 301 subpath_matching: type: boolean default: false target_url: type: string example: https://archlinux.org/ lists_items: type: array items: $ref: '#/components/schemas/lists_item' lists_items-list-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - type: object properties: result: $ref: '#/components/schemas/lists_items' result_info: type: object properties: cursors: type: object properties: after: type: string example: yyy before: type: string example: xxx lists_items-update-request-collection: type: array items: allOf: - type: object 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' 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: type: object 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' lists_list-delete-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - type: object properties: result: type: object properties: id: $ref: '#/components/schemas/lists_item_id' type: object lists_list-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - type: object properties: result: $ref: '#/components/schemas/lists_list' type: object lists_list_id: type: string description: The unique ID of the list. example: 2c0fc9fa937b11eaa1b71c4d701ab86e readOnly: true minLength: 32 maxLength: 32 lists_lists-async-response: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - type: object properties: result: type: object properties: operation_id: $ref: '#/components/schemas/lists_operation_id' lists_lists-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - type: object properties: result: type: array items: allOf: - $ref: '#/components/schemas/lists_list' - type: object required: - id - name - kind - num_items - created_on - modified_on type: object lists_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string lists_modified_on: type: string description: The RFC 3339 timestamp of when the list was last modified. example: "2020-01-10T14:00:00Z" lists_name: type: string description: An informative name for the list. Use this name in filter and rule expressions. example: list1 maxLength: 50 pattern: ^[a-zA-Z0-9_]+$ lists_num_items: type: number description: The number of items in the list. example: 10 lists_num_referencing_filters: type: number description: The number of [filters](/operations/filters-list-filters) referencing the list. example: 2 lists_operation: type: object required: - id - status properties: completed: type: string description: The RFC 3339 timestamp of when the operation was completed. example: "2020-01-01T08:00:00Z" readOnly: true error: type: string description: A message describing the error when the status is `failed`. example: This list is at the maximum number of items readOnly: true id: $ref: '#/components/schemas/lists_operation_id' status: type: string description: The current status of the asynchronous operation. enum: - pending - running - completed - failed example: failed readOnly: true lists_operation_id: type: string description: The unique operation ID of the asynchronous action. example: 4da8780eeb215e6cb7f48dd981c4ea02 readOnly: true load-balancing_Host: type: array description: The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin. items: type: string example: example.com load-balancing_adaptive_routing: type: object description: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin. properties: failover_across_pools: type: boolean description: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned. default: false example: true load-balancing_address: type: string 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 load-balancing_allow_insecure: type: boolean description: Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. default: false example: true load-balancing_analytics: type: object properties: id: type: integer default: 1 origins: type: array example: - address: 198.51.100.4 changed: true enabled: true failure_reason: No failures healthy: true ip: 198.51.100.4 name: some-origin items: {} pool: type: object example: changed: true healthy: true id: 74bc6a8b9b0dda3d651707a2928bad0c minimum_origins: 1 name: some-pool timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" load-balancing_api-response-collection: allOf: - $ref: '#/components/schemas/load-balancing_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/load-balancing_result_info' type: object load-balancing_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/load-balancing_messages' messages: $ref: '#/components/schemas/load-balancing_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true load-balancing_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/load-balancing_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/load-balancing_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false load-balancing_api-response-single: allOf: - $ref: '#/components/schemas/load-balancing_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object load-balancing_check_regions: type: array description: A list of regions from which to run health checks. Null means every Cloudflare data center. example: - WEU - ENAM nullable: true items: type: string description: 'WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (ENTERPRISE customers only).' enum: - WNAM - ENAM - WEU - EEU - NSAM - SSAM - OC - ME - NAF - SAF - SAS - SEAS - NEAS - ALL_REGIONS load-balancing_components-schemas-description: type: string description: Object description. example: Load Balancer for www.example.com load-balancing_components-schemas-enabled: type: boolean description: Whether to enable (the default) this load balancer. default: true example: true load-balancing_components-schemas-id_response: allOf: - $ref: '#/components/schemas/load-balancing_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier' load-balancing_components-schemas-identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 load-balancing_components-schemas-name: type: string description: The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used. example: www.example.com load-balancing_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/load-balancing_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/load-balancing_analytics' load-balancing_components-schemas-single_response: allOf: - $ref: '#/components/schemas/load-balancing_api-response-single' - properties: result: type: object description: A list of countries and subdivisions mapped to a region. example: iso_standard: Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO 3166-2 regions: - countries: - country_code_a2: CA country_name: Canada country_subdivisions: - subdivision_code_a2: AB subdivision_name: Alberta - subdivision_code_a2: BC subdivision_name: British Columbia - country_code_a2: HT country_name: Haiti - country_code_a2: MX country_name: Mexico - country_code_a2: US country_name: United States country_subdivisions: - subdivision_code_a2: AZ subdivision_name: Arizona - subdivision_code_a2: CA subdivision_name: California - subdivision_code_a2: CO subdivision_name: Colorado - subdivision_code_a2: HI subdivision_name: Hawaii - subdivision_code_a2: MN subdivision_name: Minnesota - subdivision_code_a2: MO subdivision_name: Missouri - subdivision_code_a2: NV subdivision_name: Nevada - subdivision_code_a2: OR subdivision_name: Oregon - subdivision_code_a2: TX subdivision_name: Texas - subdivision_code_a2: UT subdivision_name: Utah - subdivision_code_a2: WA subdivision_name: Washington region_code: WNAM load-balancing_consecutive_down: type: integer description: To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. default: 0 load-balancing_consecutive_up: type: integer description: To be marked healthy the monitored origin must pass this healthcheck N consecutive times. default: 0 load-balancing_country_pools: type: object description: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools. example: GB: - abd90f38ced07c2e2f4df50b1f61d4194 US: - de90f38ced07c2e2f4df50b1f61d4194 - 00920f38ce07c2e2f4df50b1f61d4194 load-balancing_default_pools: type: array description: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region. example: - 17b5962d775c646f3f9725cbc7a53df4 - 9290f38c5d07c2e2f4df57b1f61d4196 - 00920f38ce07c2e2f4df50b1f61d4194 items: type: string description: A pool ID. load-balancing_description: type: string description: Object description. example: Login page monitor load-balancing_disabled_at: type: string format: date-time description: This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. readOnly: true load-balancing_enabled: type: boolean description: Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any). default: true example: false load-balancing_expected_body: type: string description: A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors. example: alive load-balancing_expected_codes: type: string description: The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. default: "200" example: 2xx load-balancing_fallback_pool: description: The pool ID to use when all other pools are detected as unhealthy. load-balancing_filter_options: type: object description: Filter options for a particular resource type (pool or origin). Use null to reset. nullable: true properties: disable: type: boolean description: If set true, disable notifications for this type of resource (pool or origin). default: false healthy: type: boolean description: If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events). nullable: true load-balancing_follow_redirects: type: boolean description: Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. default: false example: true load-balancing_header: type: object description: The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors. example: Host: - example.com X-App-ID: - abc123 load-balancing_health_details: allOf: - $ref: '#/components/schemas/load-balancing_api-response-single' - properties: result: type: object description: A list of regions from which to run health checks. Null means every Cloudflare data center. example: pool_id: 17b5962d775c646f3f9725cbc7a53df4 pop_health: Amsterdam, NL: healthy: true origins: - 2001:DB8::5: failure_reason: No failures healthy: true response_code: 401 rtt: 12.1ms load-balancing_id_response: allOf: - $ref: '#/components/schemas/load-balancing_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/load-balancing_identifier' load-balancing_identifier: type: string example: f1aba936b94213e5b8dca0c0dbf1f9cc load-balancing_interval: type: integer description: The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. default: 60 load-balancing_latitude: type: number description: The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set. load-balancing_load-balancer: type: object properties: adaptive_routing: $ref: '#/components/schemas/load-balancing_adaptive_routing' country_pools: $ref: '#/components/schemas/load-balancing_country_pools' created_on: $ref: '#/components/schemas/load-balancing_timestamp' default_pools: $ref: '#/components/schemas/load-balancing_default_pools' description: $ref: '#/components/schemas/load-balancing_components-schemas-description' enabled: $ref: '#/components/schemas/load-balancing_components-schemas-enabled' fallback_pool: $ref: '#/components/schemas/load-balancing_fallback_pool' id: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier' location_strategy: $ref: '#/components/schemas/load-balancing_location_strategy' modified_on: $ref: '#/components/schemas/load-balancing_timestamp' name: $ref: '#/components/schemas/load-balancing_components-schemas-name' pop_pools: $ref: '#/components/schemas/load-balancing_pop_pools' proxied: $ref: '#/components/schemas/load-balancing_proxied' random_steering: $ref: '#/components/schemas/load-balancing_random_steering' region_pools: $ref: '#/components/schemas/load-balancing_region_pools' rules: $ref: '#/components/schemas/load-balancing_rules' session_affinity: $ref: '#/components/schemas/load-balancing_session_affinity' session_affinity_attributes: $ref: '#/components/schemas/load-balancing_session_affinity_attributes' session_affinity_ttl: $ref: '#/components/schemas/load-balancing_session_affinity_ttl' steering_policy: $ref: '#/components/schemas/load-balancing_steering_policy' ttl: $ref: '#/components/schemas/load-balancing_ttl' load-balancing_load-balancer_components-schemas-identifier: type: string example: 699d98642c564d2e855e9661899b7252 load-balancing_load-balancer_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/load-balancing_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/load-balancing_load-balancer' 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: type: object description: Configures load shedding policies and percentages for the pool. properties: default_percent: type: number description: The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity. default: 0 minimum: 0 maximum: 100 default_policy: type: string description: The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. enum: - random - hash default: random session_percent: type: number description: The percent of existing sessions to shed from the pool, according to the session policy. default: 0 minimum: 0 maximum: 100 session_policy: type: string description: Only the hash policy is supported for existing sessions (to avoid exponential decay). enum: - hash default: hash load-balancing_location_strategy: type: object description: Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected. properties: mode: type: string description: |- Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful. - `"pop"`: Use the Cloudflare PoP location. - `"resolver_ip"`: Use the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location. enum: - pop - resolver_ip default: pop example: resolver_ip prefer_ecs: type: string description: |- Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location. - `"always"`: Always prefer ECS. - `"never"`: Never prefer ECS. - `"proximity"`: Prefer ECS only when `steering_policy="proximity"`. - `"geo"`: Prefer ECS only when `steering_policy="geo"`. enum: - always - never - proximity - geo default: proximity example: always load-balancing_longitude: type: number description: The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set. load-balancing_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string load-balancing_method: type: string description: The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks. default: GET example: GET load-balancing_minimum_origins: type: integer description: The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool. default: 1 load-balancing_monitor: allOf: - $ref: '#/components/schemas/load-balancing_monitor-editable' - type: object properties: created_on: $ref: '#/components/schemas/load-balancing_timestamp' id: $ref: '#/components/schemas/load-balancing_identifier' modified_on: $ref: '#/components/schemas/load-balancing_timestamp' load-balancing_monitor-editable: type: object 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' load-balancing_monitor-response-collection: allOf: - $ref: '#/components/schemas/load-balancing_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/load-balancing_monitor' 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. load-balancing_name: type: string description: A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. example: primary-dc-1 load-balancing_notification_email: type: string 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 load-balancing_notification_filter: type: object description: Filter pool and origin health notifications by resource type or health status. Use null to reset. example: origin: disable: true pool: healthy: false nullable: true properties: origin: $ref: '#/components/schemas/load-balancing_filter_options' pool: $ref: '#/components/schemas/load-balancing_filter_options' load-balancing_origin: type: object 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' load-balancing_origin_health_data: type: object 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 load-balancing_origin_healthy: type: boolean description: If true, filter events where the origin status is healthy. If false, filter events where the origin status is unhealthy. default: true example: true load-balancing_origin_steering: type: object description: Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. properties: policy: type: string description: |- The type of origin steering policy to use. - `"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 default: random load-balancing_origins: type: array description: The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. items: $ref: '#/components/schemas/load-balancing_origin' load-balancing_patch_pools_notification_email: type: string description: The email address to send health status notifications to. This field is now deprecated in favor of Cloudflare Notifications for Load Balancing, so only resetting this field with an empty string `""` is accepted. enum: - '""' example: '""' load-balancing_path: type: string description: The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. default: / example: /health load-balancing_pool: type: object 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' 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' load-balancing_pool_name: type: string description: The name for the pool to filter. example: primary-dc load-balancing_pop_pools: type: object description: '(Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.' example: LAX: - de90f38ced07c2e2f4df50b1f61d4194 - 9290f38c5d07c2e2f4df57b1f61d4196 LHR: - abd90f38ced07c2e2f4df50b1f61d4194 - f9138c5d07c2e2f4df57b1f61d4196 SJC: - 00920f38ce07c2e2f4df50b1f61d4194 load-balancing_port: type: integer description: 'The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).' default: 0 load-balancing_preview_id: example: f1aba936b94213e5b8dca0c0dbf1f9cc load-balancing_preview_response: allOf: - $ref: '#/components/schemas/load-balancing_api-response-single' - properties: result: type: object properties: pools: type: object description: Monitored pool IDs mapped to their respective names. example: abwlnp5jbqn45ecgxd03erbgtxtqai0d: WNAM Datacenter ve8h9lrcip5n5bbga9yqmdws28ay5d0l: EEU Datacenter preview_id: $ref: '#/components/schemas/load-balancing_identifier' load-balancing_preview_result: 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 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: type: string description: Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. example: example.com load-balancing_proxied: type: boolean description: Whether the hostname should be gray clouded (false) or orange clouded (true). default: false example: true load-balancing_random_steering: type: object description: |- Configures pool weights. - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights. - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests. - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections. properties: default_weight: type: number description: The default weight for pools in the load balancer that are not specified in the pool_weights map. default: 1 example: 0.2 minimum: 0 maximum: 1 multipleOf: 0.1 pool_weights: type: object description: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer. example: 9290f38c5d07c2e2f4df57b1f61d4196: 0.5 de90f38ced07c2e2f4df50b1f61d4194: 0.3 load-balancing_references_response: allOf: - $ref: '#/components/schemas/load-balancing_api-response-collection' - properties: result: type: array description: List of resources that reference a given monitor. example: - reference_type: referrer resource_id: 17b5962d775c646f3f9725cbc7a53df4 resource_name: primary-dc-1 resource_type: pool items: type: object properties: reference_type: type: string enum: - '*' - referral - referrer resource_id: type: string resource_name: type: string resource_type: type: string load-balancing_region_code: type: string description: 'A list of Cloudflare regions. WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia).' enum: - WNAM - ENAM - WEU - EEU - NSAM - SSAM - OC - ME - NAF - SAF - SAS - SEAS - NEAS example: WNAM load-balancing_region_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/load-balancing_api-response-single' - properties: result: type: object load-balancing_region_pools: type: object description: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools. example: ENAM: - 00920f38ce07c2e2f4df50b1f61d4194 WNAM: - de90f38ced07c2e2f4df50b1f61d4194 - 9290f38c5d07c2e2f4df57b1f61d4196 load-balancing_resource_reference: type: object description: A reference to a load balancer resource. properties: reference_type: type: string description: When listed as a reference, the type (direction) of the reference. enum: - referral - referrer references: type: array description: A list of references to (referrer) or from (referral) this resource. example: - reference_type: referrer resource_id: 699d98642c564d2e855e9661899b7252 resource_name: www.example.com resource_type: load_balancer - reference_type: referral resource_id: f1aba936b94213e5b8dca0c0dbf1f9cc resource_name: Login page monitor resource_type: monitor items: type: object description: A reference to a load balancer resource. resource_id: example: 17b5962d775c646f3f9725cbc7a53df4 resource_name: type: string description: The human-identifiable name of the resource. example: primary-dc-1 resource_type: type: string description: The type of the resource. enum: - load_balancer - monitor - pool example: pool load-balancing_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 load-balancing_retries: type: integer description: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. default: 2 load-balancing_rules: type: array description: 'BETA Field Not General Access: A list of rules for this load balancer to execute.' items: type: object description: A rule object containing conditions and overrides for this load balancer to evaluate. properties: condition: type: string description: The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions. example: http.request.uri.path contains "/testing" disabled: type: boolean description: Disable this specific rule. It will no longer be evaluated by this load balancer. default: false fixed_response: type: object description: A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates. properties: content_type: type: string description: The http 'Content-Type' header to include in the response. example: application/json maxLength: 32 location: type: string description: The http 'Location' header to include in the response. example: www.example.com maxLength: 2048 message_body: type: string description: Text to include as the http body. example: Testing Hello maxLength: 1024 status_code: type: integer description: The http status code to respond with. name: type: string description: Name of this rule. Only used for human readability. example: route the path /testing to testing datacenter. maxLength: 200 overrides: type: object description: A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional. properties: adaptive_routing: $ref: '#/components/schemas/load-balancing_adaptive_routing' country_pools: $ref: '#/components/schemas/load-balancing_country_pools' default_pools: $ref: '#/components/schemas/load-balancing_default_pools' fallback_pool: $ref: '#/components/schemas/load-balancing_fallback_pool' location_strategy: $ref: '#/components/schemas/load-balancing_location_strategy' pop_pools: $ref: '#/components/schemas/load-balancing_pop_pools' random_steering: $ref: '#/components/schemas/load-balancing_random_steering' region_pools: $ref: '#/components/schemas/load-balancing_region_pools' session_affinity: $ref: '#/components/schemas/load-balancing_session_affinity' session_affinity_attributes: $ref: '#/components/schemas/load-balancing_session_affinity_attributes' session_affinity_ttl: $ref: '#/components/schemas/load-balancing_session_affinity_ttl' steering_policy: $ref: '#/components/schemas/load-balancing_steering_policy' ttl: $ref: '#/components/schemas/load-balancing_ttl' priority: type: integer description: The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority. default: 0 minimum: 0 terminates: type: boolean description: If this rule's condition is true, this causes rule evaluation to stop after processing this rule. default: false load-balancing_schemas-description: type: string description: A human-readable description of the pool. example: Primary data center - Provider XYZ load-balancing_schemas-disabled_at: type: string format: date-time description: This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. readOnly: true load-balancing_schemas-enabled: type: boolean description: Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool. default: true example: true load-balancing_schemas-header: type: object description: The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'. properties: Host: $ref: '#/components/schemas/load-balancing_Host' load-balancing_schemas-id_response: allOf: - $ref: '#/components/schemas/load-balancing_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/load-balancing_schemas-identifier' load-balancing_schemas-identifier: type: string example: 17b5962d775c646f3f9725cbc7a53df4 load-balancing_schemas-name: type: string description: A human-identifiable name for the origin. example: app-server-1 load-balancing_schemas-preview_id: example: p1aba936b94213e5b8dca0c0dbf1f9cc load-balancing_schemas-references_response: allOf: - $ref: '#/components/schemas/load-balancing_api-response-collection' - properties: result: type: array description: List of resources that reference a given pool. example: - reference_type: referrer resource_id: 699d98642c564d2e855e9661899b7252 resource_name: www.example.com resource_type: load_balancer - reference_type: referral resource_id: f1aba936b94213e5b8dca0c0dbf1f9cc resource_name: Login page monitor resource_type: monitor items: type: object properties: reference_type: type: string enum: - '*' - referral - referrer resource_id: type: string resource_name: type: string resource_type: type: string load-balancing_schemas-response_collection: allOf: - $ref: '#/components/schemas/load-balancing_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/load-balancing_pool' 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: type: object properties: resources: type: array description: A list of resources matching the search query. items: $ref: '#/components/schemas/load-balancing_resource_reference' load-balancing_search_params: type: object properties: query: type: string description: Search query term. default: "" example: primary references: type: string description: The type of references to include ("*" for all). enum: - "" - '*' - referral - referrer default: "" example: '*' load-balancing_search_result: type: object properties: result: $ref: '#/components/schemas/load-balancing_search' load-balancing_session_affinity: type: string description: |- Specifies the type of session affinity the load balancer should use unless specified as `"none"` or "" (default). The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration. enum: - none - cookie - ip_cookie - header - '""' default: '""' example: cookie load-balancing_session_affinity_attributes: type: object description: Configures attributes for session affinity. properties: drain_duration: type: number description: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer. example: 100 headers: type: array description: 'Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:,"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.' default: none uniqueItems: true items: type: string description: An HTTP header name. minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9_-]+$ require_all_headers: type: boolean description: |- When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. default: false samesite: type: string description: 'Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".' enum: - Auto - Lax - None - Strict default: Auto example: Auto secure: type: string description: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. enum: - Auto - Always - Never default: Auto example: Auto zero_downtime_failover: type: string description: |- Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header. enum: - none - temporary - sticky default: none example: sticky load-balancing_session_affinity_ttl: type: number description: |- Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified. example: 1800 load-balancing_steering_policy: type: string description: |- Steering Policy for this load balancer. - `"off"`: Use `default_pools`. - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`. - `"random"`: Select a pool randomly. - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks). - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests. - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others. - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`. enum: - "off" - geo - random - dynamic_latency - proximity - least_outstanding_requests - least_connections - '""' default: '""' example: dynamic_latency load-balancing_subdivision_code_a2: type: string description: Two-letter subdivision code followed in ISO 3166-2. example: CA load-balancing_timeout: type: integer description: The timeout (in seconds) before marking the health check as failed. default: 5 load-balancing_timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true load-balancing_ttl: type: number description: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers. example: 30 load-balancing_type: type: string description: The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. enum: - http - https - tcp - udp_icmp - icmp_ping - smtp default: http example: https load-balancing_until: type: string format: date-time description: End date and time of requesting data period in the ISO8601 format. example: "2016-11-11T13:00:00Z" load-balancing_virtual_network_id: type: string description: The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. example: a5624d4e-044a-4ff0-b3e1-e2465353d4b4 load-balancing_weight: type: number description: |- The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool. - `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. default: 1 example: 0.6 minimum: 0 maximum: 1 multipleOf: 0.01 logcontrol_account_identifier: $ref: '#/components/schemas/logcontrol_identifier' logcontrol_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/logcontrol_messages' messages: $ref: '#/components/schemas/logcontrol_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true logcontrol_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false logcontrol_api-response-single: allOf: - $ref: '#/components/schemas/logcontrol_api-response-common' - properties: result: anyOf: - type: object - type: string type: object logcontrol_cmb_config: type: object nullable: true properties: regions: $ref: '#/components/schemas/logcontrol_regions' logcontrol_cmb_config_response_single: allOf: - $ref: '#/components/schemas/logcontrol_api-response-single' - properties: result: $ref: '#/components/schemas/logcontrol_cmb_config' logcontrol_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 logcontrol_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string logcontrol_regions: type: string description: Comma-separated list of regions. example: eu maxLength: 256 pattern: ^[a-z,]*$ logpush_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/logpush_messages' messages: $ref: '#/components/schemas/logpush_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true logpush_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/logpush_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/logpush_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false logpush_api-response-single: allOf: - $ref: '#/components/schemas/logpush_api-response-common' - properties: result: anyOf: - type: object - type: string type: object logpush_dataset: type: string description: Name of the dataset. example: http_requests nullable: true maxLength: 256 pattern: ^[a-zA-Z0-9_\-]*$ logpush_destination_conf: type: string format: uri description: Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included. example: s3://mybucket/logs?region=us-west-2 maxLength: 4096 logpush_destination_exists_response: allOf: - $ref: '#/components/schemas/logpush_api-response-common' - properties: result: type: object nullable: true properties: exists: type: boolean example: false logpush_enabled: type: boolean description: Flag that indicates if the job is enabled. example: false logpush_error_message: type: string format: date-time description: 'If not null, the job is currently failing. Failures are usually repetitive (example: no permissions to write to destination bucket). Only the last failure is recorded. On successful execution of a job the error_message and last_error are set to null.' nullable: true logpush_fields: type: string description: Comma-separated list of fields. example: ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID logpush_filter: type: string description: Filters to drill down into specific events. example: '{"where":{"and":[{"key":"ClientCountry","operator":"neq","value":"ca"}]}}' logpush_frequency: type: string description: The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files. enum: - high - low default: high example: high nullable: true logpush_get_ownership_response: allOf: - $ref: '#/components/schemas/logpush_api-response-common' - properties: result: type: object nullable: true properties: filename: type: string example: logs/challenge-filename.txt message: type: string example: "" valid: type: boolean example: true logpush_id: type: integer description: Unique id of the job. minimum: 1 logpush_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 logpush_instant_logs_job: type: object nullable: true properties: destination_conf: $ref: '#/components/schemas/logpush_schemas-destination_conf' fields: $ref: '#/components/schemas/logpush_fields' filter: $ref: '#/components/schemas/logpush_filter' sample: $ref: '#/components/schemas/logpush_sample' session_id: $ref: '#/components/schemas/logpush_session_id' logpush_instant_logs_job_response_collection: allOf: - $ref: '#/components/schemas/logpush_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/logpush_instant_logs_job' logpush_instant_logs_job_response_single: allOf: - $ref: '#/components/schemas/logpush_api-response-single' - properties: result: $ref: '#/components/schemas/logpush_instant_logs_job' logpush_last_complete: type: string format: date-time description: Records the last time for which logs have been successfully pushed. If the last successful push was for logs range 2018-07-23T10:00:00Z to 2018-07-23T10:01:00Z then the value of this field will be 2018-07-23T10:01:00Z. If the job has never run or has just been enabled and hasn't run yet then the field will be empty. nullable: true logpush_last_error: type: string format: date-time description: Records the last time the job failed. If not null, the job is currently failing. If null, the job has either never failed or has run successfully at least once since last failure. See also the error_message field. nullable: true logpush_logpull_options: type: string format: uri-reference description: This field is deprecated. Use `output_options` instead. Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately. example: fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339 nullable: true deprecated: true maxLength: 4096 logpush_logpush_field_response_collection: allOf: - $ref: '#/components/schemas/logpush_api-response-common' - properties: result: type: object items: type: object nullable: true properties: key: type: string example: value logpush_logpush_job: type: object nullable: true properties: dataset: $ref: '#/components/schemas/logpush_dataset' destination_conf: $ref: '#/components/schemas/logpush_destination_conf' enabled: $ref: '#/components/schemas/logpush_enabled' error_message: $ref: '#/components/schemas/logpush_error_message' frequency: $ref: '#/components/schemas/logpush_frequency' id: $ref: '#/components/schemas/logpush_id' last_complete: $ref: '#/components/schemas/logpush_last_complete' last_error: $ref: '#/components/schemas/logpush_last_error' logpull_options: $ref: '#/components/schemas/logpush_logpull_options' name: $ref: '#/components/schemas/logpush_name' output_options: $ref: '#/components/schemas/logpush_output_options' logpush_logpush_job_response_collection: allOf: - $ref: '#/components/schemas/logpush_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/logpush_logpush_job' logpush_logpush_job_response_single: allOf: - $ref: '#/components/schemas/logpush_api-response-single' - properties: result: $ref: '#/components/schemas/logpush_logpush_job' logpush_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string logpush_name: type: string description: Optional human readable job name. Not unique. Cloudflare suggests that you set this to a meaningful string, like the domain name, to make it easier to identify your job. example: example.com nullable: true maxLength: 512 pattern: ^[a-zA-Z0-9\-\.]*$ logpush_output_options: type: object description: The structured replacement for `logpull_options`. When including this field, the `logpull_option` field will be ignored. nullable: true properties: CVE-2021-4428: type: boolean description: If set to true, will cause all occurrences of `${` in the generated files to be replaced with `x{`. default: false nullable: true batch_prefix: type: string description: String to be prepended before each batch. default: "" nullable: true batch_suffix: type: string description: String to be appended after each batch. default: "" nullable: true field_delimiter: type: string description: String to join fields. This field be ignored when `record_template` is set. default: ',' nullable: true field_names: type: array description: List of field names to be included in the Logpush output. For the moment, there is no option to add all fields at once, so you must specify all the fields names you are interested in. example: - ClientIP - EdgeStartTimestamp - RayID items: type: string output_type: type: string description: Specifies the output type, such as `ndjson` or `csv`. This sets default values for the rest of the settings, depending on the chosen output type. Some formatting rules, like string quoting, are different between output types. enum: - ndjson - csv default: ndjson example: ndjson record_delimiter: type: string description: String to be inserted in-between the records as separator. default: "" nullable: true record_prefix: type: string description: String to be prepended before each record. default: '{' nullable: true record_suffix: type: string description: String to be appended after each record. default: | } nullable: true record_template: type: string description: String to use as template for each record instead of the default comma-separated list. All fields used in the template must be present in `field_names` as well, otherwise they will end up as null. Format as a Go `text/template` without any standard functions, like conditionals, loops, sub-templates, etc. default: "" nullable: true sample_rate: type: number format: float description: Floating number to specify sampling rate. Sampling is applied on top of filtering, and regardless of the current `sample_interval` of the data. default: 1 nullable: true minimum: 0 maximum: 1 timestamp_format: type: string description: String to specify the format for timestamps, such as `unixnano`, `unix`, or `rfc3339`. enum: - unixnano - unix - rfc3339 default: unixnano logpush_ownership_challenge: type: string description: Ownership challenge token to prove destination ownership. example: "00000000000000000000" maxLength: 4096 pattern: ^[a-zA-Z0-9/\+\.\-_]*$ logpush_sample: type: integer description: 'The sample parameter is the sample rate of the records set by the client: "sample": 1 is 100% of records "sample": 10 is 10% and so on.' example: 1 logpush_schemas-destination_conf: type: string format: uri description: Unique WebSocket address that will receive messages from Cloudflare’s edge. example: wss://logs.cloudflare.com/instant-logs/ws/sessions/99d471b1ca3c23cc8e30b6acec5db987 maxLength: 4096 logpush_session_id: type: string description: Unique session id of the job. example: 99d471b1ca3c23cc8e30b6acec5db987 logpush_validate_ownership_response: allOf: - $ref: '#/components/schemas/logpush_api-response-common' - properties: result: type: object nullable: true properties: valid: type: boolean example: true logpush_validate_response: allOf: - $ref: '#/components/schemas/logpush_api-response-common' - properties: result: type: object nullable: true properties: message: type: string example: "" valid: type: boolean example: true magic-transit_api-response-collection: allOf: - $ref: '#/components/schemas/magic-transit_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/magic-transit_result_info' type: object magic-transit_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/magic-transit_messages' messages: $ref: '#/components/schemas/magic-transit_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true magic-transit_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false magic-transit_asn: type: string description: AS number associated with the node object. magic-transit_colo: type: object properties: city: $ref: '#/components/schemas/magic-transit_colo_city' name: $ref: '#/components/schemas/magic-transit_colo_name' magic-transit_colo_city: type: string description: Source colo city. example: Denver, CO, US magic-transit_colo_name: type: string description: Source colo name. example: den01 magic-transit_colo_result: type: object properties: colo: $ref: '#/components/schemas/magic-transit_colo' error: $ref: '#/components/schemas/magic-transit_error' hops: type: array items: $ref: '#/components/schemas/magic-transit_hop_result' target_summary: $ref: '#/components/schemas/magic-transit_target_summary' traceroute_time_ms: $ref: '#/components/schemas/magic-transit_traceroute_time_ms' magic-transit_colos: type: array description: If no source colo names specified, all colos will be used. China colos are unavailable for traceroutes. example: - den - sin items: type: string description: Source colo name. magic-transit_error: type: string description: Errors resulting from collecting traceroute from colo to target. enum: - "" - 'Could not gather traceroute data: Code 1' - 'Could not gather traceroute data: Code 2' - 'Could not gather traceroute data: Code 3' - 'Could not gather traceroute data: Code 4' example: "" magic-transit_hop_result: type: object properties: nodes: type: array description: An array of node objects. items: $ref: '#/components/schemas/magic-transit_node_result' 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' magic-transit_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 magic-transit_ip: type: string description: IP address of the node. magic-transit_labels: type: array description: Field appears if there is an additional annotation printed when the probe returns. Field also appears when running a GRE+ICMP traceroute to denote which traceroute a node comes from. items: type: string magic-transit_max_rtt_ms: type: number description: Maximum RTT in ms. magic-transit_max_ttl: type: integer description: Max TTL. default: 15 minimum: 0 maximum: 64 magic-transit_mean_rtt_ms: type: number description: Mean RTT in ms. magic-transit_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string magic-transit_min_rtt_ms: type: number description: Minimum RTT in ms. magic-transit_name: type: string description: Host name of the address, this may be the same as the IP address. magic-transit_node_result: type: object example: asn: AS13335 ip: 1.1.1.1 max_latency_ms: 0.034 mean_latency_ms: 0.021 min_latency_ms: 0.014 name: one.one.one.one packet_count: 3 std_dev_latency_ms: 0.011269427669584647 properties: asn: $ref: '#/components/schemas/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' 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: type: integer description: Number of packets with a response from this node. magic-transit_packet_type: type: string description: Type of packet sent. enum: - icmp - tcp - udp - gre - gre+icmp default: icmp example: icmp magic-transit_packets_lost: type: integer description: Number of packets where no response was received. magic-transit_packets_per_ttl: type: integer description: Number of packets sent at each TTL. default: 3 minimum: 0 maximum: 10 magic-transit_packets_sent: type: integer description: Number of packets sent with specified TTL. magic-transit_packets_ttl: type: integer description: The time to live (TTL). magic-transit_port: type: integer description: For UDP and TCP, specifies the destination port. For ICMP, specifies the initial ICMP sequence value. Default value 0 will choose the best value to use for each protocol. default: 0 minimum: 0 maximum: 65535 magic-transit_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 magic-transit_std_dev_rtt_ms: type: number description: Standard deviation of the RTTs in ms. magic-transit_target: type: string description: The target hostname, IPv6, or IPv6 address. example: 1.1.1.1 magic-transit_target_result: type: object properties: colos: type: array items: $ref: '#/components/schemas/magic-transit_colo_result' target: $ref: '#/components/schemas/magic-transit_target' magic-transit_target_summary: type: object description: Aggregated statistics from all hops about the target. example: asn: "" ip: 1.1.1.1 max_latency_ms: 0.034 mean_latency_ms: 0.021 min_latency_ms: 0.014 name: 1.1.1.1 packet_count: 3 std_dev_latency_ms: 0.011269427669584647 magic-transit_targets: type: array example: - 203.0.113.1 - cloudflare.com maxLength: 10 items: type: string description: Hosts as a hostname or IPv4/IPv6 address represented by strings. example: 203.0.113.1 magic-transit_traceroute_response_collection: allOf: - $ref: '#/components/schemas/magic-transit_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/magic-transit_target_result' magic-transit_traceroute_time_ms: type: integer description: Total time of traceroute in ms. magic-transit_wait_time: type: integer description: Set the time (in seconds) to wait for a response to a probe. default: 1 minimum: 1 maximum: 5 magic-visibility_account_identifier: type: string example: 6f91088a406011ed95aed352566e8d4c magic-visibility_api-response-collection: allOf: - $ref: '#/components/schemas/magic-visibility_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/magic-visibility_result_info' type: object magic-visibility_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/magic-visibility_messages' messages: $ref: '#/components/schemas/magic-visibility_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true magic-visibility_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false magic-visibility_api-response-single: allOf: - $ref: '#/components/schemas/magic-visibility_api-response-common' - properties: result: anyOf: - type: object - type: string type: object magic-visibility_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 magic-visibility_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string magic-visibility_mnm_config: type: object required: - name - default_sampling - router_ips 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' magic-visibility_mnm_config_default_sampling: type: number description: Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router. default: 1 minimum: 1 magic-visibility_mnm_config_name: type: string description: The account name. example: cloudflare user's account magic-visibility_mnm_config_router_ip: type: string description: IPv4 CIDR of the router sourcing flow data. Only /32 addresses are currently supported. example: 203.0.113.1/32 magic-visibility_mnm_config_router_ips: type: array items: $ref: '#/components/schemas/magic-visibility_mnm_config_router_ip' magic-visibility_mnm_config_single_response: allOf: - $ref: '#/components/schemas/magic-visibility_api-response-single' - type: object properties: result: $ref: '#/components/schemas/magic-visibility_mnm_config' magic-visibility_mnm_rule: type: object nullable: true required: - name - prefixes - automatic_advertisement - duration 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' magic-visibility_mnm_rule_advertisable_response: type: object nullable: true required: - automatic_advertisement properties: automatic_advertisement: $ref: '#/components/schemas/magic-visibility_mnm_rule_automatic_advertisement' magic-visibility_mnm_rule_advertisement_single_response: allOf: - $ref: '#/components/schemas/magic-visibility_api-response-single' - type: object properties: result: $ref: '#/components/schemas/magic-visibility_mnm_rule_advertisable_response' magic-visibility_mnm_rule_automatic_advertisement: type: boolean description: Toggle on if you would like Cloudflare to automatically advertise the IP Prefixes within the rule via Magic Transit when the rule is triggered. Only available for users of Magic Transit. example: "false" nullable: true magic-visibility_mnm_rule_bandwidth_threshold: type: number description: The number of bits per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum. example: 1000 minimum: 1 magic-visibility_mnm_rule_duration: type: string 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. default: 1m example: 300s magic-visibility_mnm_rule_ip_prefix: type: string description: The IP prefixes that are monitored for this rule. Must be a CIDR range like 203.0.113.0/24. Max 5000 different CIDR ranges. example: 203.0.113.1/32 magic-visibility_mnm_rule_ip_prefixes: type: array items: $ref: '#/components/schemas/magic-visibility_mnm_rule_ip_prefix' magic-visibility_mnm_rule_name: type: string description: The name of the rule. Must be unique. Supports characters A-Z, a-z, 0-9, underscore (_), dash (-), period (.), and tilde (~). You can’t have a space in the rule name. Max 256 characters. example: my_rule_1 magic-visibility_mnm_rule_packet_threshold: type: number description: The number of packets per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum. example: 10000 minimum: 1 magic-visibility_mnm_rules_collection_response: allOf: - $ref: '#/components/schemas/magic-visibility_api-response-collection' - properties: result: type: array nullable: true items: $ref: '#/components/schemas/magic-visibility_mnm_rule' magic-visibility_mnm_rules_single_response: allOf: - $ref: '#/components/schemas/magic-visibility_api-response-single' - type: object properties: result: $ref: '#/components/schemas/magic-visibility_mnm_rule' magic-visibility_pcaps_byte_limit: type: number description: The maximum number of bytes to capture. This field only applies to `full` packet captures. example: 500000 minimum: 1 maximum: 1e+09 magic-visibility_pcaps_collection_response: allOf: - $ref: '#/components/schemas/magic-visibility_api-response-collection' - properties: result: type: array items: anyOf: - $ref: '#/components/schemas/magic-visibility_pcaps_response_simple' - $ref: '#/components/schemas/magic-visibility_pcaps_response_full' magic-visibility_pcaps_colo_name: type: string description: The name of the data center used for the packet capture. This can be a specific colo (ord02) or a multi-colo name (ORD). This field only applies to `full` packet captures. example: ord02 magic-visibility_pcaps_destination_conf: type: string description: The full URI for the bucket. This field only applies to `full` packet captures. example: s3://pcaps-bucket?region=us-east-1 magic-visibility_pcaps_error_message: type: string description: An error message that describes why the packet capture failed. This field only applies to `full` packet captures. example: No packets matched the filter in the time limit given. Please modify the filter or try again. magic-visibility_pcaps_filter_v1: type: object description: The packet capture filter. When this field is empty, all packets are captured. properties: destination_address: type: string description: The destination IP address of the packet. example: 1.2.3.4 destination_port: type: number description: The destination port of the packet. example: 80 protocol: type: number description: The protocol number of the packet. example: 6 source_address: type: string description: The source IP address of the packet. example: 1.2.3.4 source_port: type: number description: The source port of the packet. example: 123 magic-visibility_pcaps_id: type: string description: The ID for the packet capture. example: 66802ca5668e47a2b82c2e6746e45037 minLength: 32 maxLength: 32 magic-visibility_pcaps_ownership_challenge: type: string description: The ownership challenge filename stored in the bucket. example: ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt magic-visibility_pcaps_ownership_collection: allOf: - $ref: '#/components/schemas/magic-visibility_api-response-collection' - properties: result: type: array nullable: true items: $ref: '#/components/schemas/magic-visibility_pcaps_ownership_response' magic-visibility_pcaps_ownership_request: type: object required: - destination_conf properties: destination_conf: $ref: '#/components/schemas/magic-visibility_pcaps_destination_conf' magic-visibility_pcaps_ownership_response: type: object required: - id - status - submitted - destination_conf - filename properties: destination_conf: $ref: '#/components/schemas/magic-visibility_pcaps_destination_conf' filename: $ref: '#/components/schemas/magic-visibility_pcaps_ownership_challenge' id: type: string description: The bucket ID associated with the packet captures API. example: 9883874ecac311ec8475433579a6bf5f minLength: 32 maxLength: 32 status: type: string description: The status of the ownership challenge. Can be pending, success or failed. enum: - pending - success - failed example: success submitted: type: string description: The RFC 3339 timestamp when the bucket was added to packet captures API. example: "2020-01-01T08:00:00Z" validated: type: string description: The RFC 3339 timestamp when the bucket was validated. example: "2020-01-01T08:00:00Z" 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: type: object required: - destination_conf - ownership_challenge properties: destination_conf: $ref: '#/components/schemas/magic-visibility_pcaps_destination_conf' ownership_challenge: $ref: '#/components/schemas/magic-visibility_pcaps_ownership_challenge' magic-visibility_pcaps_packet_limit: type: number description: The limit of packets contained in a packet capture. example: 10000 minimum: 1 maximum: 10000 magic-visibility_pcaps_request_full: type: object required: - time_limit - type - system - colo_name - destination_conf 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' 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: type: object required: - time_limit - packet_limit - type - system 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' magic-visibility_pcaps_response_full: type: object 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' magic-visibility_pcaps_response_simple: type: object 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' 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: type: string description: The status of the packet capture request. enum: - unknown - success - pending - running - conversion_pending - conversion_running - complete - failed example: success magic-visibility_pcaps_submitted: type: string description: The RFC 3339 timestamp when the packet capture was created. example: "2020-01-01T08:00:00Z" magic-visibility_pcaps_system: type: string description: The system used to collect packet captures. enum: - magic-transit example: magic-transit magic-visibility_pcaps_time_limit: type: number description: The packet capture duration in seconds. example: 300 minimum: 1 maximum: 300 magic-visibility_pcaps_type: type: string description: The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets. enum: - simple - full example: simple magic-visibility_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 magic-visibility_rule_identifier: type: string description: The id of the rule. Must be unique. example: 2890e6fa406311ed9b5a23f70f6fb8cf magic_acl: type: object description: Bidirectional ACL policy for network traffic within a site. properties: description: type: string description: Description for the ACL. example: Allows local traffic between PIN pads and cash register. 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: type: string description: The name of the ACL. example: PIN Pad - Cash Register protocols: type: array items: type: string description: Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed. enum: - tcp - udp - icmp 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: properties: deleted: type: boolean example: true deleted_acl: $ref: '#/components/schemas/magic_acl' magic_acl_modified_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: acl: $ref: '#/components/schemas/magic_acl' magic_acl_single_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: acl: $ref: '#/components/schemas/magic_acl' magic_acl_update_request: type: object properties: acl: type: object properties: description: type: string description: Description for the ACL. example: Allows local traffic between PIN pads and cash register. 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: type: string description: The name of the ACL. example: PIN Pad - Cash Register protocols: type: array items: type: string description: Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed. enum: - tcp - udp - icmp magic_acls_add_single_request: type: object description: Bidirectional ACL policy for local network traffic within a site. properties: acl: type: object required: - name - lan_1 - lan_2 properties: description: type: string description: Description for the ACL. example: Allows local traffic between PIN pads and cash register. 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: type: string description: The name of the ACL. example: PIN Pad - Cash Register protocols: type: array items: type: string description: Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed. enum: - tcp - udp - icmp magic_acls_collection_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: acls: type: array items: $ref: '#/components/schemas/magic_acl' magic_allow_null_cipher: type: boolean description: When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2). example: true magic_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/magic_messages' messages: $ref: '#/components/schemas/magic_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true magic_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false magic_api-response-single: allOf: - $ref: '#/components/schemas/magic_api-response-common' - properties: result: anyOf: - type: object nullable: true - type: string nullable: true type: object magic_cidr: type: string description: A valid CIDR notation representing an IP range. example: 192.0.2.0/24 magic_cloudflare_gre_endpoint: type: string description: The IP address assigned to the Cloudflare side of the GRE tunnel. example: 203.0.113.1 magic_cloudflare_ipsec_endpoint: type: string description: The IP address assigned to the Cloudflare side of the IPsec tunnel. example: 203.0.113.1 magic_colo_name: type: string description: Scope colo name. example: den01 magic_colo_names: type: array description: List of colo names for the ECMP scope. items: $ref: '#/components/schemas/magic_colo_name' magic_colo_region: type: string description: Scope colo region. example: APAC magic_colo_regions: type: array description: List of colo regions for the ECMP scope. items: $ref: '#/components/schemas/magic_colo_region' magic_components-schemas-description: type: string description: An optional description forthe IPsec tunnel. example: Tunnel for ISP X magic_components-schemas-modified_tunnels_collection_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: modified: type: boolean example: true modified_interconnects: type: array items: $ref: '#/components/schemas/magic_interconnect' magic_components-schemas-name: type: string description: The name of the interconnect. The name cannot share a name with other tunnels. example: pni_ord magic_components-schemas-tunnel_modified_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: modified: type: boolean example: true modified_interconnect: type: object magic_components-schemas-tunnel_single_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: interconnect: type: object magic_components-schemas-tunnel_update_request: type: object 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' magic_components-schemas-tunnels_collection_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: interconnects: type: array items: $ref: '#/components/schemas/magic_interconnect' magic_connector-id: type: string description: Magic WAN Connector identifier tag. example: ac60d3d0435248289d446cedd870bcf4 magic_created_on: type: string format: date-time description: When the route was created. example: "2017-06-14T00:00:00Z" readOnly: true magic_customer_gre_endpoint: type: string description: The IP address assigned to the customer side of the GRE tunnel. example: 203.0.113.1 magic_customer_ipsec_endpoint: type: string 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 magic_description: type: string description: An optional human provided description of the static route. example: New route for new prefix 203.0.113.1 magic_forward_locally: type: boolean 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 WAN Connector. If not included in request, will default to false. magic_gre: type: object description: The configuration specific to GRE interconnects. properties: cloudflare_endpoint: type: string description: The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect. example: 203.0.113.1 magic_gre-tunnel: type: object required: - name - customer_gre_endpoint - cloudflare_gre_endpoint - interface_address 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' magic_health_check: type: object properties: direction: type: string 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 default: unidirectional example: bidirectional enabled: type: boolean description: Determines whether to run healthchecks for a tunnel. default: true example: true rate: type: string description: How frequent the health check is run. The default value is `mid`. enum: - low - mid - high default: mid example: low target: type: string 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: type: string description: The type of healthcheck to run, reply or request. The default value is `reply`. enum: - reply - request default: reply example: request magic_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 magic_interconnect: type: object 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' magic_interconnect_components-schemas-description: type: string description: An optional description of the interconnect. example: Tunnel for Interconnect to ORD magic_interface_address: type: string description: 'A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.' example: 192.0.2.0/31 magic_ip-address: type: string description: A valid IPv4 address. example: 192.0.2.1 magic_ipsec-tunnel: type: object required: - name - cloudflare_endpoint - interface_address 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' magic_lan: type: object properties: description: type: string ha_link: type: boolean 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. id: $ref: '#/components/schemas/magic_identifier' nat: $ref: '#/components/schemas/magic_nat' physport: $ref: '#/components/schemas/magic_port' routed_subnets: type: array items: $ref: '#/components/schemas/magic_routed_subnet' site_id: $ref: '#/components/schemas/magic_identifier' static_addressing: $ref: '#/components/schemas/magic_lan_static_addressing' vlan_tag: $ref: '#/components/schemas/magic_vlan_tag' magic_lan-acl-configuration: type: object required: - lan_id properties: lan_id: type: string description: The identifier for the LAN you want to create an ACL policy with. lan_name: type: string description: The name of the LAN based on the provided lan_id. ports: type: array 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' subnets: type: array 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' magic_lan_deleted_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: deleted: type: boolean example: true deleted_lan: $ref: '#/components/schemas/magic_lan' magic_lan_dhcp_relay: type: object properties: server_addresses: type: array description: List of DHCP server IPs. items: $ref: '#/components/schemas/magic_ip-address' magic_lan_dhcp_server: type: object 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: type: object 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 magic_lan_modified_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: lan: $ref: '#/components/schemas/magic_lan' magic_lan_single_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: lan: $ref: '#/components/schemas/magic_lan' magic_lan_static_addressing: type: object 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. required: - 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' magic_lan_update_request: type: object properties: lan: type: object properties: description: type: string nat: $ref: '#/components/schemas/magic_nat' physport: $ref: '#/components/schemas/magic_port' routed_subnets: type: array items: $ref: '#/components/schemas/magic_routed_subnet' static_addressing: $ref: '#/components/schemas/magic_lan_static_addressing' vlan_tag: $ref: '#/components/schemas/magic_vlan_tag' magic_lans_add_single_request: type: object properties: lan: type: object required: - physport - vlan_tag properties: description: type: string ha_link: type: boolean 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. nat: $ref: '#/components/schemas/magic_nat' physport: $ref: '#/components/schemas/magic_port' routed_subnets: type: array items: $ref: '#/components/schemas/magic_routed_subnet' static_addressing: $ref: '#/components/schemas/magic_lan_static_addressing' vlan_tag: $ref: '#/components/schemas/magic_vlan_tag' magic_lans_collection_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: lans: type: array items: $ref: '#/components/schemas/magic_lan' magic_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string magic_modified_on: type: string format: date-time description: When the route was last modified. example: "2017-06-14T05:20:00Z" readOnly: true magic_modified_tunnels_collection_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: modified: type: boolean example: true modified_gre_tunnels: type: array items: $ref: '#/components/schemas/magic_gre-tunnel' magic_mtu: type: integer description: Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576. default: 1476 magic_multiple_route_delete_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: deleted: type: boolean example: true deleted_routes: type: object magic_multiple_route_modified_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: modified: type: boolean example: true modified_routes: type: array items: $ref: '#/components/schemas/magic_route' magic_name: type: string description: The name of the tunnel. The name cannot contain spaces or special characters, must be 15 characters or less, and cannot share a name with another GRE tunnel. example: GRE_1 magic_nat: type: object properties: static_prefix: $ref: '#/components/schemas/magic_cidr' magic_nexthop: type: string description: The next-hop IP Address for the static route. example: 203.0.113.1 magic_port: type: integer example: 1 magic_prefix: type: string description: IP Prefix in Classless Inter-Domain Routing format. example: 192.0.2.0/24 magic_priority: type: integer description: Priority of the static route. magic_psk: type: string description: A randomly generated or provided string for use in the IPsec tunnel. example: O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy 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: type: object description: The PSK metadata that includes when the PSK was generated. properties: last_generated_on: $ref: '#/components/schemas/magic_schemas-modified_on' magic_replay_protection: type: boolean description: If `true`, then IPsec replay protection will be supported in the Cloudflare-to-customer direction. default: false example: false magic_route: type: object required: - prefix - nexthop - priority 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' magic_route_add_single_request: type: object required: - prefix - nexthop - priority 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' magic_route_delete_id: allOf: - required: - id properties: id: $ref: '#/components/schemas/magic_identifier' magic_route_delete_many_request: type: object required: - routes properties: routes: type: array items: $ref: '#/components/schemas/magic_route_delete_id' magic_route_deleted_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: deleted: type: boolean example: true deleted_route: type: object magic_route_modified_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: modified: type: boolean example: true modified_route: type: object magic_route_single_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: route: type: object magic_route_update_many_request: type: object required: - routes properties: routes: type: array items: $ref: '#/components/schemas/magic_route_update_single_request' magic_route_update_request: allOf: - $ref: '#/components/schemas/magic_route_add_single_request' magic_route_update_single_request: allOf: - required: - id properties: id: $ref: '#/components/schemas/magic_identifier' - $ref: '#/components/schemas/magic_route_add_single_request' magic_routed_subnet: type: object required: - prefix - next_hop properties: nat: $ref: '#/components/schemas/magic_nat' next_hop: $ref: '#/components/schemas/magic_ip-address' prefix: $ref: '#/components/schemas/magic_cidr' magic_routes_collection_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: routes: type: array items: $ref: '#/components/schemas/magic_route' magic_schemas-created_on: type: string format: date-time description: The date and time the tunnel was created. example: "2017-06-14T00:00:00Z" readOnly: true magic_schemas-description: type: string description: An optional description of the GRE tunnel. example: Tunnel for ISP X magic_schemas-health_check: type: object properties: enabled: type: boolean description: Determines whether to run healthchecks for a tunnel. default: true example: true rate: type: string description: How frequent the health check is run. The default value is `mid`. enum: - low - mid - high default: mid example: low target: type: string 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: type: string description: The type of healthcheck to run, reply or request. The default value is `reply`. enum: - reply - request default: reply example: request magic_schemas-identifier: type: string description: Tunnel identifier tag. example: c4a7362d577a6c3019a474fd6f485821 readOnly: true maxLength: 32 magic_schemas-modified_on: type: string format: date-time description: The date and time the tunnel was last modified. example: "2017-06-14T05:20:00Z" readOnly: true magic_schemas-modified_tunnels_collection_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: modified: type: boolean example: true modified_ipsec_tunnels: type: array items: $ref: '#/components/schemas/magic_ipsec-tunnel' magic_schemas-mtu: type: integer description: The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576. default: 1476 magic_schemas-name: type: string description: The name of the IPsec tunnel. The name cannot share a name with other tunnels. example: IPsec_1 magic_schemas-tunnel_add_request: allOf: - $ref: '#/components/schemas/magic_schemas-tunnel_add_single_request' magic_schemas-tunnel_add_single_request: type: object required: - name - cloudflare_endpoint - interface_address 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' magic_schemas-tunnel_deleted_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: deleted: type: boolean example: true deleted_ipsec_tunnel: type: object magic_schemas-tunnel_modified_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: modified: type: boolean example: true modified_ipsec_tunnel: type: object magic_schemas-tunnel_single_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: 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: type: array items: $ref: '#/components/schemas/magic_ipsec-tunnel' magic_scope: type: object description: Used only for ECMP routes. properties: colo_names: $ref: '#/components/schemas/magic_colo_names' colo_regions: $ref: '#/components/schemas/magic_colo_regions' magic_secondary-connector-id: type: string description: Magic WAN Connector identifier tag. Used when high availability mode is on. example: 8d67040d3835dbcf46ce29da440dc482 magic_site: type: object properties: connector_id: $ref: '#/components/schemas/magic_connector-id' description: type: string ha_mode: type: boolean description: Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode. example: true 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' magic_site-location: type: object description: Location of site in latitude and longitude. properties: lat: type: string description: Latitude example: 37.6192 lon: type: string description: Longitude example: 122.3816 magic_site-name: type: string description: The name of the site. example: site_1 magic_site_deleted_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: deleted: type: boolean example: true deleted_site: $ref: '#/components/schemas/magic_site' magic_site_modified_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: site: $ref: '#/components/schemas/magic_site' magic_site_single_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: site: $ref: '#/components/schemas/magic_site' magic_site_update_request: type: object properties: site: type: object 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' magic_sites_add_single_request: type: object properties: site: type: object required: - name properties: connector_id: $ref: '#/components/schemas/magic_connector-id' description: type: string ha_mode: type: boolean description: Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode. example: true location: $ref: '#/components/schemas/magic_site-location' name: $ref: '#/components/schemas/magic_site-name' secondary_connector_id: $ref: '#/components/schemas/magic_secondary-connector-id' magic_sites_collection_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: sites: type: array items: $ref: '#/components/schemas/magic_site' magic_ttl: type: integer description: Time To Live (TTL) in number of hops of the GRE tunnel. default: 64 magic_tunnel_add_single_request: type: object required: - name - customer_gre_endpoint - cloudflare_gre_endpoint - interface_address 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' magic_tunnel_deleted_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: deleted: type: boolean example: true deleted_gre_tunnel: type: object magic_tunnel_health_check: type: object properties: enabled: type: boolean description: Determines whether to run healthchecks for a tunnel. default: true example: true rate: type: string description: How frequent the health check is run. The default value is `mid`. enum: - low - mid - high default: mid example: low target: type: string 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: type: string description: The type of healthcheck to run, reply or request. The default value is `reply`. enum: - reply - request default: reply example: request magic_tunnel_modified_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: modified: type: boolean example: true modified_gre_tunnel: type: object magic_tunnel_single_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: 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: type: array items: $ref: '#/components/schemas/magic_gre-tunnel' magic_vlan_tag: type: integer description: VLAN port number. example: 0 magic_wan: type: object properties: description: type: string id: $ref: '#/components/schemas/magic_identifier' physport: $ref: '#/components/schemas/magic_port' priority: type: integer description: Priority of WAN for traffic loadbalancing. site_id: $ref: '#/components/schemas/magic_identifier' static_addressing: $ref: '#/components/schemas/magic_wan_static_addressing' vlan_tag: $ref: '#/components/schemas/magic_vlan_tag' magic_wan_deleted_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: deleted: type: boolean example: true deleted_wan: $ref: '#/components/schemas/magic_wan' magic_wan_modified_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: wan: $ref: '#/components/schemas/magic_wan' magic_wan_single_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: wan: $ref: '#/components/schemas/magic_wan' magic_wan_static_addressing: type: object description: (optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode. required: - address - gateway_address properties: address: $ref: '#/components/schemas/magic_cidr' gateway_address: $ref: '#/components/schemas/magic_ip-address' secondary_address: $ref: '#/components/schemas/magic_cidr' magic_wan_update_request: type: object properties: wan: type: object properties: description: 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' magic_wans_add_single_request: type: object properties: wan: type: object required: - physport - vlan_tag properties: description: 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' magic_wans_collection_response: allOf: - $ref: '#/components/schemas/magic_api-response-single' - properties: result: properties: wans: type: array items: $ref: '#/components/schemas/magic_wan' magic_weight: type: integer description: Optional weight of the ECMP scope - if provided. mq_api-response-collection: allOf: - $ref: '#/components/schemas/mq_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/mq_result_info' type: object mq_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/mq_messages' messages: $ref: '#/components/schemas/mq_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true mq_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false mq_batch_size: type: number description: The maximum number of messages to include in a batch example: 10 mq_bucket-config: type: object 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 mq_config-detail: type: object mq_consumer: type: object properties: created_on: readOnly: true environment: readOnly: true queue_name: readOnly: true service: readOnly: true settings: type: object properties: batch_size: $ref: '#/components/schemas/mq_batch_size' max_retries: $ref: '#/components/schemas/mq_max_retries' max_wait_time_ms: $ref: '#/components/schemas/mq_max_wait_time_ms' mq_consumer_created: type: object properties: created_on: readOnly: true dead_letter_queue: $ref: '#/components/schemas/mq_dlq_name' environment: readOnly: true queue_name: readOnly: true script_name: readOnly: true settings: type: object 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' mq_consumer_updated: type: object properties: created_on: readOnly: true dead_letter_queue: example: updated-example-dlq environment: readOnly: true queue_name: readOnly: true script_name: readOnly: true settings: type: object properties: batch_size: type: number example: 100 max_retries: $ref: '#/components/schemas/mq_max_retries' max_wait_time_ms: $ref: '#/components/schemas/mq_max_wait_time_ms' mq_detail: type: object required: - queue - rules properties: queue: type: string description: Queue ID that will receive notifications based on the configured rules example: 98fa6c35-dead-beef-a42b-8d12196e0000 rules: type: array description: Array of rules to drive notifications items: $ref: '#/components/schemas/mq_rule' mq_dlq_name: type: string example: example-dlq mq_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 mq_lease_id: type: string example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0 readOnly: true mq_max_retries: type: number example: 3 mq_max_wait_time_ms: type: number example: 5000 mq_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string mq_name: type: string example: example-queue mq_queue: type: object properties: consumers: readOnly: true consumers_total_count: readOnly: true created_on: readOnly: true modified_on: readOnly: true producers: readOnly: true producers_total_count: readOnly: true queue_id: type: string readOnly: true queue_name: $ref: '#/components/schemas/mq_name' mq_queue_created: type: object properties: created_on: readOnly: true modified_on: readOnly: true queue_id: readOnly: true queue_name: $ref: '#/components/schemas/mq_name' mq_queue_message: type: object properties: attempts: type: number example: 1 readOnly: true body: type: string example: hello world readOnly: true id: type: string example: b01b5594f784d0165c2985833f5660dd readOnly: true lease_id: $ref: '#/components/schemas/mq_lease_id' metadata: type: object example: CF-Content-Type: text readOnly: true timestamp_ms: type: number example: 1.710950954154e+12 readOnly: true mq_queue_updated: type: object properties: created_on: readOnly: true modified_on: readOnly: true queue_id: readOnly: true queue_name: $ref: '#/components/schemas/mq_renamed_name' mq_r2-action: type: string enum: - PutObject - CopyObject - DeleteObject - CompleteMultipartUpload - AbortMultipartUpload mq_renamed_name: type: string example: renamed-example-queue mq_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 mq_rule: type: object required: - actions properties: actions: type: array description: Array of R2 object actions that will trigger notifications example: - PutObject - CopyObject uniqueItems: true items: $ref: '#/components/schemas/mq_r2-action' prefix: type: string description: Notifications will be sent only for objects with this prefix example: img/ suffix: type: string description: Notifications will be sent only for objects with this suffix example: .jpeg mq_script-response-collection: allOf: - $ref: '#/components/schemas/mq_api-response-common' - properties: result: type: array items: properties: created_on: readOnly: true etag: readOnly: true id: readOnly: true modified_on: readOnly: true usage_model: readOnly: true mq_visibility_timeout_ms: type: number description: The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt. example: 1000 observatory_api-response-collection: allOf: - $ref: '#/components/schemas/observatory_api-response-common' type: object observatory_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/observatory_messages' messages: $ref: '#/components/schemas/observatory_messages' success: type: boolean description: Whether the API call was successful. example: true observatory_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/observatory_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/observatory_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false observatory_api-response-single: allOf: - $ref: '#/components/schemas/observatory_api-response-common' type: object observatory_availabilities: type: object properties: quota: type: object properties: plan: type: string description: Cloudflare plan. example: free quotasPerPlan: type: object description: The number of tests available per plan. remainingSchedules: type: number description: The number of remaining schedules available. example: 1 remainingTests: type: number description: The number of remaining tests available. example: 30 scheduleQuotasPerPlan: type: object description: The number of schedules available per plan. regions: type: array items: $ref: '#/components/schemas/observatory_labeled_region' regionsPerPlan: {} 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: type: object properties: count: type: number description: Number of items affected. example: 1 observatory_create-schedule-response: allOf: - $ref: '#/components/schemas/observatory_api-response-single' - properties: result: type: object properties: schedule: $ref: '#/components/schemas/observatory_schedule' test: $ref: '#/components/schemas/observatory_page_test' observatory_device_type: type: string description: The type of device. enum: - DESKTOP - MOBILE example: DESKTOP observatory_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 observatory_labeled_region: type: object description: A test region with a label. properties: label: type: string example: Iowa, USA value: $ref: '#/components/schemas/observatory_region' observatory_lighthouse_error_code: type: string description: The error code of the Lighthouse result. enum: - NOT_REACHABLE - DNS_FAILURE - NOT_HTML - LIGHTHOUSE_TIMEOUT - UNKNOWN example: NOT_REACHABLE observatory_lighthouse_report: type: object description: The Lighthouse report. properties: cls: type: number description: Cumulative Layout Shift. example: 100 deviceType: $ref: '#/components/schemas/observatory_device_type' error: type: object properties: code: $ref: '#/components/schemas/observatory_lighthouse_error_code' detail: type: string description: Detailed error message. example: 'Details: net::ERR_CONNECTION_CLOSED' finalDisplayedUrl: type: string description: The final URL displayed to the user. example: example.com fcp: type: number description: First Contentful Paint. example: 100 jsonReportUrl: type: string description: The URL to the full Lighthouse JSON report. lcp: type: number description: Largest Contentful Paint. example: 100 performanceScore: type: number description: The Lighthouse performance score. example: 90 si: type: number description: Speed Index. example: 100 state: $ref: '#/components/schemas/observatory_lighthouse_state' tbt: type: number description: Total Blocking Time. example: 100 ttfb: type: number description: Time To First Byte. example: 100 tti: type: number description: Time To Interactive. example: 100 observatory_lighthouse_state: type: string description: The state of the Lighthouse report. enum: - RUNNING - COMPLETE - FAILED example: COMPLETE observatory_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string observatory_page-test-response-collection: allOf: - $ref: '#/components/schemas/observatory_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/observatory_page_test' - properties: result_info: $ref: '#/components/schemas/observatory_result_info' observatory_page-test-response-single: allOf: - $ref: '#/components/schemas/observatory_api-response-single' - properties: result: $ref: '#/components/schemas/observatory_page_test' observatory_page_test: type: object properties: date: $ref: '#/components/schemas/observatory_timestamp' desktopReport: $ref: '#/components/schemas/observatory_lighthouse_report' id: $ref: '#/components/schemas/observatory_uuid' mobileReport: $ref: '#/components/schemas/observatory_lighthouse_report' region: $ref: '#/components/schemas/observatory_labeled_region' scheduleFrequency: $ref: '#/components/schemas/observatory_schedule_frequency' url: $ref: '#/components/schemas/observatory_url' observatory_pages-response-collection: allOf: - $ref: '#/components/schemas/observatory_api-response-collection' - properties: result: type: array items: properties: region: $ref: '#/components/schemas/observatory_labeled_region' scheduleFrequency: $ref: '#/components/schemas/observatory_schedule_frequency' tests: type: array items: $ref: '#/components/schemas/observatory_page_test' url: $ref: '#/components/schemas/observatory_url' observatory_region: type: string description: A test region. enum: - asia-east1 - asia-northeast1 - asia-northeast2 - asia-south1 - asia-southeast1 - australia-southeast1 - europe-north1 - europe-southwest1 - europe-west1 - europe-west2 - europe-west3 - europe-west4 - europe-west8 - europe-west9 - me-west1 - southamerica-east1 - us-central1 - us-east1 - us-east4 - us-south1 - us-west1 example: us-central1 observatory_result_info: type: object properties: count: type: integer example: 5 page: type: integer example: 1 per_page: type: integer example: 5 total_count: type: integer example: 3 observatory_schedule: type: object description: The test schedule. properties: frequency: $ref: '#/components/schemas/observatory_schedule_frequency' region: $ref: '#/components/schemas/observatory_region' url: $ref: '#/components/schemas/observatory_url' observatory_schedule-response-single: allOf: - $ref: '#/components/schemas/observatory_api-response-single' - properties: result: $ref: '#/components/schemas/observatory_schedule' observatory_schedule_frequency: type: string description: The frequency of the test. enum: - DAILY - WEEKLY example: DAILY observatory_timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true observatory_trend: type: object properties: cls: type: array description: Cumulative Layout Shift trend. items: type: number nullable: true fcp: type: array description: First Contentful Paint trend. items: type: number nullable: true lcp: type: array description: Largest Contentful Paint trend. items: type: number nullable: true performanceScore: type: array description: The Lighthouse score trend. items: type: number nullable: true si: type: array description: Speed Index trend. items: type: number nullable: true tbt: type: array description: Total Blocking Time trend. items: type: number nullable: true ttfb: type: array description: Time To First Byte trend. items: type: number nullable: true tti: type: array description: Time To Interactive trend. items: type: number nullable: true observatory_trend-response: allOf: - $ref: '#/components/schemas/observatory_api-response-single' - properties: result: $ref: '#/components/schemas/observatory_trend' observatory_url: type: string description: A URL. example: example.com observatory_uuid: type: string description: UUID example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 readOnly: true maxLength: 36 page-shield_api-response-collection: allOf: - $ref: '#/components/schemas/page-shield_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/page-shield_result_info' type: object page-shield_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/page-shield_messages' messages: $ref: '#/components/schemas/page-shield_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true page-shield_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/page-shield_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/page-shield_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false page-shield_api-response-single: allOf: - $ref: '#/components/schemas/page-shield_api-response-common' - properties: result: anyOf: - type: object - type: array items: {} - type: string type: object page-shield_connection: properties: added_at: example: "2021-08-18T10:51:10.09615Z" domain_reported_malicious: example: false first_page_url: example: blog.cloudflare.com/page first_seen_at: example: "2021-08-18T10:51:08Z" host: example: blog.cloudflare.com id: example: c9ef84a6bf5e47138c75d95e2f933e8f last_seen_at: example: "2021-09-02T09:57:54Z" page_urls: example: - blog.cloudflare.com/page1 - blog.cloudflare.com/page2 url: example: https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js url_contains_cdn_cgi_path: example: false page-shield_dataflow_score: type: integer description: The dataflow score of the JavaScript content. nullable: true minimum: 1 maximum: 99 page-shield_enabled: type: boolean description: When true, indicates that Page Shield is enabled. example: true page-shield_fetched_at: type: string description: The timestamp of when the script was last fetched. nullable: true page-shield_get-zone-connection-response: allOf: - $ref: '#/components/schemas/page-shield_connection' page-shield_get-zone-policy-response: allOf: - $ref: '#/components/schemas/page-shield_pageshield-policy' page-shield_get-zone-script-response: allOf: - $ref: '#/components/schemas/page-shield_script' - properties: versions: type: array example: - dataflow_score: 2 fetched_at: "2021-08-18T10:51:08Z" hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b423 js_integrity_score: 2 obfuscation_score: 10 nullable: true items: $ref: '#/components/schemas/page-shield_version' 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' page-shield_hash: type: string description: The computed hash of the analyzed script. nullable: true minLength: 64 maxLength: 64 page-shield_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 page-shield_js_integrity_score: type: integer description: The integrity score of the JavaScript content. nullable: true minimum: 1 maximum: 99 page-shield_list-zone-connections-response: allOf: - $ref: '#/components/schemas/page-shield_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/page-shield_connection' result_info: $ref: '#/components/schemas/page-shield_result_info' page-shield_list-zone-policies-response: allOf: - $ref: '#/components/schemas/page-shield_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/page-shield_pageshield-policy' page-shield_list-zone-scripts-response: allOf: - $ref: '#/components/schemas/page-shield_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/page-shield_script' result_info: $ref: '#/components/schemas/page-shield_result_info' page-shield_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string page-shield_obfuscation_score: type: integer description: The obfuscation score of the JavaScript content. nullable: true minimum: 1 maximum: 99 page-shield_pageshield-policy: properties: action: $ref: '#/components/schemas/page-shield_pageshield-policy-action' description: $ref: '#/components/schemas/page-shield_pageshield-policy-description' enabled: $ref: '#/components/schemas/page-shield_pageshield-policy-enabled' expression: $ref: '#/components/schemas/page-shield_pageshield-policy-expression' id: $ref: '#/components/schemas/page-shield_pageshield-policy-id' value: $ref: '#/components/schemas/page-shield_pageshield-policy-value' page-shield_pageshield-policy-action: type: string description: The action to take if the expression matches enum: - allow - log example: allow page-shield_pageshield-policy-description: type: string description: A description for the policy example: Checkout page CSP policy page-shield_pageshield-policy-enabled: type: boolean description: Whether the policy is enabled example: true page-shield_pageshield-policy-expression: type: string description: The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax example: ends_with(http.request.uri.path, "/checkout") page-shield_pageshield-policy-id: type: string description: The ID of the policy example: c9ef84a6bf5e47138c75d95e2f933e8f page-shield_pageshield-policy-value: type: string description: The policy which will be applied example: script-src 'none'; page-shield_policy_id: type: string description: The ID of the policy. example: c9ef84a6bf5e47138c75d95e2f933e8f minLength: 32 maxLength: 32 page-shield_resource_id: type: string description: The ID of the resource. example: c9ef84a6bf5e47138c75d95e2f933e8f minLength: 32 maxLength: 32 page-shield_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 page-shield_script: properties: added_at: example: "2021-08-18T10:51:10.09615Z" dataflow_score: example: 10 domain_reported_malicious: example: false fetched_at: example: "2021-09-02T10:17:54Z" first_page_url: example: blog.cloudflare.com/page first_seen_at: example: "2021-08-18T10:51:08Z" hash: example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 host: example: blog.cloudflare.com id: example: c9ef84a6bf5e47138c75d95e2f933e8f js_integrity_score: example: 10 last_seen_at: example: "2021-09-02T09:57:54Z" obfuscation_score: example: 20 page_urls: example: - blog.cloudflare.com/page1 - blog.cloudflare.com/page2 url: example: https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js url_contains_cdn_cgi_path: example: false 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' page-shield_updated_at: type: string description: The timestamp of when Page Shield was last updated. example: "2022-10-12T17:56:52.083582+01:00" page-shield_use_cloudflare_reporting_endpoint: type: boolean description: When true, CSP reports will be sent to https://csp-reporting.cloudflare.com/cdn-cgi/script_monitor/report example: true page-shield_use_connection_url_path: type: boolean description: When true, the paths associated with connections URLs will also be analyzed. example: true page-shield_version: type: object description: The version of the analyzed script. properties: 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' obfuscation_score: $ref: '#/components/schemas/page-shield_obfuscation_score' page-shield_zone_settings_response_single: allOf: - $ref: '#/components/schemas/page-shield_api-response-single' - properties: result: type: object pages_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/pages_messages' messages: $ref: '#/components/schemas/pages_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true pages_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object nullable: true success: type: boolean description: Whether the API call was successful. enum: - false example: false pages_api-response-single: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result: type: object nullable: true type: object pages_build_config: type: object description: Configs for the project build process. properties: build_caching: type: boolean description: Enable build caching for the project. example: true nullable: true build_command: type: string description: Command used to build project. example: npm run build nullable: true destination_dir: type: string description: Output directory of the build. example: build nullable: true root_dir: type: string description: Directory to run the command. example: / nullable: true web_analytics_tag: type: string description: The classifying tag for analytics. example: cee1c73f6e4743d0b5e6bb1a0bcaabcc nullable: true web_analytics_token: type: string description: The auth token for analytics. example: 021e1057c18547eca7b79f2516f06o7x nullable: true pages_deployment-list-response: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result_info: type: object properties: count: example: 1 page: example: 1 per_page: example: 100 total_count: example: 1 - properties: result: type: array items: $ref: '#/components/schemas/pages_deployments' 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: type: object example: data: - line: Cloning repository... ts: "2021-04-20T19:35:29.0749819Z" - line: From https://github.com/cloudflare/example ts: "2021-04-20T19:35:30.0749819Z" - line: ' * branch 209c5bb11d89533f426b2f8469bcae12fdccf71b -> FETCH_HEAD' ts: "2021-04-20T19:35:30.0749819Z" - line: "" ts: "2021-04-20T19:35:30.0749819Z" - line: HEAD is now at 209c5bb Update index.html ts: "2021-04-20T19:35:30.0749819Z" - line: "" ts: "2021-04-20T19:35:30.0749819Z" - line: "" ts: "2021-04-20T19:35:30.0749819Z" - line: 'Success: Finished cloning repository files' ts: "2021-04-20T19:35:30.0749819Z" - line: Installing dependencies ts: "2021-04-20T19:35:59.0749819Z" - line: Python version set to 2.7 ts: "2021-04-20T19:35:59.0931208Z" - line: v12.18.0 is already installed. ts: "2021-04-20T19:36:02.2369501Z" - line: Now using node v12.18.0 (npm v6.14.4) ts: "2021-04-20T19:36:02.6028886Z" - line: Started restoring cached build plugins ts: "2021-04-20T19:36:02.624555Z" - line: Finished restoring cached build plugins ts: "2021-04-20T19:36:02.6340688Z" - line: Attempting ruby version 2.7.1, read from environment ts: "2021-04-20T19:36:02.963095Z" - line: Using ruby version 2.7.1 ts: "2021-04-20T19:36:04.2236084Z" - line: Using PHP version 5.6 ts: "2021-04-20T19:36:04.5450152Z" - line: 5.2 is already installed. ts: "2021-04-20T19:36:04.5740509Z" - line: Using Swift version 5.2 ts: "2021-04-20T19:36:04.577035Z" - line: Installing Hugo 0.54.0 ts: "2021-04-20T19:36:04.5771615Z" - line: 'Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z' ts: "2021-04-20T19:36:05.4786868Z" - line: Started restoring cached go cache ts: "2021-04-20T19:36:05.4794366Z" - line: Finished restoring cached go cache ts: "2021-04-20T19:36:05.481977Z" - line: go version go1.14.4 linux/amd64 ts: "2021-04-20T19:36:05.9049776Z" - line: go version go1.14.4 linux/amd64 ts: "2021-04-20T19:36:05.9086053Z" - line: Installing missing commands ts: "2021-04-20T19:36:05.9163568Z" - line: Verify run directory ts: "2021-04-20T19:36:05.9163934Z" - line: 'Executing user command: echo "skipping build step: no build command specified"' ts: "2021-04-20T19:36:05.9164636Z" - line: 'skipping build step: no build command specified' ts: "2021-04-20T19:36:05.9165087Z" - line: Finished ts: "2021-04-20T19:36:05.917412Z" includes_container_logs: true total: 30 pages_deployment-response-stage-logs: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result: type: object example: data: - id: 15 message: Installing dependencies timestamp: "2021-04-20T19:35:59.0749819Z" - id: 16 message: Python version set to 2.7 timestamp: "2021-04-20T19:35:59.0931208Z" - id: 17 message: v12.18.0 is already installed. timestamp: "2021-04-20T19:36:02.2369501Z" - id: 18 message: Now using node v12.18.0 (npm v6.14.4) timestamp: "2021-04-20T19:36:02.6028886Z" - id: 19 message: Started restoring cached build plugins timestamp: "2021-04-20T19:36:02.624555Z" - id: 20 message: Finished restoring cached build plugins timestamp: "2021-04-20T19:36:02.6340688Z" - id: 21 message: Attempting ruby version 2.7.1, read from environment timestamp: "2021-04-20T19:36:02.963095Z" - id: 22 message: Using ruby version 2.7.1 timestamp: "2021-04-20T19:36:04.2236084Z" - id: 23 message: Using PHP version 5.6 timestamp: "2021-04-20T19:36:04.5450152Z" - id: 24 message: 5.2 is already installed. timestamp: "2021-04-20T19:36:04.5740509Z" - id: 25 message: Using Swift version 5.2 timestamp: "2021-04-20T19:36:04.577035Z" - id: 26 message: Installing Hugo 0.54.0 timestamp: "2021-04-20T19:36:04.5771615Z" - id: 27 message: 'Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z' timestamp: "2021-04-20T19:36:05.4786868Z" - id: 28 message: Started restoring cached go cache timestamp: "2021-04-20T19:36:05.4794366Z" - id: 29 message: Finished restoring cached go cache timestamp: "2021-04-20T19:36:05.481977Z" - id: 30 message: go version go1.14.4 linux/amd64 timestamp: "2021-04-20T19:36:05.9049776Z" - id: 31 message: go version go1.14.4 linux/amd64 timestamp: "2021-04-20T19:36:05.9086053Z" - id: 32 message: Installing missing commands timestamp: "2021-04-20T19:36:05.9163568Z" - id: 33 message: Verify run directory timestamp: "2021-04-20T19:36:05.9163934Z" - id: 34 message: 'Executing user command: echo "skipping build step: no build command specified"' timestamp: "2021-04-20T19:36:05.9164636Z" - id: 35 message: 'skipping build step: no build command specified' timestamp: "2021-04-20T19:36:05.9165087Z" - id: 36 message: Finished timestamp: "2021-04-20T19:36:05.917412Z" end: 37 ended_on: "2021-04-20T19:36:06.38889Z" name: build start: 0 started_on: "2021-04-20T19:35:58.238757Z" status: success total: 37 pages_deployment_configs: type: object description: Configs for deployments in a project. properties: preview: anyOf: - $ref: '#/components/schemas/pages_deployment_configs_values' type: object description: Configs for preview deploys. production: anyOf: - $ref: '#/components/schemas/pages_deployment_configs_values' type: object description: Configs for production deploys. pages_deployment_configs_values: type: object properties: ai_bindings: type: object description: Constellation bindings used for Pages Functions. nullable: true properties: AI_BINDING: type: object description: AI binding. example: {} properties: project_id: {} analytics_engine_datasets: type: object description: Analytics Engine bindings used for Pages Functions. nullable: true properties: ANALYTICS_ENGINE_BINDING: type: object description: Analytics Engine binding. example: dataset: api_analytics properties: dataset: type: string description: Name of the dataset. example: api_analytics browsers: type: object description: Browser bindings used for Pages Functions. nullable: true properties: BROWSER: type: object description: Browser binding. compatibility_date: type: string description: Compatibility date used for Pages Functions. example: "2022-01-01" compatibility_flags: type: array description: Compatibility flags used for Pages Functions. example: - url_standard items: {} d1_databases: type: object description: D1 databases used for Pages Functions. nullable: true properties: D1_BINDING: type: object description: D1 binding. example: id: 445e2955-951a-43f8-a35b-a4d0c8138f63 properties: id: type: string description: UUID of the D1 database. example: 445e2955-951a-43f8-a35b-a4d0c8138f63 durable_object_namespaces: type: object description: Durabble Object namespaces used for Pages Functions. nullable: true properties: DO_BINDING: type: object description: Durabble Object binding. example: namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3 properties: namespace_id: type: string description: ID of the Durabble Object namespace. example: 5eb63bbbe01eeed093cb22bb8f5acdc3 env_vars: type: object description: Environment variables for build configs. nullable: true properties: ENVIRONMENT_VARIABLE: type: object description: Environment variable. example: type: plain_text value: hello world properties: type: type: string description: The type of environment variable (plain text or secret) enum: - plain_text - secret_text value: type: string description: Environment variable value. hyperdrive_bindings: type: object description: Hyperdrive bindings used for Pages Functions. nullable: true properties: HYPERDRIVE: type: object description: Hyperdrive binding. example: id: a76a99bc342644deb02c38d66082262a properties: id: type: string example: a76a99bc342644deb02c38d66082262a kv_namespaces: type: object description: KV namespaces used for Pages Functions. properties: KV_BINDING: type: object description: KV binding. example: namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3 properties: namespace_id: type: string description: ID of the KV namespace. example: 5eb63bbbe01eeed093cb22bb8f5acdc3 mtls_certificates: type: object description: mTLS bindings used for Pages Functions. nullable: true properties: MTLS: type: object description: mTLS binding. example: certificate_id: d7cdd17c-916f-4cb7-aabe-585eb382ec4e properties: certificate_id: type: string example: d7cdd17c-916f-4cb7-aabe-585eb382ec4e placement: type: object description: Placement setting used for Pages Functions. example: mode: smart nullable: true properties: mode: type: string description: Placement mode. example: smart queue_producers: type: object description: Queue Producer bindings used for Pages Functions. nullable: true properties: QUEUE_PRODUCER_BINDING: type: object description: Queue Producer binding. example: name: some-queue properties: name: type: string description: Name of the Queue. example: some-queue r2_buckets: type: object description: R2 buckets used for Pages Functions. nullable: true properties: R2_BINDING: type: object description: R2 binding. example: name: some-bucket properties: name: type: string description: Name of the R2 bucket. example: some-bucket services: type: object description: Services used for Pages Functions. nullable: true properties: SERVICE_BINDING: type: object description: Service binding. example: entrypoint: MyHandler environment: production service: example-worker properties: entrypoint: type: string description: The entrypoint to bind to. nullable: true environment: type: string description: The Service environment. service: type: string description: The Service name. vectorize_bindings: type: object description: Vectorize bindings used for Pages Functions. nullable: true properties: VECTORIZE: type: object description: Vectorize binding. example: index_name: my_index properties: index_name: type: string example: my_index pages_deployment_stage_name: type: string description: Deployment stage name. example: deploy pattern: queued|initialize|clone_repo|build|deploy pages_deployments: type: object properties: aliases: type: array description: A list of alias URLs pointing to this deployment. example: - https://branchname.projectname.pages.dev nullable: true readOnly: true items: {} build_config: readOnly: true created_on: type: string format: date-time description: When the deployment was created. example: "2021-03-09T00:55:03.923456Z" readOnly: true deployment_trigger: type: object description: Info about what caused the deployment. readOnly: true properties: metadata: type: object description: Additional info about the trigger. properties: branch: type: string description: Where the trigger happened. example: main readOnly: true commit_hash: type: string description: Hash of the deployment trigger commit. example: ad9ccd918a81025731e10e40267e11273a263421 readOnly: true commit_message: type: string description: Message of the deployment trigger commit. example: Update index.html readOnly: true type: type: string description: What caused the deployment. example: ad_hoc readOnly: true pattern: push|ad_hoc env_vars: type: object description: A dict of env variables to build this deploy. example: BUILD_VERSION: value: "3.3" ENV: value: STAGING readOnly: true environment: type: string description: Type of deploy. example: preview readOnly: true pattern: preview|production id: type: string description: Id of the deployment. example: f64788e9-fccd-4d4a-a28a-cb84f88f6 readOnly: true is_skipped: type: boolean description: If the deployment has been skipped. example: true readOnly: true latest_stage: readOnly: true modified_on: type: string format: date-time description: When the deployment was last modified. example: 2021-03-09T00:58:59.045655 readOnly: true project_id: type: string description: Id of the project. example: 7b162ea7-7367-4d67-bcde-1160995d5 readOnly: true project_name: type: string description: Name of the project. example: ninjakittens readOnly: true short_id: type: string description: Short Id (8 character) of the deployment. example: f64788e9 readOnly: true source: readOnly: true stages: type: array description: List of past stages. example: - ended_on: "2021-06-03T15:39:03.134378Z" name: queued started_on: "2021-06-03T15:38:15.608194Z" status: active - ended_on: null name: initialize started_on: null status: idle - ended_on: null name: clone_repo started_on: null status: idle - ended_on: null name: build started_on: null status: idle - ended_on: null name: deploy started_on: null status: idle readOnly: true items: $ref: '#/components/schemas/pages_stage' url: type: string description: The live URL to view this deployment. example: https://f64788e9.ninjakittens.pages.dev readOnly: true pages_domain-response-collection: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result_info: type: object properties: count: example: 1 page: example: 1 per_page: example: 100 total_count: example: 1 - properties: result: type: array items: type: object pages_domain-response-single: allOf: - $ref: '#/components/schemas/pages_api-response-single' - properties: result: type: object pages_domain_name: type: string description: Name of the domain. example: this-is-my-domain-01.com pattern: ^[a-z0-9][a-z0-9-]*$ pages_domains-post: example: name: example.com pages_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 pages_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string pages_new-project-response: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result: type: object pages_project-patch: example: deployment_configs: production: compatibility_date: "2022-01-01" compatibility_flags: - url_standard env_vars: BUILD_VERSION: value: "3.3" delete_this_env_var: null secret_var: type: secret_text value: A_CMS_API_TOKEN pages_project-response: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result: $ref: '#/components/schemas/pages_projects' pages_project_name: type: string description: Name of the project. example: this-is-my-project-01 pattern: ^[a-z0-9][a-z0-9-]*$ pages_projects: type: object properties: build_config: $ref: '#/components/schemas/pages_build_config' canonical_deployment: $ref: '#/components/schemas/pages_deployments' created_on: type: string format: date-time description: When the project was created. example: "2017-01-01T00:00:00Z" readOnly: true deployment_configs: $ref: '#/components/schemas/pages_deployment_configs' domains: type: array description: A list of associated custom domains for the project. example: - customdomain.com - customdomain.org readOnly: true items: {} id: type: string description: Id of the project. example: 7b162ea7-7367-4d67-bcde-1160995d5 readOnly: true latest_deployment: $ref: '#/components/schemas/pages_deployments' name: type: string description: Name of the project. example: NextJS Blog production_branch: type: string description: Production branch of the project. Used to identify production deployments. example: main source: readOnly: true subdomain: type: string description: The Cloudflare subdomain associated with the project. example: helloworld.pages.dev readOnly: true pages_projects-response: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result_info: type: object properties: count: example: 1 page: example: 1 per_page: example: 100 total_count: example: 1 - properties: result: type: array items: $ref: '#/components/schemas/pages_deployments' pages_stage: type: object description: The status of the deployment. readOnly: true properties: ended_on: type: string format: date-time description: When the stage ended. example: 2021-03-09T00:58:59.045655 nullable: true readOnly: true name: type: string description: The current build stage. example: deploy pattern: queued|initialize|clone_repo|build|deploy started_on: type: string format: date-time description: When the stage started. example: "2021-03-09T00:55:03.923456Z" nullable: true readOnly: true status: type: string description: State of the current stage. example: success readOnly: true pattern: success|idle|active|failure|canceled r2_account_identifier: type: string description: Account ID example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 r2_bucket: type: object description: A single R2 bucket properties: creation_date: type: string description: Creation timestamp location: $ref: '#/components/schemas/r2_bucket_location' name: $ref: '#/components/schemas/r2_bucket_name' r2_bucket_location: type: string description: Location of the bucket enum: - apac - eeur - enam - weur - wnam r2_bucket_name: type: string description: Name of the bucket example: example-bucket minLength: 3 maxLength: 64 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9] r2_enable_sippy_aws: properties: destination: type: object description: R2 bucket to copy objects to properties: accessKeyId: type: string 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. provider: type: string enum: - r2 secretAccessKey: type: string 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. source: type: object description: AWS S3 bucket to copy objects from properties: accessKeyId: type: string description: Access Key ID of an IAM credential (ideally scoped to a single S3 bucket) bucket: type: string description: Name of the AWS S3 bucket provider: type: string enum: - aws region: type: string description: Name of the AWS availability zone secretAccessKey: type: string description: Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket) r2_enable_sippy_gcs: properties: destination: type: object description: R2 bucket to copy objects to properties: accessKeyId: type: string 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. provider: type: string enum: - r2 secretAccessKey: type: string 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. source: type: object description: GCS bucket to copy objects from properties: bucket: type: string description: Name of the GCS bucket clientEmail: type: string description: Client email of an IAM credential (ideally scoped to a single GCS bucket) privateKey: type: string description: Private Key of an IAM credential (ideally scoped to a single GCS bucket) provider: type: string enum: - gcs r2_errors: type: array items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string r2_messages: type: array items: type: string r2_result_info: type: object properties: cursor: type: string description: A continuation token that should be used to fetch the next page of results example: 1-JTdCJTIydiUyMiUzQTElMkMlMjJzdGFydEFmdGVyJTIyJTNBJTIyZGF2aWRwdWJsaWMlMjIlN0Q= per_page: type: number description: Maximum number of results on this page example: 20 r2_sippy: type: object properties: destination: type: object description: Details about the configured destination bucket properties: accessKeyId: type: string description: | ID of the Cloudflare API token used when writing objects to this bucket account: type: string bucket: type: string description: Name of the bucket on the provider provider: type: string enum: - r2 enabled: type: boolean description: State of Sippy for this bucket source: type: object description: Details about the configured source bucket properties: bucket: type: string description: Name of the bucket on the provider provider: type: string enum: - aws - gcs region: type: string description: Region where the bucket resides (AWS only) nullable: true r2_v4_response: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/r2_errors' messages: $ref: '#/components/schemas/r2_messages' result: type: object success: type: boolean description: Whether the API call was successful enum: - true r2_v4_response_failure: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/r2_errors' messages: $ref: '#/components/schemas/r2_messages' result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false r2_v4_response_list: allOf: - $ref: '#/components/schemas/r2_v4_response' - type: object properties: result_info: $ref: '#/components/schemas/r2_result_info' registrar-api_address: type: string description: Address. example: 123 Sesame St. registrar-api_address2: type: string description: Optional address line for unit, floor, suite, etc. example: Suite 430 registrar-api_api-response-collection: allOf: - $ref: '#/components/schemas/registrar-api_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/registrar-api_result_info' type: object registrar-api_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/registrar-api_messages' messages: $ref: '#/components/schemas/registrar-api_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true registrar-api_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false registrar-api_api-response-single: allOf: - $ref: '#/components/schemas/registrar-api_api-response-common' - properties: result: type: object nullable: true type: object registrar-api_auto_renew: type: boolean description: Auto-renew controls whether subscription is automatically renewed upon domain expiration. example: true registrar-api_available: type: boolean description: Shows if a domain is available for transferring into Cloudflare Registrar. example: false registrar-api_can_register: type: boolean description: Indicates if the domain can be registered as a new domain. example: false registrar-api_city: type: string description: City. example: Austin registrar-api_contact_identifier: type: string description: Contact Identifier. example: ea95132c15732412d22c1476fa83f27a readOnly: true maxLength: 32 registrar-api_contact_properties: type: object required: - first_name - last_name - address - city - state - zip - country - phone - organization 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' registrar-api_contacts: allOf: - $ref: '#/components/schemas/registrar-api_contact_properties' type: object registrar-api_country: type: string description: The country in which the user lives. example: US nullable: true maxLength: 30 registrar-api_created_at: type: string format: date-time description: Shows time of creation. example: "2018-08-28T17:26:26Z" registrar-api_current_registrar: type: string description: Shows name of current registrar. example: Cloudflare registrar-api_domain_identifier: type: string description: Domain identifier. example: ea95132c15732412d22c1476fa83f27a readOnly: true maxLength: 32 registrar-api_domain_name: type: string description: Domain name. example: cloudflare.com registrar-api_domain_properties: type: object 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' registrar-api_domain_response_collection: allOf: - $ref: '#/components/schemas/registrar-api_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/registrar-api_domains' registrar-api_domain_response_single: allOf: - $ref: '#/components/schemas/registrar-api_api-response-single' - properties: result: type: object registrar-api_domain_update_properties: type: object properties: auto_renew: $ref: '#/components/schemas/registrar-api_auto_renew' locked: $ref: '#/components/schemas/registrar-api_locked' privacy: $ref: '#/components/schemas/registrar-api_privacy' registrar-api_domains: allOf: - $ref: '#/components/schemas/registrar-api_domain_properties' type: object registrar-api_email: type: string description: The contact email address of the user. example: user@example.com maxLength: 90 registrar-api_expires_at: type: string format: date-time description: Shows when domain name registration expires. example: "2019-08-28T23:59:59Z" registrar-api_fax: type: string description: Contact fax number. example: 123-867-5309 registrar-api_first_name: type: string description: User's first name example: John nullable: true maxLength: 60 registrar-api_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 registrar-api_last_name: type: string description: User's last name example: Appleseed nullable: true maxLength: 60 registrar-api_locked: type: boolean description: Shows whether a registrar lock is in place for a domain. example: false registrar-api_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string registrar-api_organization: type: string description: Name of organization. example: Cloudflare, Inc. registrar-api_privacy: type: boolean description: Privacy option controls redacting WHOIS information. example: true registrar-api_registrant_contact: allOf: - $ref: '#/components/schemas/registrar-api_contacts' description: Shows contact information for domain registrant. registrar-api_registry_statuses: type: string description: A comma-separated list of registry status codes. A full list of status codes can be found at [EPP Status Codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en). example: ok,serverTransferProhibited registrar-api_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 registrar-api_state: type: string description: State. example: TX registrar-api_supported_tld: type: boolean description: Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to [TLD Policies](https://www.cloudflare.com/tld-policies/) for a list of supported TLDs. example: true registrar-api_telephone: type: string description: User's telephone number example: +1 123-123-1234 nullable: true maxLength: 20 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. example: needed approve_transfer: description: Shows transfer status with the registry. example: unknown can_cancel_transfer: type: boolean description: Indicates if cancellation is still possible. example: true disable_privacy: description: Privacy guards are disabled at the foreign registrar. enter_auth_code: description: Auth code has been entered and verified. example: needed unlock_domain: description: Domain is unlocked at the foreign registrar. registrar-api_updated_at: type: string format: date-time description: Last updated. example: "2018-08-28T17:26:26Z" registrar-api_zipcode: type: string description: The zipcode or postal code where the user lives. example: "12345" nullable: true maxLength: 20 request-tracer_account_identifier: $ref: '#/components/schemas/request-tracer_identifier' request-tracer_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/request-tracer_messages' messages: $ref: '#/components/schemas/request-tracer_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true request-tracer_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false request-tracer_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 request-tracer_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string request-tracer_trace: type: array items: type: object description: List of steps acting on request/response properties: action: type: string description: If step type is rule, then action performed by this rule example: execute pattern: ^[a-z_]+$ action_parameters: type: object description: If step type is rule, then action parameters of this rule as JSON example: id: 4814384a9e5d4991b9815dcfc25d2f1f description: type: string description: If step type is rule or ruleset, the description of this entity example: some rule expression: type: string description: If step type is rule, then expression used to match for this rule example: ip.src ne 1.1.1.1 kind: type: string description: If step type is ruleset, then kind of this ruleset example: zone matched: type: boolean description: Whether tracing step affected tracing request/response example: true name: type: string description: If step type is ruleset, then name of this ruleset example: some ruleset name step_name: type: string description: Tracing step identifying name example: rule_id01 trace: $ref: '#/components/schemas/request-tracer_trace' type: type: string description: Tracing step type example: rule rulesets_AccountId: type: string title: ID description: The unique ID of the account. example: abf9b32d38c5f572afde3336ec0ce302 pattern: ^[0-9a-f]{32}$ rulesets_BlockRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Block rule properties: action: enum: - block action_parameters: properties: response: type: object title: Response description: The response to show when the block is applied. required: - status_code - content - content_type properties: content: type: string title: Content description: The content to return. example: |- { "success": false, "error": "you have been blocked" } minLength: 1 content_type: type: string title: Content type description: The type of the content to return. example: application/json minLength: 1 status_code: type: integer title: Status code description: The status code to return. minimum: 400 maximum: 499 description: example: Block when the IP address is not 1.1.1.1 rulesets_ChallengeRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Challenge 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 rulesets_CompressResponseRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Compression rule properties: action: enum: - compress_response action_parameters: properties: algorithms: type: array title: Algorithm description: Custom order for compression algorithms. example: - name: none items: type: object title: Compression Algorithm description: Compression algorithm to enable. properties: name: type: string title: Name description: Name of compression algorithm to enable. enum: - none - auto - default - gzip - brotli description: example: Disable compression when address is not 1.1.1.1 rulesets_Errors: type: array title: Errors description: A list of error messages. items: $ref: '#/components/schemas/rulesets_Message' rulesets_ExecuteRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Execute rule properties: action: enum: - execute action_parameters: required: - id properties: id: allOf: - $ref: '#/components/schemas/rulesets_RulesetId' - description: The ID of the ruleset to execute. example: 4814384a9e5d4991b9815dcfc25d2f1f matched_data: type: object title: Matched data description: The configuration to use for matched data logging. required: - public_key properties: public_key: type: string title: Public key description: The public key to encrypt matched data logs with. example: iGqBmyIUxuWt1rvxoAharN9FUXneUBxA/Y19PyyrEG0= minLength: 1 overrides: type: object title: Overrides description: A set of overrides to apply to the target ruleset. properties: action: allOf: - $ref: '#/components/schemas/rulesets_RuleAction' - description: An action to override all rules with. This option has lower precedence than rule and category overrides. example: log categories: type: array title: Category overrides description: A list of category-level overrides. This option has the second-highest precedence after rule-level overrides. uniqueItems: true minItems: 1 items: type: object title: Category override description: A category-level override required: - category properties: action: allOf: - $ref: '#/components/schemas/rulesets_RuleAction' - description: The action to override rules in the category with. 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. minProperties: 2 enabled: allOf: - $ref: '#/components/schemas/rulesets_RuleEnabled' - description: Whether to enable execution of all rules. This option has lower precedence than rule and category overrides. rules: type: array title: Rule overrides description: A list of rule-level overrides. This option has the highest precedence. uniqueItems: true minItems: 1 items: type: object title: Rule override description: A rule-level override required: - id properties: action: allOf: - $ref: '#/components/schemas/rulesets_RuleAction' - description: The action to override the rule with. 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: type: integer title: Score threshold description: The score threshold to use for the rule. sensitivity_level: allOf: - $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel' - description: The sensitivity level to use for the rule. minProperties: 2 sensitivity_level: allOf: - $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel' - description: A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. minProperties: 1 description: example: Execute the OWASP ruleset when the IP address is not 1.1.1.1 rulesets_ExecuteSensitivityLevel: type: string title: Sensitivity level enum: - default - medium - low - eoff rulesets_JsChallengeRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Javascript Challenge 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 rulesets_LogRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Log rule properties: action: enum: - log description: example: Log when the IP address is not 1.1.1.1 rulesets_ManagedChallengeRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Managed Challenge 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 rulesets_Message: type: object title: Message description: A message. required: - message properties: code: type: integer title: Code description: A unique code for this message. example: 10000 message: type: string title: Description description: A text description of this message. example: something bad happened minLength: 1 source: type: object title: Source description: The source of this message. required: - pointer properties: pointer: type: string title: Pointer description: A JSON pointer to the field that is the source of the message. example: /rules/0/action minLength: 1 rulesets_Messages: type: array title: Messages description: A list of warning messages. items: $ref: '#/components/schemas/rulesets_Message' rulesets_RedirectRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Redirect rule properties: action: enum: - redirect action_parameters: properties: from_list: type: object title: Bulk Redirect description: Serve a redirect based on a bulk list lookup. properties: key: type: string title: Key description: Expression that evaluates to the list lookup key. example: http.request.full_uri minLength: 1 name: type: string title: Name description: The name of the list to match against. example: list1 maxLength: 50 pattern: ^[a-zA-Z0-9_]+$ from_value: type: object title: Single redirect description: Serve a redirect based on the request properties. properties: preserve_query_string: type: boolean title: Preserve query string description: Keep the query string of the original request. status_code: type: number title: Status Code description: The status code to be used for the redirect. enum: - 301 - 302 - 303 - 307 - 308 target_url: oneOf: - type: object title: Static URL redirect properties: value: type: string description: The URL to redirect the request to. minLength: 1 - type: object title: Dynamic URL redirect properties: expression: type: string description: An expression to evaluate to get the URL to redirect the request to. minLength: 1 description: The URL to redirect the request to. example: expression: concat("https://m.example.com", http.request.uri.path) description: example: Redirect when IP address is not 1.1.1.1 rulesets_RequestRule: 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' discriminator: propertyName: action mapping: block: '#/components/schemas/rulesets_BlockRule' challenge: '#/components/schemas/rulesets_ChallengeRule' compress_response: '#/components/schemas/rulesets_CompressResponseRule' execute: '#/components/schemas/rulesets_ExecuteRule' js_challenge: '#/components/schemas/rulesets_JsChallengeRule' log: '#/components/schemas/rulesets_LogRule' 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' rulesets_RequestRules: type: array title: Rules description: The list of rules in the ruleset. items: $ref: '#/components/schemas/rulesets_RequestRule' rulesets_Response: type: object title: Response description: A response object. required: - result - success - errors - messages properties: errors: $ref: '#/components/schemas/rulesets_Errors' messages: $ref: '#/components/schemas/rulesets_Messages' result: title: Result description: A result. success: type: boolean title: Success description: Whether the API call was successful. rulesets_ResponseRule: allOf: - $ref: '#/components/schemas/rulesets_RequestRule' - required: - id - expression - action - ref - enabled rulesets_ResponseRules: type: array title: Rules description: The list of rules in the ruleset. items: $ref: '#/components/schemas/rulesets_ResponseRule' rulesets_RewriteRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Rewrite rule properties: action: enum: - rewrite action_parameters: properties: headers: type: object title: Headers description: Map of request headers to modify. example: client-http-version: expression: http.request.version operation: set uri: type: object title: URI description: URI to rewrite the request to. properties: path: allOf: - title: Path description: Path portion rewrite. example: expression: regex_replace(http.request.uri.path, "/bar$", "/baz") - $ref: '#/components/schemas/rulesets_RewriteUriPart' query: allOf: - title: Query description: Query portion rewrite. example: expression: regex_replace(http.request.uri.query, "foo=bar", "") - $ref: '#/components/schemas/rulesets_RewriteUriPart' description: example: Add a header when the IP address is not 1.1.1.1 rulesets_RewriteUriPart: oneOf: - type: object title: Static value required: - value properties: value: type: string description: Predefined replacement value. example: /images minLength: 1 - type: object title: Dynamic value required: - expression properties: expression: type: string description: Expression to evaluate for the replacement value. example: regex_replace(http.request.uri.path, "/bar$", "/baz") minLength: 1 rulesets_RouteRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Origin rule properties: action: enum: - route action_parameters: properties: host_header: type: string title: Host Header description: Rewrite the HTTP Host header. example: static.example.com minLength: 1 origin: type: object title: Origin description: Override the IP/TCP destination. properties: host: type: string title: DNS Record description: Override the resolved hostname. example: static.example.com minLength: 1 port: type: number title: Port description: Override the destination port. minimum: 1 maximum: 65535 sni: type: object title: SNI description: Override the Server Name Indication (SNI). required: - value properties: value: type: string title: Value description: The SNI override. example: static.example.com minLength: 1 description: example: Select origin server when IP address is not 1.1.1.1 rulesets_Rule: type: object title: Rule required: - version - last_updated properties: action: $ref: '#/components/schemas/rulesets_RuleAction' action_parameters: type: object title: Action parameters description: The parameters configuring the rule's action. categories: type: array title: Categories description: The categories of the rule. example: - directory-traversal - header uniqueItems: true readOnly: true minItems: 1 items: $ref: '#/components/schemas/rulesets_RuleCategory' description: type: string title: Description description: An informative description of the rule. default: "" enabled: allOf: - $ref: '#/components/schemas/rulesets_RuleEnabled' - default: true expression: type: string title: Expression description: The expression defining which traffic will match the rule. example: ip.src ne 1.1.1.1 minLength: 1 id: $ref: '#/components/schemas/rulesets_RuleId' last_updated: type: string title: Last updated format: date-time description: The timestamp of when the rule was last modified. example: "2000-01-01T00:00:00.000000Z" readOnly: true logging: type: object title: Logging description: An object configuring the rule's logging behavior. required: - enabled properties: enabled: type: boolean title: Enabled description: Whether to generate a log when the rule matches. example: true ref: type: string title: Ref description: The reference of the rule (the rule ID by default). example: my_ref minLength: 1 version: type: string title: Version description: The version of the rule. example: "1" readOnly: true pattern: ^[0-9]+$ rulesets_RuleAction: type: string title: Action description: The action to perform when the rule matches. pattern: ^[a-z]+$ rulesets_RuleCategory: type: string title: Category description: A category of the rule. example: directory-traversal minLength: 1 rulesets_RuleEnabled: type: boolean title: Enabled description: Whether the rule should be executed. example: true rulesets_RuleId: type: string title: ID description: The unique ID of the rule. example: 3a03d665bac047339bb530ecb439a90d pattern: ^[0-9a-f]{32}$ rulesets_RulePosition: type: object title: Position description: An object configuring where the rule will be placed. rulesets_Ruleset: type: object title: Ruleset description: A ruleset object. required: - id - version - last_updated properties: description: type: string title: Description description: An informative description of the ruleset. default: "" example: My ruleset to execute managed rulesets id: allOf: - $ref: '#/components/schemas/rulesets_RulesetId' - readOnly: true kind: $ref: '#/components/schemas/rulesets_RulesetKind' last_updated: type: string title: Last updated format: date-time description: The timestamp of when the ruleset was last modified. example: "2000-01-01T00:00:00.000000Z" readOnly: true name: type: string title: Name description: The human-readable name of the ruleset. example: My ruleset minLength: 1 phase: $ref: '#/components/schemas/rulesets_RulesetPhase' version: $ref: '#/components/schemas/rulesets_RulesetVersion' rulesets_RulesetId: type: string title: ID description: The unique ID of the ruleset. example: 2f2feab2026849078ba485f918791bdc pattern: ^[0-9a-f]{32}$ rulesets_RulesetKind: type: string title: Kind description: The kind of the ruleset. enum: - managed - custom - root - zone example: root rulesets_RulesetPhase: type: string title: Phase description: The phase of the ruleset. enum: - ddos_l4 - ddos_l7 - http_config_settings - http_custom_errors - http_log_custom_fields - http_ratelimit - http_request_cache_settings - http_request_dynamic_redirect - http_request_firewall_custom - http_request_firewall_managed - http_request_late_transform - http_request_origin - http_request_redirect - http_request_sanitize - http_request_sbfm - http_request_select_configuration - http_request_transform - http_response_compression - http_response_firewall_managed - http_response_headers_transform - magic_transit - magic_transit_ids_managed - magic_transit_managed example: http_request_firewall_custom rulesets_RulesetVersion: type: string title: Version description: The version of the ruleset. example: "1" readOnly: true pattern: ^[0-9]+$ rulesets_ScoreRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Score rule properties: action: enum: - score action_parameters: example: increment: 3 properties: increment: type: integer title: Increment description: Increment contains the delta to change the score and can be either positive or negative. example: 3 minProperties: 1 description: example: Increment score when the IP address is not 1.1.1.1 rulesets_ServeErrorRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Serve Error rule properties: action: enum: - serve_error action_parameters: properties: content: type: string title: Content description: Error response content. example: | {"error": "1xxx error occurred"} minLength: 1 maxLength: 10240 content_type: type: string title: Content Type description: Content-type header to set with the response. enum: - application/json - text/xml - text/plain - text/html example: application/json status_code: type: number title: Status Code description: The status code to use for the error. example: 500 minimum: 400 maximum: 999 description: example: Serve a JSON response to api users on error rulesets_SetCacheSettingsRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Set Cache Settings rule properties: action: enum: - set_cache_settings action_parameters: properties: additional_cacheable_ports: type: array title: Additional Cacheable Ports (Enterprise-only) description: List of additional ports that caching can be enabled on. items: type: integer title: Additional Cacheable Port description: A port to enable caching on browser_ttl: type: object title: 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 } required: - mode properties: default: type: integer title: Default TTL description: The TTL (in seconds) if you choose override_origin mode. mode: type: string title: Mode description: Determines which browser ttl mode to use. enum: - respect_origin - bypass_by_default - override_origin cache: type: boolean title: 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. cache_key: type: object title: 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: type: boolean title: Cache by Device Type description: Separate cached content based on the visitor’s device type cache_deception_armor: type: boolean title: Cache Deception Armor description: Protect from web cache deception attacks while allowing static assets to be cached custom_key: type: object title: Custom Key description: Customize which components of the request are included or excluded from the cache key. properties: cookie: type: object title: Cookie description: The cookies to include in building the cache key. properties: check_presence: type: array title: Check presence of cookies description: Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key. items: type: string title: Cookie name description: A cookie name to check presence of. include: type: array title: Include cookies description: Include these cookies' names and their values. items: type: string title: Cookie name description: Cookie name and corresponding value to include. header: type: object title: Headers description: The header names and values to include in building the cache key. properties: check_presence: type: array title: Check presence of headers description: Checks for the presence of these header names. The presence of these headers is used in building the cache key. items: type: string title: Header name description: A header name to check presence of. exclude_origin: type: boolean title: Exclude origin header description: Whether or not to include the origin header. A value of true will exclude the origin header in the cache key. include: type: array title: Include headers description: Include these headers' names and their values. items: type: string title: Header name description: Header name and corresponding value to include. host: type: object title: Host description: Whether to use the original host or the resolved host in the cache key. properties: resolved: type: boolean title: Use Resolved host 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 query_string: type: object title: Query String description: Use the presence or absence of parameters in the query string to build the cache key. properties: exclude: type: object title: Excluded query string parameters description: build the cache key using all query string parameters EXCECPT these excluded parameters properties: all: type: boolean title: All description: Exclude all query string parameters from use in building the cache key. list: type: array title: 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: type: string title: parameter description: A parameter in the list of query string parameters excluded from use in building a cache key. include: type: object title: Included query string parameters description: build the cache key using a list of query string parameters that ARE in the request. properties: all: type: boolean title: All description: Use all query string parameters in the cache key. list: type: array title: List description: A list of query string parameters used to build the cache key. items: type: string title: parameter description: parameter to include in the list of query string parameters used to build a cache key. user: type: object title: User description: Characteristics of the request user agent used in building the cache key. properties: device_type: type: boolean title: Device Type description: Use the user agent's device type in the cache key. geo: type: boolean title: Country description: Use the user agents's country in the cache key. lang: type: boolean title: Language description: Use the user agent's language in the cache key. ignore_query_strings_order: type: boolean title: 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. cache_reserve: type: object title: CacheReserve description: Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan). required: - eligible - min_file_size properties: eligible: type: boolean title: 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: |- { "enabled": true, "minimum_file_size": 100000 } min_file_size: type: integer title: Minimum File Size description: The minimum file size eligible for store in cache reserve. edge_ttl: type: object title: 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" } required: - mode - default - status_code_ttl properties: default: type: integer title: Default description: The TTL (in seconds) if you choose override_origin mode. minimum: 1 maximum: 9.223372036854776e+18 mode: type: string title: Mode description: edge ttl options enum: - respect_origin - bypass_by_default - override_origin status_code_ttl: type: array title: Status Code TTLs description: List of single status codes, or status code ranges to apply the selected mode items: type: object title: Status Code TTL 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 required: - value properties: status_code_range: type: object title: Status Code Range description: The range of status codes used to apply the selected mode. required: - from - to properties: from: type: integer title: Status Code lower bound description: response status code lower bound to: type: integer title: Status Code upper bound description: response status code upper bound status_code_value: type: integer title: Status Code Value description: Set the ttl for responses with this specific status code value: type: integer title: TTL 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". origin_cache_control: type: boolean title: Origin Cache Control (Enterprise-only) description: When enabled, Cloudflare will aim to strictly adhere to RFC 7234. origin_error_page_passthru: type: boolean title: 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 read_timeout: type: integer title: Read Timeout (Enterprise-only) 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 respect_strong_etags: type: boolean title: 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. serve_stale: type: object title: 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. required: - disable_stale_while_updating properties: disable_stale_while_updating: type: boolean title: 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. description: example: Set cache settings when the hostname address is not example.com rulesets_SetConfigRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Set Config Rule properties: action: enum: - set_config action_parameters: properties: automatic_https_rewrites: type: boolean title: Automatic HTTPS rewrites description: Turn on or off Automatic HTTPS Rewrites. autominify: type: object title: Auto Minify description: Select which file extensions to minify automatically. properties: css: type: boolean title: CSS description: Minify CSS files. html: type: boolean title: HTML description: Minify HTML files. js: type: boolean title: JS description: Minify JS files. bic: type: boolean title: Browser Integrity Check description: Turn on or off Browser Integrity Check. disable_apps: type: boolean title: Disable Apps description: Turn off all active Cloudflare Apps. disable_zaraz: type: boolean title: Disable Zaraz description: Turn off Zaraz. email_obfuscation: type: boolean title: Email Obfuscation description: Turn on or off Email Obfuscation. hotlink_protection: type: boolean title: Hotlink Protection description: Turn on or off the Hotlink Protection. mirage: type: boolean title: Mirage description: Turn on or off Mirage. opportunistic_encryption: type: boolean title: Opportunistic Encryption description: Turn on or off Opportunistic Encryption. polish: type: string title: Polish description: Configure the Polish level. enum: - "off" - lossless - lossy rocket_loader: type: boolean title: Rocket Loader description: Turn on or off Rocket Loader security_level: type: string title: Security Level description: Configure the Security Level. enum: - "off" - essentially_off - low - medium - high - under_attack server_side_excludes: type: boolean title: Server Side Excludes description: Turn on or off Server Side Excludes. ssl: type: string title: SSL description: Configure the SSL level. enum: - "off" - flexible - full - strict - origin_pull sxg: type: boolean title: Signed Exchanges (SXG) description: Turn on or off Signed Exchanges (SXG). description: example: Disable Zaraz when IP address is not 1.1.1.1 rulesets_SkipRule: allOf: - $ref: '#/components/schemas/rulesets_Rule' - title: Skip rule properties: action: enum: - skip action_parameters: example: ruleset: current properties: phases: type: array title: Phases description: A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options. uniqueItems: true minItems: 1 items: allOf: - $ref: '#/components/schemas/rulesets_RulesetPhase' - description: A phase to skip the execution of. products: type: array title: Products description: A list of legacy security products to skip the execution of. uniqueItems: true minItems: 1 items: type: string title: Product description: The name of a legacy security product to skip the execution of. enum: - bic - hot - rateLimit - securityLevel - uaBlock - waf - zoneLockdown rules: type: object title: Rules description: A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option. example: 4814384a9e5d4991b9815dcfc25d2f1f: - 8ac8bc2a661e475d940980f9317f28e1 minProperties: 1 ruleset: type: string title: Ruleset description: A ruleset to skip the execution of. This option is incompatible with the rulesets, rules and phases options. enum: - current rulesets: type: array title: Rulesets description: A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options. uniqueItems: true minItems: 1 items: allOf: - $ref: '#/components/schemas/rulesets_RulesetId' - title: Ruleset description: The ID of a ruleset to skip the execution of. example: 4814384a9e5d4991b9815dcfc25d2f1f minProperties: 1 description: example: Skip the current ruleset when the IP address is not 1.1.1.1 rulesets_ZoneId: type: string title: ID description: The unique ID of the zone. example: 9f1839b6152d298aca64c4e906b6d074 pattern: ^[0-9a-f]{32}$ rulesets_api-response-collection: allOf: - $ref: '#/components/schemas/rulesets_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/rulesets_result_info' type: object rulesets_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/rulesets_messages' messages: $ref: '#/components/schemas/rulesets_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true rulesets_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/rulesets_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/rulesets_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false rulesets_api-response-single: allOf: - $ref: '#/components/schemas/rulesets_api-response-common' - properties: result: anyOf: - type: object - type: string type: object rulesets_available: type: boolean description: When true, the Managed Transform is available in the current Cloudflare plan. example: true rulesets_custom_pages_response_collection: allOf: - $ref: '#/components/schemas/rulesets_api-response-collection' - properties: result: type: array items: type: object rulesets_custom_pages_response_single: allOf: - $ref: '#/components/schemas/rulesets_api-response-single' - properties: result: type: object rulesets_enabled: type: boolean description: When true, the Managed Transform is enabled. example: true rulesets_id: type: string description: Human-readable identifier of the Managed Transform. example: add_cf-bot-score_header rulesets_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 rulesets_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string rulesets_request_list: type: array items: $ref: '#/components/schemas/rulesets_request_model' rulesets_request_model: type: object properties: enabled: $ref: '#/components/schemas/rulesets_enabled' id: $ref: '#/components/schemas/rulesets_id' rulesets_response_list: type: array items: $ref: '#/components/schemas/rulesets_response_model' rulesets_response_model: type: object properties: available: $ref: '#/components/schemas/rulesets_available' enabled: $ref: '#/components/schemas/rulesets_enabled' id: $ref: '#/components/schemas/rulesets_id' rulesets_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 rulesets_schemas-request_model: type: object properties: scope: $ref: '#/components/schemas/rulesets_scope' type: $ref: '#/components/schemas/rulesets_type' rulesets_schemas-response_model: type: object properties: scope: $ref: '#/components/schemas/rulesets_scope' type: $ref: '#/components/schemas/rulesets_type' rulesets_scope: type: string description: The scope of the URL normalization. example: incoming rulesets_type: type: string description: The type of URL normalization performed by Cloudflare. example: cloudflare rum_api-response-collection: allOf: - $ref: '#/components/schemas/rum_api-response-common' type: object rum_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/rum_messages' messages: $ref: '#/components/schemas/rum_messages' success: type: boolean description: Whether the API call was successful. example: true rum_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false rum_api-response-single: allOf: - $ref: '#/components/schemas/rum_api-response-common' type: object rum_auto_install: type: boolean description: If enabled, the JavaScript snippet is automatically injected for orange-clouded sites. example: true rum_create-rule-request: type: object properties: host: type: string example: example.com inclusive: type: boolean description: Whether the rule includes or excludes traffic from being measured. example: true is_paused: type: boolean description: Whether the rule is paused or not. example: false paths: type: array example: - '*' items: type: string rum_create-site-request: type: object properties: auto_install: $ref: '#/components/schemas/rum_auto_install' host: type: string description: The hostname to use for gray-clouded sites. example: example.com zone_tag: $ref: '#/components/schemas/rum_zone_tag' rum_created: $ref: '#/components/schemas/rum_timestamp' rum_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 rum_is_host_regex: type: boolean description: Whether to match the hostname using a regular expression. example: false rum_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string rum_modify-rules-request: type: object properties: delete_rules: type: array description: A list of rule identifiers to delete. items: $ref: '#/components/schemas/rum_rule_identifier' rules: type: array description: A list of rules to create or update. items: type: object properties: host: type: string example: example.com id: $ref: '#/components/schemas/rum_rule_identifier' inclusive: type: boolean example: true is_paused: type: boolean example: false paths: type: array example: - '*' items: type: string rum_order_by: type: string description: The property used to sort the list of results. enum: - host - created example: host rum_page: type: number description: Current page within the paginated list of results. example: 1 rum_per_page: type: number description: Number of items to return per page of results. example: 10 rum_result_info: type: object properties: count: type: integer description: The total number of items on the current page. example: 10 page: type: integer description: Current page within the paginated list of results. example: 1 per_page: type: integer description: The maximum number of items to return per page of results. example: 10 total_count: type: integer description: The total number of items. example: 25 total_pages: type: integer description: The total number of pages. example: 3 nullable: true rum_rule: type: object properties: created: $ref: '#/components/schemas/rum_timestamp' host: type: string description: The hostname the rule will be applied to. example: example.com id: $ref: '#/components/schemas/rum_rule_identifier' inclusive: type: boolean description: Whether the rule includes or excludes traffic from being measured. example: true is_paused: type: boolean description: Whether the rule is paused or not. example: false paths: type: array description: The paths the rule will be applied to. example: - '*' items: type: string priority: type: number example: 1000 rum_rule-id-response-single: allOf: - $ref: '#/components/schemas/rum_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/rum_rule_identifier' rum_rule-response-single: allOf: - $ref: '#/components/schemas/rum_api-response-single' - properties: result: $ref: '#/components/schemas/rum_rule' rum_rule_identifier: type: string description: The Web Analytics rule identifier. example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 rum_rules: type: array description: A list of rules. items: $ref: '#/components/schemas/rum_rule' rum_rules-response-collection: allOf: - $ref: '#/components/schemas/rum_api-response-collection' - properties: result: type: object properties: rules: $ref: '#/components/schemas/rum_rules' ruleset: $ref: '#/components/schemas/rum_ruleset' rum_ruleset: type: object properties: enabled: type: boolean description: Whether the ruleset is enabled. example: true id: $ref: '#/components/schemas/rum_ruleset_identifier' zone_name: type: string example: example.com zone_tag: $ref: '#/components/schemas/rum_zone_tag' rum_ruleset_identifier: type: string description: The Web Analytics ruleset identifier. example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 rum_site: type: object 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' rum_site-response-single: allOf: - $ref: '#/components/schemas/rum_api-response-single' - properties: result: $ref: '#/components/schemas/rum_site' rum_site-tag-response-single: allOf: - $ref: '#/components/schemas/rum_api-response-single' - properties: result: type: object properties: site_tag: $ref: '#/components/schemas/rum_site_tag' rum_site_tag: type: string description: The Web Analytics site identifier. example: 023e105f4ecef8ad9ca31a8372d0c353 rum_site_token: type: string description: The Web Analytics site token. example: 023e105f4ecef8ad9ca31a8372d0c353 rum_sites-response-collection: allOf: - $ref: '#/components/schemas/rum_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/rum_site' result_info: $ref: '#/components/schemas/rum_result_info' rum_snippet: type: string description: Encoded JavaScript snippet. example: '' rum_timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true rum_zone_tag: type: string description: The zone identifier. example: 023e105f4ecef8ad9ca31a8372d0c353 secondary-dns_account_identifier: example: 01a7362d577a6c3019a474fd6f485823 readOnly: true secondary-dns_acl: type: object required: - id - name - ip_range 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' secondary-dns_acl_components-schemas-name: type: string description: The name of the acl. example: my-acl-1 secondary-dns_algo: type: string description: TSIG algorithm. example: hmac-sha512. secondary-dns_api-response-collection: allOf: - $ref: '#/components/schemas/secondary-dns_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/secondary-dns_result_info' type: object secondary-dns_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/secondary-dns_messages' messages: $ref: '#/components/schemas/secondary-dns_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true secondary-dns_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/secondary-dns_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/secondary-dns_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false secondary-dns_api-response-single: allOf: - $ref: '#/components/schemas/secondary-dns_api-response-common' - properties: result: anyOf: - type: object - type: string type: object secondary-dns_auto_refresh_seconds: type: number description: |- How often should a secondary zone auto refresh regardless of DNS NOTIFY. Not applicable for primary zones. example: 86400 secondary-dns_components-schemas-id_response: allOf: - $ref: '#/components/schemas/secondary-dns_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/secondary-dns_components-schemas-identifier' secondary-dns_components-schemas-identifier: example: 23ff594956f20c2a721606e94745a8aa readOnly: true secondary-dns_components-schemas-name: type: string description: The name of the peer. example: my-peer-1 secondary-dns_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/secondary-dns_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/secondary-dns_acl' 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: type: string description: The zone transfer status of a primary zone example: Disabled secondary-dns_dns-secondary-secondary-zone: type: object required: - id - name - peers - auto_refresh_seconds properties: auto_refresh_seconds: $ref: '#/components/schemas/secondary-dns_auto_refresh_seconds' id: $ref: '#/components/schemas/secondary-dns_identifier' name: $ref: '#/components/schemas/secondary-dns_name' peers: $ref: '#/components/schemas/secondary-dns_peers' 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: type: string description: The zone transfer status of a primary zone example: Enabled 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: type: string description: When force_axfr query parameter is set to true, the response is a simple string example: OK secondary-dns_id_response: allOf: - $ref: '#/components/schemas/secondary-dns_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/secondary-dns_identifier' secondary-dns_identifier: example: 269d8f4853475ca241c4e730be286b20 readOnly: true secondary-dns_ip: type: string description: IPv4/IPv6 address of primary or secondary nameserver, depending on what zone this peer is linked to. For primary zones this IP defines the IP of the secondary nameserver Cloudflare will NOTIFY upon zone changes. For secondary zones this IP defines the IP of the primary nameserver Cloudflare will send AXFR/IXFR requests to. example: 192.0.2.53 secondary-dns_ip_range: type: string description: Allowed IPv4/IPv6 address range of primary or secondary nameservers. This will be applied for the entire account. The IP range is used to allow additional NOTIFY IPs for secondary zones and IPs Cloudflare allows AXFR/IXFR requests from for primary zones. CIDRs are limited to a maximum of /24 for IPv4 and /64 for IPv6 respectively. example: 192.0.2.53/28 secondary-dns_ixfr_enable: type: boolean description: Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones. example: false secondary-dns_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string secondary-dns_name: type: string description: Zone name. example: www.example.com. secondary-dns_peer: type: object required: - id - name 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' secondary-dns_peers: type: array description: A list of peer tags. example: - 23ff594956f20c2a721606e94745a8aa - 00920f38ce07c2e2f4df50b1f61d4194 items: {} secondary-dns_port: type: number description: DNS port of primary or secondary nameserver, depending on what zone this peer is linked to. example: 53 secondary-dns_response_collection: allOf: - $ref: '#/components/schemas/secondary-dns_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/secondary-dns_tsig' secondary-dns_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 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: type: string description: When force_notify query parameter is set to true, the response is a simple string example: OK secondary-dns_schemas-id_response: allOf: - $ref: '#/components/schemas/secondary-dns_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/secondary-dns_schemas-identifier' secondary-dns_schemas-identifier: example: 69cd1e104af3e6ed3cb344f263fd0d5a readOnly: true secondary-dns_schemas-name: type: string description: TSIG key name. example: tsig.customer.cf. secondary-dns_schemas-response_collection: allOf: - $ref: '#/components/schemas/secondary-dns_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/secondary-dns_peer' 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: type: string description: TSIG secret. example: caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c secondary-dns_single_request_outgoing: required: - id - name - peers properties: id: $ref: '#/components/schemas/secondary-dns_identifier' name: $ref: '#/components/schemas/secondary-dns_name' peers: $ref: '#/components/schemas/secondary-dns_peers' 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: type: object properties: auto_refresh_seconds: $ref: '#/components/schemas/secondary-dns_auto_refresh_seconds' checked_time: $ref: '#/components/schemas/secondary-dns_time' created_time: $ref: '#/components/schemas/secondary-dns_time' id: $ref: '#/components/schemas/secondary-dns_identifier' modified_time: $ref: '#/components/schemas/secondary-dns_time' name: $ref: '#/components/schemas/secondary-dns_name' peers: $ref: '#/components/schemas/secondary-dns_peers' soa_serial: $ref: '#/components/schemas/secondary-dns_soa_serial' secondary-dns_single_response_outgoing: allOf: - $ref: '#/components/schemas/secondary-dns_api-response-single' - properties: result: type: object properties: checked_time: $ref: '#/components/schemas/secondary-dns_time' created_time: $ref: '#/components/schemas/secondary-dns_time' id: $ref: '#/components/schemas/secondary-dns_identifier' last_transferred_time: $ref: '#/components/schemas/secondary-dns_time' name: $ref: '#/components/schemas/secondary-dns_name' peers: $ref: '#/components/schemas/secondary-dns_peers' soa_serial: $ref: '#/components/schemas/secondary-dns_soa_serial' secondary-dns_soa_serial: type: number description: The serial number of the SOA for the given zone. example: 2.0191024e+09 secondary-dns_time: type: string description: The time for a specific event. example: "2019-10-24T17:09:42.883908+01:00" secondary-dns_tsig: type: object required: - id - name - secret - algo 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' secondary-dns_tsig_id: type: string description: TSIG authentication will be used for zone transfer if configured. example: 69cd1e104af3e6ed3cb344f263fd0d5a security-center_accountId: $ref: '#/components/schemas/security-center_identifier' security-center_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/security-center_messages' messages: $ref: '#/components/schemas/security-center_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true security-center_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false security-center_api-response-single: allOf: - $ref: '#/components/schemas/security-center_api-response-common' - properties: result: anyOf: - type: object - type: string type: object security-center_count: type: integer description: Total number of results example: 1 security-center_dismissed: type: boolean example: false security-center_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 security-center_issue: type: object properties: dismissed: type: boolean example: false 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: type: string enum: - Low - Moderate - Critical since: type: string format: date-time subject: $ref: '#/components/schemas/security-center_subject' timestamp: type: string format: date-time security-center_issueClass: type: string example: always_use_https_not_enabled security-center_issueClasses: type: array example: - a_record_dangling - always_use_https_not_enabled items: $ref: '#/components/schemas/security-center_issueClass' security-center_issueType: type: string enum: - compliance_violation - email_security - exposed_infrastructure - insecure_configuration - weak_authentication security-center_issueTypes: type: array example: - compliance_violation - email_security items: $ref: '#/components/schemas/security-center_issueType' security-center_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string security-center_page: type: integer description: Current page within paginated list of results example: 1 security-center_perPage: type: integer description: Number of results per page of results example: 25 minimum: 1 maximum: 1000 security-center_products: type: array example: - access - dns items: type: string security-center_severityQueryParam: type: array example: - low - moderate items: type: string enum: - low - moderate - critical security-center_subject: type: string example: example.com security-center_subjects: type: array items: $ref: '#/components/schemas/security-center_subject' security-center_valueCountsResponse: allOf: - $ref: '#/components/schemas/security-center_api-response-common' - properties: result: anyOf: - type: array items: type: object properties: count: type: integer example: 1 value: type: string snippets-api_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/snippets-api_messages' messages: $ref: '#/components/schemas/snippets-api_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true snippets-api_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/snippets-api_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/snippets-api_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false snippets-api_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 snippets-api_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string snippets-api_rules: type: array description: List of snippet rules items: type: object properties: description: type: string example: Rule description enabled: type: boolean example: true expression: type: string example: http.cookie eq "a=b" snippet_name: $ref: '#/components/schemas/snippets-api_snippet_name' snippets-api_snippet: type: object description: Snippet Information properties: created_on: type: string description: Creation time of the snippet example: 2023-07-24-00:00:00 modified_on: type: string description: Modification time of the snippet example: 2023-07-24-00:00:00 snippet_name: $ref: '#/components/schemas/snippets-api_snippet_name' snippets-api_snippet_name: type: string description: Snippet identifying name example: snippet_name_01 pattern: ^[A-Za-z0-9_]+$ snippets-api_zone_identifier: $ref: '#/components/schemas/snippets-api_identifier' speed_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/speed_messages' messages: $ref: '#/components/schemas/speed_messages' success: type: boolean description: Whether the API call was successful example: true speed_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/speed_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/speed_messages' example: [] result: type: object nullable: true success: type: boolean description: Whether the API call was successful example: false speed_api-response-single-id: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: type: object nullable: true required: - id properties: id: $ref: '#/components/schemas/speed_identifier' type: object speed_base: required: - id - value properties: editable: type: boolean description: Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). enum: - true - false default: true readOnly: true id: type: string description: Identifier of the zone setting. example: development_mode modified_on: type: string format: date-time description: last time this setting was modified. example: "2014-01-01T05:20:00.12345Z" nullable: true readOnly: true value: description: Current value of the zone setting. example: "on" speed_cloudflare_fonts: allOf: - $ref: '#/components/schemas/speed_base' - properties: id: description: ID of the zone setting. enum: - fonts example: fonts value: $ref: '#/components/schemas/speed_cloudflare_fonts_value' title: Cloudflare Fonts description: | Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain, boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information. speed_cloudflare_fonts_value: type: string description: Whether the feature is enabled or disabled. enum: - "on" - "off" default: "off" speed_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 speed_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string stream_accessRules: type: object description: Defines rules for fine-grained control over content than signed URL tokens alone. Access rules primarily make tokens conditionally valid based on user information. Access Rules are specified on token payloads as the `accessRules` property containing an array of Rule objects. properties: action: type: string description: The action to take when a request matches a rule. If the action is `block`, the signed token blocks views for viewers matching the rule. enum: - allow - block example: allow country: type: array description: An array of 2-letter country codes in ISO 3166-1 Alpha-2 format used to match requests. items: type: string ip: type: array description: An array of IPv4 or IPV6 addresses or CIDRs used to match requests. items: type: string type: type: string description: Lists available rule types to match for requests. An `any` type matches all requests and can be used as a wildcard to apply default actions after other rules. enum: - any - ip.src - ip.geoip.country example: ip.src stream_account_identifier: type: string description: The account identifier tag. example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 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: type: array description: Lists the origins allowed to display the video. Enter allowed origin domains in an array and use `*` for wildcard subdomains. Empty arrays allow the video to be viewed on any origin. example: - example.com items: type: string stream_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/stream_messages' messages: $ref: '#/components/schemas/stream_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true stream_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false stream_api-response-single: allOf: - $ref: '#/components/schemas/stream_api-response-common' - properties: result: anyOf: - type: object - type: string type: object stream_asc: type: boolean description: Lists videos in ascending order of creation. default: false example: true stream_audio_default: type: boolean description: Denotes whether the audio track will be played by default in a player. default: false stream_audio_identifier: type: string description: The unique identifier for an additional audio track. example: ea95132c15732412d22c1476fa83f27a maxLength: 32 stream_audio_label: type: string description: A string to uniquely identify the track amongst other audio track labels for the specified video. example: director commentary stream_audio_state: type: string description: Specifies the processing status of the video. enum: - queued - ready - error stream_caption_basic_upload: type: object required: - file properties: file: type: string description: The WebVTT file containing the caption or subtitle content. example: '@/Users/kyle/Desktop/tr.vtt' stream_captions: type: object properties: label: $ref: '#/components/schemas/stream_label' language: $ref: '#/components/schemas/stream_language' stream_clipResponseSingle: allOf: - $ref: '#/components/schemas/stream_api-response-common' - properties: result: $ref: '#/components/schemas/stream_clipping' stream_clipped_from_video_uid: type: string description: The unique video identifier (UID). example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 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: type: string format: date-time description: The date and time the clip was created. example: "2014-01-02T02:20:00Z" stream_copyAudioTrack: type: object required: - label properties: label: $ref: '#/components/schemas/stream_audio_label' url: type: string format: uri 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 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: required: - url - streamKey properties: enabled: $ref: '#/components/schemas/stream_output_enabled' streamKey: $ref: '#/components/schemas/stream_output_streamKey' url: $ref: '#/components/schemas/stream_output_url' stream_created: type: string format: date-time description: The date and time the media item was created. example: "2014-01-02T02:20:00Z" stream_creator: type: string description: A user-defined identifier for the media creator. example: creator-id_abcde12345 maxLength: 64 stream_deleted_response: allOf: - $ref: '#/components/schemas/stream_api-response-single' - properties: result: type: string example: ok stream_direct_upload_request: type: object required: - maxDurationSeconds properties: allowedOrigins: $ref: '#/components/schemas/stream_allowedOrigins' creator: $ref: '#/components/schemas/stream_creator' expiry: type: string format: date-time description: The date and time after upload when videos will not be accepted. default: Now + 30 minutes example: "2021-01-02T02:20:00Z" maxDurationSeconds: $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' 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: type: string description: The URL an unauthenticated upload can use for a single `HTTP POST multipart/form-data` request. example: www.example.com/samplepath watermark: $ref: '#/components/schemas/stream_watermarks' stream_downloadedFrom: type: string description: The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null. example: https://company.com/logo.png stream_downloads_response: allOf: - $ref: '#/components/schemas/stream_api-response-single' - properties: result: type: object stream_duration: type: number 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. stream_editAudioTrack: type: object properties: default: $ref: '#/components/schemas/stream_audio_default' label: $ref: '#/components/schemas/stream_audio_label' stream_end: type: string format: date-time description: Lists videos created before the specified date. example: "2014-01-02T02:20:00Z" stream_end_time_seconds: type: integer description: Specifies the end time for the video clip in seconds. stream_errorReasonCode: type: string description: Specifies why the video failed to encode. This field is empty if the video is not in an `error` state. Preferred for programmatic use. example: ERR_NON_VIDEO stream_errorReasonText: type: string description: Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an `error` state. example: The file was not recognized as a valid video file. stream_height: type: integer description: The height of the image in pixels. stream_identifier: type: string description: A Cloudflare-generated unique identifier for a media item. example: ea95132c15732412d22c1476fa83f27a maxLength: 32 stream_include_counts: type: boolean description: Includes the total number of videos associated with the submitted query parameters. default: false example: true stream_input: type: object properties: height: type: integer description: The video height in pixels. A value of `-1` means the height is unknown. The value becomes available after the upload and before the video is ready. width: type: integer description: The video width in pixels. A value of `-1` means the width is unknown. The value becomes available after the upload and before the video is ready. stream_input_rtmps: type: object 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' stream_input_rtmps_stream_key: type: string description: The secret key to use when streaming via RTMPS to a live input. example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada stream_input_rtmps_url: type: string description: The RTMPS URL you provide to the broadcaster, which they stream live video to. example: rtmps://live.cloudflare.com:443/live/ stream_input_srt: type: object 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' stream_input_srt_stream_id: type: string description: The identifier of the live input to use when streaming via SRT. example: f256e6ea9341d51eea64c9454659e576 stream_input_srt_stream_passphrase: type: string description: The secret key to use when streaming via SRT to a live input. example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada stream_input_srt_url: type: string description: The SRT URL you provide to the broadcaster, which they stream live video to. example: srt://live.cloudflare.com:778 stream_input_webrtc: type: object description: Details for streaming to a live input using WebRTC. properties: url: $ref: '#/components/schemas/stream_input_webrtc_url' stream_input_webrtc_url: type: string description: The WebRTC URL you provide to the broadcaster, which they stream live video to. example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/publish stream_jwk: type: string description: The signing key in JWK format. example: eyJ1c2UiOiJzaWciLCJrdHkiOiJSU0EiLCJraWQiOiI1MjEzY2ZhMTIxZjcwYjhjMTM4MDY4NmZmYzM3MWJhMyIsImFsZyI6IlJTMjU2IiwibiI6IjBUandqT2laV21KNDN2ZjNUbzREb1htWFd0SkdOR3lYZmh5dHRMYUJnRjEtRVFXUURLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMtbFlSWW95ckFHRjRBWGh5MzI5YkhDUDFJbHJCQl9Ba0dnbmRMQWd1bnhZMHJSZ2N2T3ppYXc2S0p4Rm5jMlVLMFdVOGIwcDRLS0hHcDFLTDlkazBXVDhkVllxYmVSaUpqQ2xVRW1oOHl2OUNsT1ZhUzRLeGlYNnhUUTREWnc2RGFKZklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWi1peFdmY1RETUg5MnNHdm93MURPanhMaUNOMXpISy1oN2JMb1hUaUxnYzRrdyIsImUiOiJBUUFCIiwiZCI6IndpQWEwaU5mWnNYSGNOcVMxSWhnUmdzVHJHay1TcFlYV2lReDZHTU9kWlJKekhGazN0bkRERFJvNHNKZTBxX0dEOWkzNlEyZkVadS15elpEcEJkc3U5OHNtaHhNU19Ta0s5X3VFYUo1Zm96V2IyN3JRRnFoLVliUU9MUThkUnNPRHZmQl9Hb2txWWJzblJDR3kzWkFaOGZJZ25ocXBUNEpiOHdsaWxpMUgxeFpzM3RnTWtkTEluTm1yMFAtcTYxZEtNd3JYZVRoSWNEc0kyb2Z1LTFtRm1MWndQb2ZGbmxaTW9QN1pfRU5pUGNfWGtWNzFhaHBOZE9pcW5ablZtMHBCNE5QS1UweDRWTjQyYlAzWEhMUmpkV2hJOGt3SC1BdXhqb3BLaHJ0R2tvcG1jZFRkM1ZRdElaOGRpZHByMXpBaEpvQi16ZVlIaTFUel9ZSFFld0FRUSIsInAiOiIyVTZFVUJka3U3TndDYXoyNzZuWGMxRXgwVHpNZjU4U0UtU2M2eUNaYWk2TkwzVURpWi1mNHlIdkRLYnFGUXdLWDNwZ0l2aVE3Y05QYUpkbE9NeS1mU21GTXU3V3hlbVZYamFlTjJCMkRDazhQY0NEOVgxU2hhR3E1ZUdSSHNObVUtSDNxTG1FRGpjLWliazRHZ0RNb2lVYjQ2OGxFZHAwU2pIOXdsOUdsYTgiLCJxIjoiOW5ucXg5ZnNNY2dIZ29DemhfVjJmaDhoRUxUSUM5aFlIOVBCTG9aQjZIaE1TWG1ja1BSazVnUlpPWlFEN002TzlMaWZjNmFDVXdEbjBlQzU2YkFDNUNrcWxjODJsVDhzTWlMeWJyTjh3bWotcjNjSTBGQTlfSGQySEY1ZkgycnJmenVqd0NWM3czb09Ud3p4d1g3c2xKbklRanphel91SzEyWEtucVZZcUYwIiwiZHAiOiJxQklTUTlfVUNWaV9Ucng0UU9VYnZoVU9jc2FUWkNHajJiNzNudU9YeElnOHFuZldSSnN4RG5zd2FKaXdjNWJjYnZ3M1h0VGhRd1BNWnhpeE1UMHFGNlFGWVY5WXZibnJ6UEp4YkdNdTZqajZYc2lIUjFlbWU3U09lVDM4Xzg0aFZyOXV6UkN2RWstb0R0MHlodW9YVzFGWVFNRTE2cGtMV0ZkUjdRUERsQUUiLCJkcSI6Im5zQUp3eXZFbW8tdW5wU01qYjVBMHB6MExCRjBZNFMxeGRJYXNfLVBSYzd0dThsVFdWMl8teExEOFR6dmhqX0lmY0RJR3JJZGNKNjlzVVZnR1M3ZnZkcng3Y21uNjFyai1XcmU0UVJFRC1lV1dxZDlpc2FVRmg5UGVKZ2tCbFZVVnYtdnladVlWdFF2a1NUU05ZR3RtVXl2V2xKZDBPWEFHRm9jdGlfak9aVSIsInFpIjoib0dYaWxLQ2NKRXNFdEE1eG54WUdGQW5UUjNwdkZLUXR5S0F0UGhHaHkybm5ya2VzN1RRaEFxMGhLRWZtU1RzaE1hNFhfd05aMEstX1F0dkdoNDhpeHdTTDVLTEwxZnFsY0k2TF9XUnF0cFQxS21LRERlUHR2bDVCUzFGbjgwSGFwR215cmZRWUU4S09QR2UwUl82S1BOZE1vc3dYQ3Nfd0RYMF92ZzNoNUxRIn0= 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: type: array items: type: object properties: created: $ref: '#/components/schemas/stream_signing_key_created' id: $ref: '#/components/schemas/stream_schemas-identifier' stream_keys: type: object 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' stream_label: type: string description: The language label displayed in the native language to users. example: Türkçe stream_language: type: string description: The language tag in BCP 47 format. example: tr stream_language_response_collection: allOf: - $ref: '#/components/schemas/stream_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/stream_captions' 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: type: array items: $ref: '#/components/schemas/stream_additionalAudio' stream_live_input: type: object 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' stream_live_input_created: type: string format: date-time description: The date and time the live input was created. example: "2014-01-02T02:20:00Z" stream_live_input_default_creator: type: string description: Sets the creator ID asssociated with this live input. stream_live_input_identifier: type: string description: A unique identifier for a live input. example: 66be4bf738797e01e1fca35a7bdecdcd maxLength: 32 stream_live_input_metadata: type: object description: A user modifiable key-value store used to reference other systems of record for managing live inputs. example: name: test stream 1 stream_live_input_modified: type: string format: date-time description: The date and time the live input was last modified. example: "2014-01-02T02:20:00Z" 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: type: array description: Lists the origins allowed to display videos created with this input. Enter allowed origin domains in an array and use `*` for wildcard subdomains. An empty array allows videos to be viewed on any origin. example: - example.com items: type: string stream_live_input_recording_deletion: type: number 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 stream_live_input_recording_mode: type: string description: Specifies the recording behavior for the live input. Set this value to `off` to prevent a recording. Set the value to `automatic` to begin a recording and transition to on-demand after Stream Live stops receiving input. enum: - "off" - automatic default: "off" example: automatic stream_live_input_recording_requireSignedURLs: type: boolean description: Indicates if a video using the live input has the `requireSignedURLs` property set. Also enforces access controls on any video recording of the livestream with the live input. default: false example: true stream_live_input_recording_settings: type: object description: Records the input to a Cloudflare Stream video. Behavior depends on the mode. In most cases, the video will initially be viewable as a live video and transition to on-demand after a condition is satisfied. example: mode: "off" requireSignedURLs: false timeoutSeconds: 0 properties: allowedOrigins: $ref: '#/components/schemas/stream_live_input_recording_allowedOrigins' 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' stream_live_input_recording_timeoutSeconds: type: integer description: Determines the amount of time a live input configured in `automatic` mode should wait before a recording transitions from live to on-demand. `0` is recommended for most use cases and indicates the platform default should be used. default: 0 stream_live_input_response_collection: allOf: - $ref: '#/components/schemas/stream_api-response-common' - properties: result: type: object properties: liveInputs: type: array items: $ref: '#/components/schemas/stream_live_input_object_without_url' range: type: integer description: The total number of remaining live inputs based on cursor position. example: 1000 total: type: integer description: The total number of live inputs that match the provided filters. example: 35586 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: type: string description: The connection status of a live input. enum: - null - connected - reconnected - reconnecting - client_disconnect - ttl_exceeded - failed_to_connect - failed_to_reconnect - new_configuration_accepted nullable: true stream_liveInput: type: string description: The live input ID used to upload a video with Stream Live. example: fc0a8dc887b16759bfd9ad922230a014 maxLength: 32 stream_maxDurationSeconds: type: integer description: The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of `-1` means the value is unknown. minimum: 1 maximum: 21600 stream_media_metadata: type: object description: A user modifiable key-value store used to reference other systems of record for managing videos. example: name: video12345.mp4 stream_media_state: type: string description: Specifies the processing status for all quality levels for a video. enum: - pendingupload - downloading - queued - inprogress - ready - error example: inprogress 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: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string stream_modified: type: string format: date-time description: The date and time the media item was last modified. example: "2014-01-02T02:20:00Z" stream_name: type: string description: A short description of the watermark profile. default: "" example: Marketing Videos stream_notificationUrl: type: string format: uri description: The URL where webhooks will be sent. example: https://example.com stream_oneTimeUploadExpiry: type: string format: date-time description: The date and time when the video upload URL is no longer valid for direct user uploads. example: "2014-01-02T02:20:00Z" stream_opacity: type: number description: The translucency of the image. A value of `0.0` makes the image completely transparent, and `1.0` makes the image completely opaque. Note that if the image is already semi-transparent, setting this to `1.0` will not make the image completely opaque. default: 1 example: 0.75 minimum: 0 maximum: 1 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: type: boolean description: When enabled, live video streamed to the associated live input will be sent to the output URL. When disabled, live video will not be sent to the output URL, even when streaming to the associated live input. Use this to control precisely when you start and stop simulcasting to specific destinations like YouTube and Twitch. default: true example: true stream_output_identifier: type: string description: A unique identifier for the output. example: baea4d9c515887b80289d5c33cf01145 maxLength: 32 stream_output_response_collection: allOf: - $ref: '#/components/schemas/stream_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/stream_output' stream_output_response_single: allOf: - $ref: '#/components/schemas/stream_api-response-single' - properties: result: $ref: '#/components/schemas/stream_output' stream_output_streamKey: type: string description: The streamKey used to authenticate against an output's target. example: uzya-f19y-g2g9-a2ee-51j2 stream_output_url: type: string description: The URL an output uses to restream. example: rtmp://a.rtmp.youtube.com/live2 stream_padding: type: number description: The whitespace between the adjacent edges (determined by position) of the video and the image. `0.0` indicates no padding, and `1.0` indicates a fully padded video width or length, as determined by the algorithm. default: 0.05 example: 0.1 minimum: 0 maximum: 1 stream_pctComplete: type: string description: Indicates the size of the entire upload in bytes. The value must be a non-negative integer. minimum: 0 maximum: 100 stream_pem: type: string description: The signing key in PEM format. example: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcGdJQkFBS0NBUUVBMFRqd2pPaVpXbUo0M3ZmM1RvNERvWG1YV3RKR05HeVhmaHl0dExhQmdGMStFUVdRCkRLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMrbFkKUllveXJBR0Y0QVhoeTMyOWJIQ1AxSWxyQkIvQWtHZ25kTEFndW54WTByUmdjdk96aWF3NktKeEZuYzJVSzBXVQo4YjBwNEtLSEdwMUtMOWRrMFdUOGRWWXFiZVJpSmpDbFVFbWg4eXY5Q2xPVmFTNEt4aVg2eFRRNERadzZEYUpmCklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWitpeFdmY1QKRE1IOTJzR3ZvdzFET2p4TGlDTjF6SEsraDdiTG9YVGlMZ2M0a3dJREFRQUJBb0lCQVFEQ0lCclNJMTlteGNkdwoycExVaUdCR0N4T3NhVDVLbGhkYUpESG9ZdzUxbEVuTWNXVGUyY01NTkdqaXdsN1NyOFlQMkxmcERaOFJtNzdMCk5rT2tGMnk3M3l5YUhFeEw5S1FyMys0Um9ubCtqTlp2YnV0QVdxSDVodEE0dER4MUd3NE85OEg4YWlTcGh1eWQKRUliTGRrQm54OGlDZUdxbFBnbHZ6Q1dLV0xVZlhGbXplMkF5UjBzaWMyYXZRLzZyclYwb3pDdGQ1T0Vod093agphaCs3N1dZV1l0bkEraDhXZVZreWcvdG44UTJJOXo5ZVJYdlZxR2sxMDZLcWRtZFdiU2tIZzA4cFRUSGhVM2paCnMvZGNjdEdOMWFFanlUQWY0QzdHT2lrcUd1MGFTaW1aeDFOM2RWQzBobngySjJtdlhNQ0VtZ0g3TjVnZUxWUFAKOWdkQjdBQkJBb0dCQU5sT2hGQVhaTHV6Y0Ftczl1K3AxM05STWRFOHpIK2ZFaFBrbk9zZ21Xb3VqUzkxQTRtZgpuK01oN3d5bTZoVU1DbDk2WUNMNGtPM0RUMmlYWlRqTXZuMHBoVEx1MXNYcGxWNDJuamRnZGd3cFBEM0FnL1Y5ClVvV2hxdVhoa1I3RFpsUGg5Nmk1aEE0M1BvbTVPQm9BektJbEcrT3ZKUkhhZEVveC9jSmZScFd2QW9HQkFQWjUKNnNmWDdESElCNEtBczRmMWRuNGZJUkMweUF2WVdCL1R3UzZHUWVoNFRFbDVuSkQwWk9ZRVdUbVVBK3pPanZTNApuM09tZ2xNQTU5SGd1ZW13QXVRcEtwWFBOcFUvTERJaThtNnpmTUpvL3E5M0NOQlFQZngzZGh4ZVh4OXE2Mzg3Cm84QWxkOE42RGs4TThjRis3SlNaeUVJODJzLzdpdGRseXA2bFdLaGRBb0dCQUtnU0VrUGYxQWxZdjA2OGVFRGwKRzc0VkRuTEdrMlFobzltKzk1N2psOFNJUEtwMzFrU2JNUTU3TUdpWXNIT1czRzc4TjE3VTRVTUR6R2NZc1RFOQpLaGVrQldGZldMMjU2OHp5Y1d4akx1bzQrbDdJaDBkWHBudTBqbms5L1AvT0lWYS9iczBRcnhKUHFBN2RNb2JxCkYxdFJXRURCTmVxWkMxaFhVZTBEdzVRQkFvR0JBSjdBQ2NNcnhKcVBycDZVakkyK1FOS2M5Q3dSZEdPRXRjWFMKR3JQL2owWE83YnZKVTFsZHYvc1N3L0U4NzRZL3lIM0F5QnF5SFhDZXZiRkZZQmt1MzczYThlM0pwK3RhNC9scQozdUVFUkEvbmxscW5mWXJHbEJZZlQzaVlKQVpWVkZiL3I4bWJtRmJVTDVFazBqV0JyWmxNcjFwU1hkRGx3QmhhCkhMWXY0em1WQW9HQkFLQmw0cFNnbkNSTEJMUU9jWjhXQmhRSjAwZDZieFNrTGNpZ0xUNFJvY3RwNTY1SHJPMDAKSVFLdElTaEg1a2s3SVRHdUYvOERXZEN2djBMYnhvZVBJc2NFaStTaXk5WDZwWENPaS8xa2FyYVU5U3BpZ3czago3YjVlUVV0UlovTkIycVJwc3EzMEdCUENqanhudEVmK2lqelhUS0xNRndyUDhBMTlQNzRONGVTMAotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo= stream_playback: type: object properties: dash: type: string description: DASH Media Presentation Description for the video. example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd hls: type: string description: The HLS manifest for the video. example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8 stream_playback_rtmps: type: object 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' stream_playback_rtmps_stream_key: type: string description: The secret key to use for playback via RTMPS. example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada stream_playback_rtmps_url: type: string description: The URL used to play live video over RTMPS. example: rtmps://live.cloudflare.com:443/live/ stream_playback_srt: type: object 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' stream_playback_srt_stream_id: type: string description: The identifier of the live input to use for playback via SRT. example: f256e6ea9341d51eea64c9454659e576 stream_playback_srt_stream_passphrase: type: string description: The secret key to use for playback via SRT. example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada stream_playback_srt_url: type: string description: The URL used to play live video over SRT. example: rtmps://live.cloudflare.com:443/live/ stream_playback_webrtc: type: object description: Details for playback from a live input using WebRTC. properties: url: $ref: '#/components/schemas/stream_playback_webrtc_url' stream_playback_webrtc_url: type: string description: The URL used to play live video over WebRTC. example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/play stream_position: type: string description: 'The location of the image. Valid positions are: `upperRight`, `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the `padding` parameter.' default: upperRight example: center stream_preview: type: string format: uri description: The video's preview page URI. This field is omitted until encoding is complete. example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch stream_readyToStream: type: boolean 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 stream_readyToStreamAt: type: string format: date-time 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" stream_requireSignedURLs: type: boolean description: Indicates whether the video can be a accessed using the UID. When set to `true`, a signed token must be generated with a signing key to view the video. default: false example: true stream_scale: type: number description: The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. `0.0` indicates no scaling (use the size of the image as-is), and `1.0 `fills the entire video. default: 0.15 example: 0.1 minimum: 0 maximum: 1 stream_scheduledDeletion: type: string format: date-time 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" stream_schemas-identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 stream_search: type: string description: Searches over the `name` key in the `meta` field. This field can be set with or after the upload request. example: puppy.mp4 stream_signed_token_request: type: object properties: accessRules: type: array description: The optional list of access rule constraints on the token. Access can be blocked or allowed based on an IP, IP range, or by country. Access rules are evaluated from first to last. If a rule matches, the associated action is applied and no further rules are evaluated. example: - action: block country: - US - MX type: ip.geoip.country - action: allow ip: - 93.184.216.0/24 - 2400:cb00::/32 type: ip.src - action: block type: any items: $ref: '#/components/schemas/stream_accessRules' downloadable: type: boolean description: The optional boolean value that enables using signed tokens to access MP4 download links for a video. default: false exp: type: integer description: The optional unix epoch timestamp that specficies the time after a token is not accepted. The maximum time specification is 24 hours from issuing time. If this field is not set, the default is one hour after issuing. id: type: string description: The optional ID of a Stream signing key. If present, the `pem` field is also required. example: ab0d4ef71g4425f8dcba9041231813000 nbf: type: integer description: The optional unix epoch timestamp that specifies the time before a the token is not accepted. If this field is not set, the default is one hour before issuing. pem: type: string description: The optional base64 encoded private key in PEM format associated with a Stream signing key. If present, the `id` field is also required. example: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcEFJQkFBS0NBUUVBc284dnBvOFpEWXRkOUgzbWlPaW1qYXAzVXlVM0oyZ3kwTUYvN1R4blJuRnkwRHpDCkxqUk9naFZsQ0hPQmxsd3NVaE9GU0lyYnN4K05tUTdBeS90TFpXSGxuVGF3UWJ5WGZGOStJeDhVSnNlSHBGV1oKNVF5Z1JYd2liSjh1MVVsZ2xlcmZHMkpueldjVXpZTzEySktZN3doSkw1ajROMWgxZFJNUXQ5Q1pkZFlCQWRzOQpCdk02cjRFMDcxQkhQekhWeDMrUTI1VWtubGdUNXIwS3FiM1E1Y0dlTlBXY1JreW1ybkJEWWR0OXR4eFFMb1dPCllzNXdsMnVYWFVYL0VGcDMwajU0Nmp6czllWExLYlNDbjJjTDZFVE96Y2x3aG9DRGx2a2VQT05rUE9LMDVKNUMKTm1TdFdhMG9hV1VGRzM0MFl3cVVrWGt4OU9tNndXd1JldU1uU1FJREFRQUJBb0lCQUFJOHo1ck5kOEdtOGJBMgo1S3pxQjI1R2lOVENwbUNJeW53NXRJWHZTQmNHcEdydUcvdlN2WG9kVlFVSVY0TWdHQkVXUEFrVzdsNWVBcHI4CnA1ZFd5SkRXYTNkdklFSE9vSEpYU3dBYksxZzZEMTNVa2NkZ1EyRGpoNVhuWDhHZCtBY2c2SmRTQWgxOWtYSHEKMk54RUtBVDB6Ri83a1g2MkRkREFBcWxmQkpGSXJodVIvZUdEVWh4L2piTTRhQ2JCcFdiM0pnRE9OYm5tS1ZoMwpxS2ZwZmRZZENZU1lzWUxrNTlxRDF2VFNwUVFUQ0VadW9VKzNzRVNhdkJzaUs1bU0vTzY5ZkRMRXNURG1MeTVQCmhEK3BMQXI0SlhNNjFwRGVBS0l3cUVqWWJybXlDRHRXTUdJNnZzZ0E1eXQzUUJaME9vV2w5QUkwdWxoZ3p4dXQKZ2ZFNTRRRUNnWUVBN0F3a0lhVEEzYmQ4Nk9jSVZnNFlrWGk1cm5aNDdsM1k4V24zcjIzUmVISXhLdkllRUtSbgp5bUlFNDFtRVBBSmlGWFpLK1VPTXdkeS9EcnFJUithT1JiT2NiV01jWUg2QzgvbG1wdVJFaXE3SW1Ub3VWcnA4CnlnUkprMWprVDA4cTIvNmg4eTBEdjJqMitsaHFXNzRNOUt0cmwxcTRlWmZRUFREL01tR1NnTWtDZ1lFQXdhY04KaSttN1p6dnJtL3NuekF2VlZ5SEtwZHVUUjNERk1naC9maC9tZ0ZHZ1RwZWtUOVV5b3FleGNYQXdwMVlhL01iQQoyNTVJVDZRbXZZTm5yNXp6Wmxic2tMV0hsYllvbWhmWnVXTHhXR3hRaEFORWdaMFVVdUVTRGMvbWx2UXZHbEtSCkZoaGhBUWlVSmdDamhPaHk1SlBiNGFldGRKd0UxK09lVWRFaE1vRUNnWUVBNG8yZ25CM1o4ck5xa3NzemlBek4KYmNuMlJVbDJOaW9pejBwS3JMaDFaT29NNE5BekpQdjJsaHRQMzdtS0htS1hLMHczRjFqTEgwSTBxZmxFVmVZbQpSU1huakdHazJjUnpBYUVzOGgrQzNheDE0Z01pZUtGU3BqNUpNOEFNbVVZOXQ1cUVhN2FYc3o0V1ZoOUlMYmVTCkRiNzlhKzVwd21LQVBrcnBsTHhyZFdrQ2dZQlNNSHVBWVdBbmJYZ1BDS2FZWklGVWJNUWNacmY0ZnpWQ2lmYksKYWZHampvRlNPZXdEOGdGK3BWdWJRTGwxbkFieU44ek1xVDRaaHhybUhpcFlqMjJDaHV2NmN3RXJtbGRiSnpwQwpBMnRaVXdkTk1ESFlMUG5lUHlZeGRJWnlsUXFVeW14SGkydElUQUxNcWtLOGV3ZWdXZHpkeGhQSlJScU5JazhrCmZIVHhnUUtCZ1FEUFc2UXIxY3F3QjNUdnVWdWR4WGRqUTdIcDFodXhrNEVWaEFJZllKNFhSTW1NUE5YS28wdHUKdUt6LzE0QW14R0dvSWJxYVc1bDMzeFNteUxhem84clNUN0tSTjVKME9JSHcrZkR5SFgxdHpVSjZCTldDcEFTcwpjbWdNK0htSzVON0w2bkNaZFJQY2IwU1hGaVRQUGhCUG1PVWFDUnpER0ZMK2JYM1VwajJKbWc9PQotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo= stream_signed_token_response: allOf: - $ref: '#/components/schemas/stream_api-response-single' - properties: result: properties: token: type: string description: The signed token used with the signed URLs feature. example: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIn0.eyJzdWIiOiJlYTk1MTMyYzE1NzMyNDEyZDIyYzE0NzZmYTgzZjI3YSIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIiwiZXhwIjoiMTUzNzQ2MDM2NSIsIm5iZiI6IjE1Mzc0NTMxNjUifQ.OZhqOARADn1iubK6GKcn25hN3nU-hCFF5q9w2C4yup0C4diG7aMIowiRpP-eDod8dbAJubsiFuTKrqPcmyCKWYsiv0TQueukqbQlF7HCO1TV-oF6El5-7ldJ46eD-ZQ0XgcIYEKrQOYFF8iDQbqPm3REWd6BnjKZdeVrLzuRaiSnZ9qqFpGu5dfxIY9-nZKDubJHqCr3Imtb211VIG_b9MdtO92JjvkDS-rxT_pkEfTZSafl1OU-98A7KBGtPSJHz2dHORIrUiTA6on4eIXTj9aFhGiir4rSn-rn0OjPRTtJMWIDMoQyE_fwrSYzB7MPuzL2t82BWaEbHZTfixBm5A stream_signing_key_created: type: string format: date-time description: The date and time a signing key was created. example: "2014-01-02T02:20:00Z" stream_size: type: number description: The size of the media item in bytes. example: 4.190963e+06 stream_start: type: string format: date-time description: Lists videos created after the specified date. example: "2014-01-02T02:20:00Z" stream_start_time_seconds: type: integer description: Specifies the start time for the video clip in seconds. stream_storage_use_response: allOf: - $ref: '#/components/schemas/stream_api-response-single' - properties: result: properties: creator: $ref: '#/components/schemas/stream_creator' totalStorageMinutes: type: integer description: The total minutes of video content stored in the account. totalStorageMinutesLimit: type: integer description: The storage capacity alloted for the account. videoCount: type: integer description: The total count of videos associated with the account. stream_thumbnail_url: type: string format: uri description: The media item's thumbnail URI. This field is omitted until encoding is complete. example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg stream_thumbnailTimestampPct: type: number description: The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video. default: 0 example: 0.529241 minimum: 0 maximum: 1 stream_tus_resumable: type: string description: |- Specifies the TUS protocol version. This value must be included in every upload request. Notes: The only supported version of TUS protocol is 1.0.0. enum: - 1.0.0 example: 1.0.0 stream_type: type: string description: Specifies whether the video is `vod` or `live`. example: live 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: required: - enabled properties: enabled: $ref: '#/components/schemas/stream_output_enabled' stream_upload_length: type: integer description: Indicates the size of the entire upload in bytes. The value must be a non-negative integer. minimum: 0 stream_upload_metadata: type: string 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= stream_uploaded: type: string format: date-time description: The date and time the media item was uploaded. example: "2014-01-02T02:20:00Z" stream_video_copy_request: required: - url 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: type: string format: uri description: A video's URL. The server must be publicly routable and support `HTTP HEAD` requests and `HTTP GET` range requests. The server should respond to `HTTP HEAD` requests with a `content-range` header that includes the size of the file. example: https://example.com/myvideo.mp4 watermark: $ref: '#/components/schemas/stream_watermark_at_upload' stream_video_response_collection: allOf: - $ref: '#/components/schemas/stream_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/stream_videos' - properties: range: type: integer description: The total number of remaining videos based on cursor position. example: 1000 total: type: integer description: The total number of videos that match the provided filters. example: 35586 stream_video_response_single: allOf: - $ref: '#/components/schemas/stream_api-response-single' - properties: result: $ref: '#/components/schemas/stream_videos' stream_video_update: type: object 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' stream_videoClipStandard: type: object required: - clippedFromVideoUID - startTimeSeconds - endTimeSeconds 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' stream_videos: type: object 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' stream_watermark_at_upload: type: object properties: uid: type: string description: The unique identifier for the watermark profile. example: ea95132c15732412d22c1476fa83f27a maxLength: 32 stream_watermark_basic_upload: type: object required: - file properties: file: type: string description: The image file to upload. example: '@/Users/rchen/Downloads/watermark.png' name: $ref: '#/components/schemas/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' stream_watermark_created: type: string format: date-time description: The date and a time a watermark profile was created. example: "2014-01-02T02:20:00Z" stream_watermark_identifier: type: string description: The unique identifier for a watermark profile. example: ea95132c15732412d22c1476fa83f27a maxLength: 32 stream_watermark_response_collection: allOf: - $ref: '#/components/schemas/stream_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/stream_watermarks' stream_watermark_response_single: allOf: - $ref: '#/components/schemas/stream_api-response-single' - properties: result: $ref: '#/components/schemas/stream_watermarks' stream_watermark_size: type: number description: The size of the image in bytes. example: 29472 stream_watermarkAtUpload: type: object properties: uid: type: string description: The unique identifier for the watermark profile. example: ea95132c15732412d22c1476fa83f27a maxLength: 32 stream_watermarks: type: object 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' stream_webhook_request: required: - notificationUrl properties: notificationUrl: $ref: '#/components/schemas/stream_notificationUrl' stream_webhook_response_single: allOf: - $ref: '#/components/schemas/stream_api-response-single' - properties: result: type: object stream_width: type: integer description: The width of the image in pixels. teams-devices_allow_mode_switch: type: boolean description: Whether to allow the user to switch WARP between modes. example: true teams-devices_allow_updates: type: boolean description: Whether to receive update notifications when a new version of the client is available. example: true teams-devices_allowed_to_leave: type: boolean description: Whether to allow devices to leave the organization. example: true teams-devices_api-response-collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-common' - properties: result: type: array nullable: true items: {} 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: type: array nullable: true items: {} type: object teams-devices_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/teams-devices_messages' messages: $ref: '#/components/schemas/teams-devices_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful. enum: - true example: true teams-devices_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false teams-devices_api-response-single: allOf: - $ref: '#/components/schemas/teams-devices_api-response-common' - properties: result: anyOf: - type: object - type: string type: object nullable: true type: object teams-devices_application_input_request: type: object title: Application required: - path - operating_system properties: operating_system: type: string description: Operating system enum: - windows - linux - mac example: mac path: type: string description: Path for the application. example: /bin/cat sha256: type: string description: SHA-256. example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c thumbprint: type: string description: Signing certificate thumbprint. example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e teams-devices_auto_connect: type: number description: The amount of time in minutes to reconnect after having been disabled. example: 0 teams-devices_captive_portal: type: number description: Turn on the captive portal after the specified amount of time. example: 180 teams-devices_carbonblack_input_request: type: object title: Carbonblack required: - path - operating_system properties: operating_system: type: string description: Operating system enum: - windows - linux - mac example: mac path: type: string description: File path. example: /bin/cat sha256: type: string description: SHA-256. example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c thumbprint: type: string description: Signing certificate thumbprint. example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e teams-devices_checkDisks: type: array description: List of volume names to be checked for encryption. example: - C - D - G items: type: string teams-devices_client_certificate_input_request: type: object title: Client Certificate required: - certificate_id - cn properties: certificate_id: type: string description: UUID of Cloudflare managed certificate. example: b14ddcc4-bcd2-4df4-bd4f-eb27d5a50c30 maxLength: 36 cn: type: string description: Common Name that is protected by the certificate example: example.com teams-devices_components-schemas-name: type: string description: The name of the device posture integration. example: My Workspace One Integration teams-devices_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/teams-devices_device-managed-networks' 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: type: string description: The type of device managed network. enum: - tls example: tls teams-devices_components-schemas-uuid: type: string description: UUID example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 readOnly: true maxLength: 36 teams-devices_config_request: 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' type: object description: The configuration object containing third-party integration information. example: api_url: https://as123.awmdm.com/API auth_url: https://na.uemauth.vmwservices.com/connect/token client_id: example client id client_secret: example client secret teams-devices_config_response: oneOf: - $ref: '#/components/schemas/teams-devices_workspace_one_config_response' type: object description: The configuration object containing third-party integration information. example: api_url: https://as123.awmdm.com/API auth_url: https://na.uemauth.vmwservices.com/connect/token client_id: example client id teams-devices_created: type: string format: date-time description: When the device was created. example: "2017-06-14T00:00:00Z" teams-devices_crowdstrike_config_request: type: object title: Crowdstrike Config required: - api_url - customer_id - client_id - client_secret properties: api_url: type: string description: The Crowdstrike API URL. example: https://api.us-2.crowdstrike.com client_id: type: string description: The Crowdstrike client ID. example: example client id client_secret: type: string description: The Crowdstrike client secret. example: example client secret customer_id: type: string description: The Crowdstrike customer ID. example: example customer id teams-devices_crowdstrike_input_request: type: object title: Crowdstrike S2S Input required: - connection_id properties: connection_id: type: string description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f last_seen: type: string description: For more details on last seen, please refer to the Crowdstrike documentation. example: 15d3h20m4s operator: type: string description: Operator enum: - < - <= - '>' - '>=' - == example: '>' os: type: string description: Os Version example: 13.3.0 overall: type: string description: overall example: 90 sensor_config: type: string description: SensorConfig example: 90 state: type: string description: For more details on state, please refer to the Crowdstrike documentation. enum: - online - offline - unknown example: online version: type: string description: Version example: 13.3.0 versionOperator: type: string description: Version Operator enum: - < - <= - '>' - '>=' - == example: '>' teams-devices_default: type: boolean description: Whether the policy is the default policy for an account. example: false teams-devices_default_device_settings_policy: type: object 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: type: boolean description: Whether the policy will be applied to matching devices. example: true disable_auto_fallback: $ref: '#/components/schemas/teams-devices_disable_auto_fallback' enabled: type: boolean description: Whether the policy will be applied to matching devices. example: true 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' teams-devices_default_device_settings_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: $ref: '#/components/schemas/teams-devices_default_device_settings_policy' teams-devices_deleted: type: boolean description: True if the device was deleted. example: true teams-devices_description: type: string description: The description of the device posture rule. example: The rule for admin serial numbers teams-devices_device-dex-test-schemas-data: type: object 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: type: string description: The desired endpoint to test. example: https://dash.cloudflare.com kind: type: string description: The type of test. example: http method: type: string description: The HTTP request method type. example: GET teams-devices_device-dex-test-schemas-description: type: string description: Additional details about the test. example: Checks the dash endpoint every 30 minutes teams-devices_device-dex-test-schemas-enabled: type: boolean description: Determines whether or not the test is active. example: true teams-devices_device-dex-test-schemas-http: type: object required: - name - interval - enabled - data 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 teams-devices_device-dex-test-schemas-interval: type: string description: How often the test will run. example: 30m teams-devices_device-dex-test-schemas-name: type: string description: The name of the DEX test. Must be unique. example: HTTP dash health check teams-devices_device-dex-test-target-policies: type: array description: Device settings profiles targeted by this test items: $ref: '#/components/schemas/teams-devices_dex_target_policy' teams-devices_device-managed-networks: type: object 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' teams-devices_device-managed-networks_components-schemas-name: type: string description: The name of the device managed network. This name must be unique. example: managed-network-1 teams-devices_device-posture-integrations: type: object 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' teams-devices_device-posture-rules: type: object 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' teams-devices_device_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-single' - properties: result: type: object teams-devices_device_settings_policy: type: object 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: type: boolean description: Whether the policy will be applied to matching devices. example: true 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: type: string description: The name of the device settings profile. example: Allow Developers maxLength: 100 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: type: array items: $ref: '#/components/schemas/teams-devices_target_dex_test' teams-devices_device_settings_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - 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: type: array items: $ref: '#/components/schemas/teams-devices_device_settings_policy' teams-devices_devices: type: object 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' teams-devices_devices_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/teams-devices_devices' teams-devices_dex-response_collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection-common' - properties: result: type: array items: $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http' 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: type: object properties: default: type: boolean description: Whether the profile is the account default id: type: string description: The id of the device settings profile name: type: string description: The name of the device settings profile teams-devices_disable_auto_fallback: type: boolean description: If the `dns_server` field of a fallback domain is not present, the client will fall back to a best guess of the default/system DNS resolvers unless this policy option is set to `true`. example: true teams-devices_disable_for_time: type: object properties: "1": description: Override code that is valid for 1 hour. example: "9106681" "3": description: Override code that is valid for 3 hours. example: "5356247" "6": description: Override code that is valid for 6 hours. example: "9478972" "12": description: Override code that is valid for 12 hour2. example: "3424359" "24": description: Override code that is valid for 24 hour.2. example: "2887634" teams-devices_disk_encryption_input_request: type: object title: Disk Encryption properties: checkDisks: $ref: '#/components/schemas/teams-devices_checkDisks' requireAll: $ref: '#/components/schemas/teams-devices_requireAll' teams-devices_domain_joined_input_request: type: object title: Domain Joined required: - operating_system properties: domain: type: string description: Domain example: example.com operating_system: type: string description: Operating System enum: - windows example: windows teams-devices_email: type: string description: The contact email address of the user. example: user@example.com maxLength: 90 teams-devices_exclude: type: array items: $ref: '#/components/schemas/teams-devices_split_tunnel' teams-devices_exclude_office_ips: type: boolean description: Whether to add Microsoft IPs to Split Tunnel exclusions. example: true teams-devices_expiration: type: string description: Sets the expiration time for a posture check result. If empty, the result remains valid until it is overwritten by new data from the WARP client. example: 1h teams-devices_fallback_domain: type: object required: - suffix properties: description: type: string description: A description of the fallback domain, displayed in the client UI. example: Domain bypass for local development maxLength: 100 dns_server: type: array description: A list of IP addresses to handle domain resolution. items: {} suffix: type: string description: The domain suffix to match when resolving locally. example: example.com teams-devices_fallback_domain_response_collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/teams-devices_fallback_domain' teams-devices_fallback_domains: type: array items: $ref: '#/components/schemas/teams-devices_fallback_domain' teams-devices_file_input_request: type: object title: File Check required: - path - operating_system properties: exists: type: boolean description: Whether or not file exists example: true operating_system: type: string description: Operating system enum: - windows - linux - mac example: mac path: type: string description: File path. example: /bin/cat sha256: type: string description: SHA-256. example: https://api.us-2.crowdstrike.com thumbprint: type: string description: Signing certificate thumbprint. example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e teams-devices_firewall_input_request: type: object title: Firewall required: - operating_system - enabled properties: enabled: type: boolean description: Enabled example: true operating_system: type: string description: Operating System enum: - windows - mac example: windows teams-devices_gateway_unique_id: type: string example: 699d98642c564d2e855e9661899b7252 teams-devices_id_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/teams-devices_uuid' teams-devices_identifier: example: 699d98642c564d2e855e9661899b7252 teams-devices_include: type: array items: $ref: '#/components/schemas/teams-devices_split_tunnel_include' teams-devices_input: 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_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' type: object description: The value to be checked against. example: operating_system: linux path: /bin/cat thumbprint: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e teams-devices_interval: type: string description: The interval between each posture check with the third-party API. Use `m` for minutes (e.g. `5m`) and `h` for hours (e.g. `12h`). example: 10m teams-devices_intune_config_request: type: object title: Intune Config required: - customer_id - client_id - client_secret properties: client_id: type: string description: The Intune client ID. example: example client id client_secret: type: string description: The Intune client secret. example: example client secret customer_id: type: string description: The Intune customer ID. example: example customer id teams-devices_intune_input_request: type: object title: Intune S2S Input required: - connection_id - compliance_status properties: compliance_status: type: string description: Compliance Status enum: - compliant - noncompliant - unknown - notapplicable - ingraceperiod - error example: compliant connection_id: type: string description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f teams-devices_ip: type: string description: IPv4 or IPv6 address. example: 1.1.1.1 teams-devices_key: type: string description: The device's public key. example: yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc= teams-devices_kolide_config_request: type: object title: Kolide Config required: - client_id - client_secret properties: client_id: type: string description: The Kolide client ID. example: example client id client_secret: type: string description: The Kolide client secret. example: example client secret teams-devices_kolide_input_request: type: object title: Kolide S2S Input required: - connection_id - countOperator - issue_count properties: connection_id: type: string description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f countOperator: type: string description: Count Operator enum: - < - <= - '>' - '>=' - == example: '>' issue_count: type: string description: The Number of Issues. example: 1 teams-devices_lan_allow_minutes: type: number 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 teams-devices_lan_allow_subnet_size: type: number 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 teams-devices_last_seen: type: string format: date-time description: When the device last connected to Cloudflare services. example: "2017-06-14T00:00:00Z" teams-devices_mac_address: type: string description: The device mac address. example: 00-00-5E-00-53-00 teams-devices_manufacturer: type: string description: The device manufacturer name. example: My phone corp teams-devices_match: type: array description: The conditions that the client must match to run the rule. items: $ref: '#/components/schemas/teams-devices_match_item' teams-devices_match_item: type: object properties: platform: $ref: '#/components/schemas/teams-devices_platform' teams-devices_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string teams-devices_model: type: string description: The device model name. example: MyPhone(pro-X) teams-devices_name: type: string description: The name of the device posture rule. example: Admin Serial Numbers teams-devices_os_distro_name: type: string description: The Linux distro name. example: ubuntu teams-devices_os_distro_revision: type: string description: The Linux distro revision. example: 1.0.0 teams-devices_os_version: type: string description: The operating system version. example: 10.0.0 teams-devices_os_version_extra: type: string description: The operating system version extra parameter. example: (a) teams-devices_os_version_input_request: type: object title: OS Version required: - operating_system - version - operator properties: operating_system: type: string description: Operating System enum: - windows example: windows operator: type: string description: Operator enum: - < - <= - '>' - '>=' - == example: 13.3.0 os_distro_name: type: string description: Operating System Distribution Name (linux only) example: ubuntu os_distro_revision: type: string description: Version of OS Distribution (linux only) example: 11.3.1 os_version_extra: type: string 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 version: type: string description: Version of OS example: 13.3.0 teams-devices_override_codes_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: type: object properties: disable_for_time: $ref: '#/components/schemas/teams-devices_disable_for_time' teams-devices_platform: type: string enum: - windows - mac - linux - android - ios example: windows teams-devices_precedence: type: number description: The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field. example: 100 teams-devices_requireAll: type: boolean description: Whether to check all disks for encryption. example: true teams-devices_response_collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/teams-devices_device-posture-rules' teams-devices_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 teams-devices_revoke_devices_request: type: array description: A list of device ids to revoke. maxLength: 200 items: $ref: '#/components/schemas/teams-devices_schemas-uuid' teams-devices_revoked_at: type: string format: date-time description: When the device was revoked. example: "2017-06-14T00:00:00Z" teams-devices_schedule: type: string description: 'Polling frequency for the WARP client posture check. Default: `5m` (poll every five minutes). Minimum: `1m`.' example: 1h teams-devices_schemas-config_request: oneOf: - $ref: '#/components/schemas/teams-devices_tls_config_request' type: object description: The configuration object containing information for the WARP client to detect the managed network. example: sha256: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c tls_sockaddr: foo.bar:1234 teams-devices_schemas-config_response: oneOf: - $ref: '#/components/schemas/teams-devices_tls_config_response' type: object description: The configuration object containing information for the WARP client to detect the managed network. example: sha256: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c tls_sockaddr: foo.bar:1234 teams-devices_schemas-description: type: string description: A description of the policy. example: Policy for test teams. maxLength: 500 teams-devices_schemas-id_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-single' - properties: result: type: object nullable: true teams-devices_schemas-match: type: string description: The wirefilter expression to match devices. example: user.identity == "test@cloudflare.com" maxLength: 500 teams-devices_schemas-name: type: string description: The device name. example: My mobile device teams-devices_schemas-response_collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/teams-devices_device-posture-integrations' 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: type: string description: The type of device posture integration. enum: - workspace_one - crowdstrike_s2s - uptycs - intune - kolide - tanium - sentinelone_s2s example: workspace_one teams-devices_schemas-uuid: type: string description: Device ID. example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 maxLength: 36 teams-devices_sentinelone_input_request: type: object title: Sentinelone required: - path - operating_system properties: operating_system: type: string description: Operating system enum: - windows - linux - mac example: mac path: type: string description: File path. example: /bin/cat sha256: type: string description: SHA-256. example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c thumbprint: type: string description: Signing certificate thumbprint. example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e teams-devices_sentinelone_s2s_config_request: type: object title: SentinelOne S2S Config required: - api_url - client_secret properties: api_url: type: string description: The SentinelOne S2S API URL. example: https://example.sentinelone.net client_secret: type: string description: The SentinelOne S2S client secret. example: example client secret teams-devices_sentinelone_s2s_input_request: type: object title: SentinelOne S2S Input required: - connection_id properties: active_threats: type: number description: The Number of active threats. example: 1 connection_id: type: string description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f infected: type: boolean description: Whether device is infected. example: true is_active: type: boolean description: Whether device is active. example: true network_status: type: string description: Network status of device. enum: - connected - disconnected - disconnecting - connecting example: connected operator: type: string description: operator enum: - < - <= - '>' - '>=' - == example: '>' teams-devices_serial_number: type: string description: The device serial number. example: EXAMPLEHMD6R teams-devices_service_mode_v2: type: object properties: mode: type: string description: The mode to run the WARP client under. example: proxy port: type: number description: The port number when used with proxy mode. example: 3000 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: type: object required: - address - description properties: address: type: string description: The address in CIDR format to exclude from the tunnel. If `address` is present, `host` must not be present. example: 192.0.2.0/24 description: type: string description: A description of the Split Tunnel item, displayed in the client UI. example: Exclude testing domains from the tunnel maxLength: 100 host: type: string description: The domain name to exclude from the tunnel. If `host` is present, `address` must not be present. example: '*.example.com' teams-devices_split_tunnel_include: type: object required: - address - description properties: address: type: string description: The address in CIDR format to include in the tunnel. If address is present, host must not be present. example: 192.0.2.0/24 description: type: string description: A description of the split tunnel item, displayed in the client UI. example: Include testing domains from the tunnel maxLength: 100 host: type: string description: The domain name to include in the tunnel. If host is present, address must not be present. example: '*.example.com' teams-devices_split_tunnel_include_response_collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/teams-devices_split_tunnel_include' teams-devices_split_tunnel_response_collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/teams-devices_split_tunnel' teams-devices_support_url: type: string description: The URL to launch when the Send Feedback button is clicked. example: https://1.1.1.1/help teams-devices_switch_locked: type: boolean description: Whether to allow the user to turn off the WARP switch and disconnect the client. example: true teams-devices_tanium_config_request: type: object title: Tanium Config required: - api_url - client_secret properties: access_client_id: type: string description: If present, this id will be passed in the `CF-Access-Client-ID` header when hitting the `api_url` example: 88bf3b6d86161464f6509f7219099e57.access access_client_secret: type: string description: If present, this secret will be passed in the `CF-Access-Client-Secret` header when hitting the `api_url` example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5 api_url: type: string description: The Tanium API URL. example: https://dummy-tanium-api.cloudflare.com/plugin/products/gateway/graphql client_secret: type: string description: The Tanium client secret. example: example client secret teams-devices_tanium_input_request: type: object title: Tanium S2S Input required: - connection_id properties: connection_id: type: string description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f eid_last_seen: type: string description: For more details on eid last seen, refer to the Tanium documentation. example: "2023-07-20T23:16:32Z" operator: type: string description: Operator to evaluate risk_level or eid_last_seen. enum: - < - <= - '>' - '>=' - == example: '>' risk_level: type: string description: For more details on risk level, refer to the Tanium documentation. enum: - low - medium - high - critical example: low scoreOperator: type: string description: Score Operator enum: - < - <= - '>' - '>=' - == example: '>' total_score: type: number description: For more details on total score, refer to the Tanium documentation. example: 1 teams-devices_target_dex_test: type: object properties: id: type: string description: The id of the DEX test targeting this policy name: type: string description: The name of the DEX test targeting this policy teams-devices_tls_config_request: type: object required: - tls_sockaddr properties: sha256: type: string 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 tls_sockaddr: type: string 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 teams-devices_tls_config_response: type: object description: The Managed Network TLS Config Response. required: - tls_sockaddr properties: sha256: type: string 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 tls_sockaddr: type: string 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 teams-devices_type: type: string description: The type of device posture rule. enum: - file - application - tanium - gateway - warp - disk_encryption - sentinelone - carbonblack - firewall - os_version - domain_joined - client_certificate - unique_client_id - kolide - tanium_s2s - crowdstrike_s2s - intune - workspace_one - sentinelone_s2s example: file teams-devices_unique_client_id_input_request: type: object title: Unique Client ID required: - operating_system - id properties: id: type: string description: List ID. example: da3de859-8f6e-47ea-a2b5-b2433858471f operating_system: type: string description: Operating System enum: - android - ios - chromeos example: android teams-devices_unrevoke_devices_request: type: array description: A list of device ids to unrevoke. maxLength: 200 items: $ref: '#/components/schemas/teams-devices_schemas-uuid' teams-devices_updated: type: string format: date-time description: When the device was updated. example: "2017-06-14T00:00:00Z" teams-devices_uptycs_config_request: type: object title: Uptycs Config required: - api_url - client_key - customer_id - client_secret properties: api_url: type: string description: The Uptycs API URL. example: rnd.uptycs.io client_key: type: string description: The Uptycs client secret. example: example client key client_secret: type: string description: The Uptycs client secret. example: example client secret customer_id: type: string description: The Uptycs customer ID. example: example customer id teams-devices_user: type: object properties: email: $ref: '#/components/schemas/teams-devices_email' id: $ref: '#/components/schemas/teams-devices_components-schemas-uuid' name: type: string description: The enrolled device user's name. example: John Appleseed teams-devices_uuid: type: string description: API UUID. example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 maxLength: 36 teams-devices_version: type: string description: The WARP client version. example: 1.0.0 teams-devices_workspace_one_config_request: type: object title: Workspace One Config required: - api_url - auth_url - client_id - client_secret properties: api_url: type: string description: The Workspace One API URL provided in the Workspace One Admin Dashboard. example: https://as123.awmdm.com/API auth_url: type: string description: The Workspace One Authorization URL depending on your region. example: https://na.uemauth.vmwservices.com/connect/token client_id: type: string description: The Workspace One client ID provided in the Workspace One Admin Dashboard. example: example client id client_secret: type: string description: The Workspace One client secret provided in the Workspace One Admin Dashboard. example: example client secret teams-devices_workspace_one_config_response: type: object description: The Workspace One Config Response. required: - api_url - auth_url - client_id properties: api_url: type: string description: The Workspace One API URL provided in the Workspace One Admin Dashboard. example: https://as123.awmdm.com/API auth_url: type: string description: The Workspace One Authorization URL depending on your region. example: https://na.uemauth.vmwservices.com/connect/token client_id: type: string description: The Workspace One client ID provided in the Workspace One Admin Dashboard. example: example client id teams-devices_workspace_one_input_request: type: object title: Workspace One S2S Input required: - connection_id - compliance_status properties: compliance_status: type: string description: Compliance Status enum: - compliant - noncompliant - unknown example: compliant connection_id: type: string description: Posture Integration ID. example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f teams-devices_zero-trust-account-device-settings: type: object properties: gateway_proxy_enabled: type: boolean description: Enable gateway proxy filtering on TCP. example: true gateway_udp_proxy_enabled: type: boolean description: Enable gateway proxy filtering on UDP. example: true root_certificate_installation_enabled: type: boolean description: Enable installation of cloudflare managed root certificate. example: true use_zt_virtual_ip: type: boolean description: Enable using CGNAT virtual IPv4. example: true 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' - type: object properties: result: type: object properties: certificate_authority: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_authority' cloudflare_branding: $ref: '#/components/schemas/tls-certificates-and-hostnames_cloudflare_branding' hosts: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hosts' id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' status: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate-packs_components-schemas-status' type: $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_type' validation_method: $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_method' validity_days: $ref: '#/components/schemas/tls-certificates-and-hostnames_validity_days' tls-certificates-and-hostnames_advanced_type: type: string description: Type of certificate pack. enum: - advanced example: advanced tls-certificates-and-hostnames_api-response-collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/tls-certificates-and-hostnames_result_info' type: object tls-certificates-and-hostnames_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/tls-certificates-and-hostnames_messages' messages: $ref: '#/components/schemas/tls-certificates-and-hostnames_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true tls-certificates-and-hostnames_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false tls-certificates-and-hostnames_api-response-single: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common' - properties: result: anyOf: - type: object - type: string type: object tls-certificates-and-hostnames_association_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_associationObject' 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: type: object required: - id - name - host - port - status - enabled - permissions - created_on - modified_on properties: created_on: type: string format: date-time description: When the Keyless SSL was created. example: "2014-01-01T05:20:00Z" readOnly: true enabled: $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled' host: $ref: '#/components/schemas/tls-certificates-and-hostnames_host' id: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-identifier' modified_on: type: string format: date-time description: When the Keyless SSL was last modified. example: "2014-01-01T05:20:00Z" readOnly: true name: $ref: '#/components/schemas/tls-certificates-and-hostnames_name' permissions: type: array description: Available permissions for the Keyless SSL for the current user requesting the item. example: - '#ssl:read' - '#ssl:edit' readOnly: true items: {} port: $ref: '#/components/schemas/tls-certificates-and-hostnames_port' status: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-status' tunnel: $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_tunnel' tls-certificates-and-hostnames_brand_check: type: boolean description: Certificate Authority is manually reviewing the order. example: false tls-certificates-and-hostnames_bundle_method: type: string description: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. enum: - ubiquitous - optimal - force default: ubiquitous example: ubiquitous tls-certificates-and-hostnames_ca: type: boolean description: Indicates whether the certificate is a CA or leaf certificate. example: true tls-certificates-and-hostnames_cert_id: type: string description: Certificate identifier tag. example: 2458ce5a-0c35-4c7f-82c7-8e9487d3ff60 maxLength: 36 tls-certificates-and-hostnames_cert_pack_uuid: type: string description: Certificate Pack UUID. example: a77f8bd7-3b47-46b4-a6f1-75cf98109948 tls-certificates-and-hostnames_certificate: type: string description: The zone's SSL certificate or certificate and the intermediate(s). example: | -----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1 CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5 0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2 izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4 9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2 2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq 2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY= -----END CERTIFICATE----- tls-certificates-and-hostnames_certificate-packs_components-schemas-status: type: string description: Status of certificate pack. enum: - initializing - pending_validation - deleted - pending_issuance - pending_deployment - pending_deletion - pending_expiration - expired - active - initializing_timed_out - validation_timed_out - issuance_timed_out - deployment_timed_out - deletion_timed_out - pending_cleanup - staging_deployment - staging_active - deactivating - inactive - backup_issued - holding_deployment example: initializing 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: type: string description: The Certificate Authority that will issue the certificate enum: - digicert - google - lets_encrypt example: google tls-certificates-and-hostnames_certificate_pack_quota_response: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single' - type: object properties: result: type: object properties: advanced: $ref: '#/components/schemas/tls-certificates-and-hostnames_quota' tls-certificates-and-hostnames_certificate_pack_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - properties: result: type: array items: type: object tls-certificates-and-hostnames_certificate_pack_response_single: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single' - type: object properties: result: type: object tls-certificates-and-hostnames_certificate_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom-certificate' tls-certificates-and-hostnames_certificate_response_id_only: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' tls-certificates-and-hostnames_certificate_response_single: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single' - properties: result: type: object tls-certificates-and-hostnames_certificate_response_single_id: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single' - properties: result: properties: id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' 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_status: type: string description: Current status of certificate. enum: - initializing - authorizing - active - expired - issuing - timing_out - pending_deployment example: active 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_schemas-updated_at' uploaded_on: $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on' tls-certificates-and-hostnames_certificates: type: object required: - hostnames - csr - requested_validity - request_type 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' tls-certificates-and-hostnames_client-certificates_components-schemas-certificate: type: string description: The Client Certificate PEM example: '-----BEGIN CERTIFICATE-----\nMIIDmDCCAoC...dhDDE\n-----END CERTIFICATE-----' readOnly: true tls-certificates-and-hostnames_client-certificates_components-schemas-certificate_authority: type: object description: Certificate Authority used to issue the Client Certificate properties: id: type: string example: 568b6b74-7b0c-4755-8840-4e3b8c24adeb name: type: string example: Cloudflare Managed CA for account 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_components-schemas-validity_days' tls-certificates-and-hostnames_client_certificate_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate' 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: type: boolean description: Whether or not to add Cloudflare Branding for the order. This will add sni.cloudflaressl.com as the Common Name if set true. example: false tls-certificates-and-hostnames_common_name: type: string description: Common Name of the Client Certificate example: Cloudflare readOnly: true tls-certificates-and-hostnames_components-schemas-certificate: type: string description: The Origin CA certificate. Will be newline-encoded. example: |- -----BEGIN CERTIFICATE----- MIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV BAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln aUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG 9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo wp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c 1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI WDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ wIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR BPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ KoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D hJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY Q4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/ ZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn 29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2 97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w= -----END CERTIFICATE----- readOnly: true tls-certificates-and-hostnames_components-schemas-certificate_authority: type: string description: The Certificate Authority that Total TLS certificates will be issued through. enum: - google - lets_encrypt example: google tls-certificates-and-hostnames_components-schemas-certificate_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull' tls-certificates-and-hostnames_components-schemas-certificate_response_single: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single' - properties: result: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificateObject' 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: type: string format: date-time description: This is the time the tls setting was originally created for this hostname. example: "2023-07-10T20:01:50.219171Z" tls-certificates-and-hostnames_components-schemas-enabled: type: boolean description: If enabled, Total TLS will order a hostname specific TLS certificate for any proxied A, AAAA, or CNAME record in your zone. example: true tls-certificates-and-hostnames_components-schemas-expires_on: type: string format: date-time description: When the certificate from the authority expires. example: "2100-01-01T05:20:00Z" readOnly: true tls-certificates-and-hostnames_components-schemas-hostname: type: string description: The hostname for which the tls settings are set. example: app.example.com tls-certificates-and-hostnames_components-schemas-private_key: type: string 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----- tls-certificates-and-hostnames_components-schemas-serial_number: type: string description: The serial number on the created Client Certificate. example: 3bb94ff144ac567b9f75ad664b6c55f8d5e48182 readOnly: true tls-certificates-and-hostnames_components-schemas-signature: type: string description: The type of hash used for the Client Certificate.. example: SHA256WithRSA readOnly: true tls-certificates-and-hostnames_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: type: string format: date-time description: This is the time the tls setting was updated. example: "2023-07-10T20:01:50.219171Z" tls-certificates-and-hostnames_components-schemas-uploaded_on: type: string format: date-time description: The time when the certificate was uploaded. example: "2019-10-28T18:11:23.37411Z" tls-certificates-and-hostnames_components-schemas-validation_method: type: object required: - validation_method properties: validation_method: $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_method_definition' tls-certificates-and-hostnames_components-schemas-validity_days: type: integer description: The number of days the Client Certificate will be valid after the issued_on date example: 3650 tls-certificates-and-hostnames_config: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_certid_input' tls-certificates-and-hostnames_country: type: string description: Country, provided by the CSR example: US readOnly: true tls-certificates-and-hostnames_created_at: type: string format: date-time description: This is the time the hostname was created. example: "2020-02-06T18:11:23.531995Z" tls-certificates-and-hostnames_csr: type: string description: The Certificate Signing Request (CSR). Must be newline-encoded. example: |- -----BEGIN CERTIFICATE REQUEST----- MIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz Y28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI hvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL Hu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8 4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc N8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi g7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I uOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG CSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt cGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx pTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/ auRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH yc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J hXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs dcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ== -----END CERTIFICATE REQUEST----- tls-certificates-and-hostnames_custom-certificate: type: object required: - id - hosts - issuer - signature - status - bundle_method - zone_id - uploaded_on - modified_on - expires_on - priority properties: bundle_method: $ref: '#/components/schemas/tls-certificates-and-hostnames_bundle_method' expires_on: $ref: '#/components/schemas/tls-certificates-and-hostnames_expires_on' geo_restrictions: $ref: '#/components/schemas/tls-certificates-and-hostnames_geo_restrictions' hosts: $ref: '#/components/schemas/tls-certificates-and-hostnames_hosts' id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' issuer: $ref: '#/components/schemas/tls-certificates-and-hostnames_issuer' keyless_server: $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless-certificate' modified_on: $ref: '#/components/schemas/tls-certificates-and-hostnames_modified_on' policy: $ref: '#/components/schemas/tls-certificates-and-hostnames_policy' priority: $ref: '#/components/schemas/tls-certificates-and-hostnames_priority' signature: $ref: '#/components/schemas/tls-certificates-and-hostnames_signature' status: $ref: '#/components/schemas/tls-certificates-and-hostnames_status' uploaded_on: $ref: '#/components/schemas/tls-certificates-and-hostnames_uploaded_on' zone_id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' tls-certificates-and-hostnames_custom-hostname: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_customhostname' type: object required: - id - hostname - ssl properties: hostname: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname' id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' ssl: $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl' tls-certificates-and-hostnames_custom_hostname_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom-hostname' 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: anyOf: - type: object properties: key: type: string description: Unique metadata for this hostname. example: value type: object description: These are per-hostname (customer) settings. tls-certificates-and-hostnames_custom_origin_server: type: string description: a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record. example: origin2.example.com tls-certificates-and-hostnames_custom_origin_sni: type: string description: A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':request_host_header:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server. example: sni.example.com 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' - type: object properties: result: type: object properties: id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' tls-certificates-and-hostnames_enabled: type: boolean description: Whether or not the Keyless SSL is on or off. example: false readOnly: true tls-certificates-and-hostnames_enabled_response: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single' - properties: result: properties: enabled: $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled' tls-certificates-and-hostnames_enabled_write: type: boolean description: Whether or not the Keyless SSL is on or off. example: false deprecated: true tls-certificates-and-hostnames_expired_on: type: string description: Date that the Client Certificate expires example: "2033-02-20T23:18:00Z" readOnly: true tls-certificates-and-hostnames_expires_on: type: string format: date-time description: When the certificate from the authority expires. example: "2016-01-01T05:20:00Z" readOnly: true tls-certificates-and-hostnames_fallback_origin_response: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single' - properties: result: type: object tls-certificates-and-hostnames_fingerprint_sha256: type: string description: Unique identifier of the Client Certificate example: 256c24690243359fb8cf139a125bd05ebf1d968b71e4caf330718e9f5c8a89ea readOnly: true tls-certificates-and-hostnames_geo_restrictions: type: object description: Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance. properties: label: enum: - us - eu - highest_security example: us tls-certificates-and-hostnames_host: type: string format: hostname description: The keyless SSL name. example: example.com maxLength: 253 tls-certificates-and-hostnames_hostname: type: string description: The custom hostname that will point to your hostname via CNAME. example: app.example.com readOnly: true maxLength: 255 tls-certificates-and-hostnames_hostname-authenticated-origin-pull: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_certid_object' type: object properties: cert_id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' certificate: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate' enabled: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled' hostname: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostname' id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' private_key: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-private_key' tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate: type: string description: The hostname certificate. example: | -----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1 CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5 0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2 izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4 9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2 2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq 2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY= -----END CERTIFICATE----- tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull' tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled: type: boolean description: Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association. example: true nullable: true tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-expires_on: type: string format: date-time description: The date when the certificate expires. example: "2100-01-01T05:20:00Z" readOnly: true 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-status: type: string description: Deployment status for the given tls setting. example: pending_deployment tls-certificates-and-hostnames_hostname_aop_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull' tls-certificates-and-hostnames_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: type: object properties: hostnames: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostnames' mtls_certificate_id: type: string description: The UUID for a certificate that was uploaded to the mTLS Certificate Management endpoint. If no mtls_certificate_id is given, the hostnames will be associated to your active Cloudflare Managed CA. minLength: 36 maxLength: 36 tls-certificates-and-hostnames_hostname_associations_response: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single' - properties: result: type: object properties: hostnames: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostnames' tls-certificates-and-hostnames_hostname_certid_input: type: object properties: cert_id: $ref: '#/components/schemas/tls-certificates-and-hostnames_cert_id' enabled: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled' hostname: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostname' tls-certificates-and-hostnames_hostname_certid_object: properties: cert_id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' cert_status: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status' cert_updated_at: $ref: '#/components/schemas/tls-certificates-and-hostnames_updated_at' cert_uploaded_on: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-uploaded_on' certificate: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate' created_at: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-created_at' enabled: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled' expires_on: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-expires_on' hostname: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostname' issuer: $ref: '#/components/schemas/tls-certificates-and-hostnames_issuer' serial_number: $ref: '#/components/schemas/tls-certificates-and-hostnames_serial_number' signature: $ref: '#/components/schemas/tls-certificates-and-hostnames_signature' status: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status' updated_at: $ref: '#/components/schemas/tls-certificates-and-hostnames_updated_at' tls-certificates-and-hostnames_hostname_post: type: string description: The custom hostname that will point to your hostname via CNAME. example: app.example.com maxLength: 255 tls-certificates-and-hostnames_hostnames: type: array description: Array of hostnames or wildcard names (e.g., *.example.com) bound to the certificate. example: - example.com - '*.example.com' items: {} tls-certificates-and-hostnames_hosts: type: array items: type: string description: The valid hosts for the certificates. example: example.com readOnly: true maxLength: 253 tls-certificates-and-hostnames_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 tls-certificates-and-hostnames_issued_on: type: string description: Date that the Client Certificate was issued by the Certificate Authority example: "2023-02-23T23:18:00Z" readOnly: true tls-certificates-and-hostnames_issuer: type: string description: The certificate authority that issued the certificate. example: GlobalSign readOnly: true tls-certificates-and-hostnames_keyless-certificate: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_base' type: object tls-certificates-and-hostnames_keyless_private_ip: type: string description: Private IP of the Key Server Host example: 10.0.0.1 tls-certificates-and-hostnames_keyless_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless-certificate' 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: type: object properties: id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' tls-certificates-and-hostnames_keyless_tunnel: type: object description: Configuration for using Keyless SSL through a Cloudflare Tunnel required: - private_ip - vnet_id properties: private_ip: $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_private_ip' vnet_id: $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_vnet_id' tls-certificates-and-hostnames_keyless_vnet_id: type: string description: Cloudflare Tunnel Virtual Network ID example: 7365377a-85a4-4390-9480-531ef7dc7a3c tls-certificates-and-hostnames_location: type: string description: Location, provided by the CSR example: Somewhere readOnly: true tls-certificates-and-hostnames_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string tls-certificates-and-hostnames_modified_on: type: string format: date-time description: When the certificate was last modified. example: "2014-01-01T05:20:00Z" readOnly: true tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificateObject' - properties: result_info: type: object properties: count: example: 1 page: example: 1 per_page: example: 50 total_count: example: 1 total_pages: example: 1 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: type: string format: date-time description: When the certificate expires. example: "2122-10-29T16:59:47Z" readOnly: true tls-certificates-and-hostnames_mtls-management_components-schemas-status: type: string description: Certificate deployment status for the given service. example: pending_deployment tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on: type: string format: date-time description: This is the time the certificate was uploaded. example: "2022-11-22T17:32:30.467938Z" tls-certificates-and-hostnames_name: type: string description: The keyless SSL name. example: example.com Keyless SSL readOnly: true maxLength: 180 tls-certificates-and-hostnames_name_write: type: string description: The keyless SSL name. example: example.com Keyless SSL maxLength: 180 tls-certificates-and-hostnames_organization: type: string description: Organization, provided by the CSR example: Organization readOnly: true tls-certificates-and-hostnames_organizational_unit: type: string description: Organizational Unit, provided by the CSR example: Organizational Unit readOnly: true tls-certificates-and-hostnames_origin: type: string description: Your origin hostname that requests to your custom hostnames will be sent to. example: fallback.example.com maxLength: 255 tls-certificates-and-hostnames_ownership_verification: oneOf: - type: object properties: name: type: string description: DNS Name for record. example: _cf-custom-hostname.app.example.com type: description: DNS Record type. enum: - txt example: txt value: type: string description: Content for the record. example: 5cc07c04-ea62-4a5a-95f0-419334a875a4 type: object description: This is a record which can be placed to activate a hostname. tls-certificates-and-hostnames_ownership_verification_http: oneOf: - type: object properties: http_body: type: string description: Token to be served. example: 5cc07c04-ea62-4a5a-95f0-419334a875a4 http_url: type: string description: The HTTP URL that will be checked during custom hostname verification and where the customer should host the token. example: http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9 type: object description: This presents the token to be served by the given http url to activate a hostname. 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: type: array items: properties: created_at: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-created_at' hostname: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname' status: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status' updated_at: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-updated_at' value: $ref: '#/components/schemas/tls-certificates-and-hostnames_value' - properties: result_info: type: object properties: count: example: 1 page: example: 1 per_page: example: 50 total_count: example: 1 total_pages: type: number description: Total pages available of results example: 1 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: type: string description: 'Specify the policy that determines the region where your private key will be held locally. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Any combination of countries, specified by their two letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) can be chosen, such as ''country: IN'', as well as ''region: EU'' which refers to the EU region. If there are too few data centers satisfying the policy, it will be rejected.' example: '(country: US) or (region: EU)' tls-certificates-and-hostnames_port: type: number description: The keyless SSL port used to communicate between Cloudflare and the client's Keyless SSL server. default: 24008 example: 24008 maxLength: 65535 tls-certificates-and-hostnames_priority: type: number description: The order/priority in which the certificate will be used in a request. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates. default: 20 example: 1 tls-certificates-and-hostnames_private_key: type: string description: The zone's private key. example: | -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi -----END RSA PRIVATE KEY----- tls-certificates-and-hostnames_quota: type: object properties: allocated: type: integer description: Quantity Allocated. used: type: integer description: Quantity Used. tls-certificates-and-hostnames_request_type: type: string description: Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers). enum: - origin-rsa - origin-ecc - keyless-certificate example: origin-rsa tls-certificates-and-hostnames_requested_validity: type: number description: The number of days for which the certificate should be valid. enum: - 7 - 30 - 90 - 365 - 730 - 1095 - 5475 default: 5475 example: 5475 tls-certificates-and-hostnames_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 tls-certificates-and-hostnames_schemas-certificate: type: string description: The zone's SSL certificate or SSL certificate and intermediate(s). example: '-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----' tls-certificates-and-hostnames_schemas-certificate_authority: type: string description: Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities) enum: - google - lets_encrypt example: lets_encrypt tls-certificates-and-hostnames_schemas-certificate_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificates' tls-certificates-and-hostnames_schemas-certificate_response_single: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single' - type: object properties: result: 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: type: string 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----- tls-certificates-and-hostnames_schemas-created_at: type: string format: date-time description: The time when the certificate was created. example: "2100-01-01T05:20:00Z" readOnly: true tls-certificates-and-hostnames_schemas-csr: type: string description: The Certificate Signing Request (CSR). Must be newline-encoded. example: '-----BEGIN CERTIFICATE REQUEST-----\nMIICY....\n-----END CERTIFICATE REQUEST-----\n' tls-certificates-and-hostnames_schemas-enabled: type: boolean description: |- Disabling Universal SSL removes any currently active Universal SSL certificates for your zone from the edge and prevents any future Universal SSL certificates from being ordered. If there are no advanced certificates or custom certificates uploaded for the domain, visitors will be unable to access the domain over HTTPS. By disabling Universal SSL, you understand that the following Cloudflare settings and preferences will result in visitors being unable to visit your domain unless you have uploaded a custom certificate or purchased an advanced certificate. * HSTS * Always Use HTTPS * Opportunistic Encryption * Onion Routing * Any Page Rules redirecting traffic to HTTPS Similarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy is enabled will result in users being unable to visit your site without a valid certificate at Cloudflare's edge. If you do not have a valid custom or advanced certificate at Cloudflare's edge and are unsure if any of the above Cloudflare settings are enabled, or if any HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for your domain. example: true tls-certificates-and-hostnames_schemas-expires_on: type: string format: date-time description: When the certificate will expire. example: "2014-01-01T05:20:00.12345Z" readOnly: true tls-certificates-and-hostnames_schemas-hostname: type: string description: The hostname on the origin for which the client certificate uploaded will be used. example: app.example.com maxLength: 255 tls-certificates-and-hostnames_schemas-hostnames: type: array items: type: string example: api.example.com tls-certificates-and-hostnames_schemas-hosts: type: array description: Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty. example: - example.com - '*.example.com' - www.example.com items: type: string tls-certificates-and-hostnames_schemas-identifier: type: string description: Keyless certificate identifier tag. example: 4d2844d2ce78891c34d0b6c0535a291e readOnly: true maxLength: 32 tls-certificates-and-hostnames_schemas-issuer: type: string description: The certificate authority that issued the certificate. example: O=Example Inc.,L=California,ST=San Francisco,C=US readOnly: true tls-certificates-and-hostnames_schemas-name: type: string description: Optional unique name for the certificate. Only used for human readability. example: example_ca_cert tls-certificates-and-hostnames_schemas-private_key: type: string description: The hostname certificate's private key. example: | -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi -----END RSA PRIVATE KEY----- tls-certificates-and-hostnames_schemas-serial_number: type: string description: The certificate serial number. example: "235217144297995885180570755458463043449861756659" readOnly: true tls-certificates-and-hostnames_schemas-signature: type: string description: Certificate's signature algorithm. enum: - ECDSAWithSHA256 - SHA1WithRSA - SHA256WithRSA tls-certificates-and-hostnames_schemas-status: type: string description: Status of the Keyless SSL. enum: - active - deleted example: active readOnly: true tls-certificates-and-hostnames_schemas-updated_at: type: string format: date-time description: This is the time the certificate was updated. example: "2022-11-22T17:32:30.467938Z" tls-certificates-and-hostnames_schemas-uploaded_on: type: string format: date-time description: This is the time the certificate was uploaded. example: "2019-10-28T18:11:23.37411Z" tls-certificates-and-hostnames_schemas-validation_method: type: string description: Validation method in use for a certificate pack order. enum: - http - cname - txt example: txt tls-certificates-and-hostnames_schemas-validity_days: type: integer description: The validity period in days for the certificates ordered via Total TLS. enum: - 90 tls-certificates-and-hostnames_serial_number: type: string description: The serial number on the uploaded certificate. example: "6743787633689793699141714808227354901" tls-certificates-and-hostnames_service: type: string description: The service using the certificate. example: gateway tls-certificates-and-hostnames_setting_id: type: string description: The TLS Setting name. enum: - ciphers - min_tls_version - http2 tls-certificates-and-hostnames_settingObject: properties: created_at: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-created_at' hostname: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname' status: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status' updated_at: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-updated_at' value: $ref: '#/components/schemas/tls-certificates-and-hostnames_value' tls-certificates-and-hostnames_settingObjectDelete: properties: created_at: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-created_at' hostname: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname' status: example: pending_deletion updated_at: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-updated_at' value: example: "" tls-certificates-and-hostnames_signature: type: string description: The type of hash used for the certificate. example: SHA256WithRSA readOnly: true tls-certificates-and-hostnames_ski: type: string description: Subject Key Identifier example: 8e375af1389a069a0f921f8cc8e1eb12d784b949 readOnly: true tls-certificates-and-hostnames_ssl: oneOf: - type: object properties: bundle_method: type: string description: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. enum: - ubiquitous - optimal - force default: ubiquitous example: ubiquitous certificate_authority: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_authority' custom_certificate: type: string description: If a custom uploaded certificate is used. example: '-----BEGIN CERTIFICATE-----\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\n-----END CERTIFICATE-----\n' custom_csr_id: type: string description: The identifier for the Custom CSR that was used. example: 7b163417-1d2b-4c84-a38a-2fb7a0cd7752 custom_key: type: string description: The key for a custom uploaded certificate. example: | -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi -----END RSA PRIVATE KEY----- expires_on: type: string format: date-time description: The time the custom certificate expires on. example: "2021-02-06T18:11:23.531995Z" hosts: type: array description: A list of Hostnames on a custom uploaded certificate. example: - app.example.com - '*.app.example.com' items: {} id: type: string description: Custom hostname SSL identifier tag. example: 0d89c70d-ad9f-4843-b99f-6cc0252067e9 minLength: 36 maxLength: 36 issuer: type: string description: The issuer on a custom uploaded certificate. example: DigiCertInc method: description: Domain control validation (DCV) method used for this hostname. enum: - http - txt - email example: txt serial_number: type: string description: The serial number on a custom uploaded certificate. example: "6743787633689793699141714808227354901" settings: $ref: '#/components/schemas/tls-certificates-and-hostnames_sslsettings' signature: type: string description: The signature on a custom uploaded certificate. example: SHA256WithRSA status: description: Status of the hostname's SSL certificates. enum: - initializing - pending_validation - deleted - pending_issuance - pending_deployment - pending_deletion - pending_expiration - expired - active - initializing_timed_out - validation_timed_out - issuance_timed_out - deployment_timed_out - deletion_timed_out - pending_cleanup - staging_deployment - staging_active - deactivating - inactive - backup_issued - holding_deployment example: pending_validation readOnly: true type: description: Level of validation to be used for this hostname. Domain validation (dv) must be used. enum: - dv example: dv readOnly: true uploaded_on: type: string format: date-time description: The time the custom certificate was uploaded. example: "2020-02-06T18:11:23.531995Z" validation_errors: type: array description: Domain validation errors that have been received by the certificate authority (CA). items: type: object properties: message: type: string description: A domain validation error. example: SERVFAIL looking up CAA for app.example.com validation_records: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_record' wildcard: type: boolean description: Indicates whether the certificate covers a wildcard. example: false type: object description: SSL properties for the custom hostname. 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: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_verification' tls-certificates-and-hostnames_sslpost: oneOf: - type: object properties: bundle_method: type: string description: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. enum: - ubiquitous - optimal - force default: ubiquitous example: ubiquitous certificate_authority: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_authority' custom_certificate: type: string description: If a custom uploaded certificate is used. example: '-----BEGIN CERTIFICATE-----\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\n-----END CERTIFICATE-----\n' custom_key: type: string description: The key for a custom uploaded certificate. example: | -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi -----END RSA PRIVATE KEY----- method: description: Domain control validation (DCV) method used for this hostname. enum: - http - txt - email example: http settings: $ref: '#/components/schemas/tls-certificates-and-hostnames_sslsettings' type: description: Level of validation to be used for this hostname. Domain validation (dv) must be used. enum: - dv example: dv wildcard: type: boolean description: Indicates whether the certificate covers a wildcard. example: false type: object description: SSL properties used when creating the custom hostname. tls-certificates-and-hostnames_sslsettings: type: object description: SSL specific settings. properties: ciphers: type: array description: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. example: - ECDHE-RSA-AES128-GCM-SHA256 - AES128-SHA uniqueItems: true items: type: string early_hints: description: Whether or not Early Hints is enabled. enum: - "on" - "off" example: "on" http2: description: Whether or not HTTP2 is enabled. enum: - "on" - "off" example: "on" min_tls_version: description: The minimum TLS version supported. enum: - "1.0" - "1.1" - "1.2" - "1.3" example: "1.2" tls_1_3: description: Whether or not TLS 1.3 is enabled. enum: - "on" - "off" example: "on" tls-certificates-and-hostnames_state: type: string description: State, provided by the CSR example: CA readOnly: true tls-certificates-and-hostnames_status: description: Status of the zone's custom SSL. enum: - active - expired - deleted - pending - initializing example: active readOnly: true tls-certificates-and-hostnames_total_tls_settings_response: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single' - properties: result: properties: certificate_authority: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_authority' enabled: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-enabled' validity_days: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-validity_days' tls-certificates-and-hostnames_type: type: string description: The type 'legacy_custom' enables support for legacy clients which do not include SNI in the TLS handshake. enum: - legacy_custom - sni_custom default: legacy_custom example: sni_custom tls-certificates-and-hostnames_universal: type: object properties: enabled: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-enabled' tls-certificates-and-hostnames_updated_at: type: string format: date-time description: The time when the certificate was updated. example: "2100-01-01T05:20:00Z" readOnly: true tls-certificates-and-hostnames_uploaded_on: type: string format: date-time description: When the certificate was uploaded to Cloudflare. example: "2014-01-01T05:20:00Z" readOnly: true tls-certificates-and-hostnames_uuid: type: string description: The DCV Delegation unique identifier. example: abc123def456ghi7 tls-certificates-and-hostnames_uuidObject: properties: uuid: $ref: '#/components/schemas/tls-certificates-and-hostnames_uuid' tls-certificates-and-hostnames_validation_method: type: string description: Validation Method selected for the order. enum: - txt - http - email example: txt tls-certificates-and-hostnames_validation_method_components-schemas-status: type: string description: Result status. example: pending_validation tls-certificates-and-hostnames_validation_method_definition: type: string description: Desired validation method. enum: - http - cname - txt - email example: txt tls-certificates-and-hostnames_validation_record: type: object description: Certificate's required validation record. properties: emails: type: array description: The set of email addresses that the certificate authority (CA) will use to complete domain validation. example: - administrator@example.com - webmaster@example.com items: {} http_body: type: string description: The content that the certificate authority (CA) will expect to find at the http_url during the domain validation. example: ca3-574923932a82475cb8592200f1a2a23d http_url: type: string description: The url that will be checked during domain validation. example: http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt txt_name: type: string description: The hostname that the certificate authority (CA) will check for a TXT record during domain validation . example: _acme-challenge.app.example.com txt_value: type: string description: The TXT record that the certificate authority (CA) will check during domain validation. example: 810b7d5f01154524b961ba0cd578acc2 tls-certificates-and-hostnames_validity_days: type: integer description: Validity Days selected for the order. enum: - 14 - 30 - 90 - 365 tls-certificates-and-hostnames_value: oneOf: - type: number - type: string - type: array items: type: string description: The tls setting value. example: - ECDHE-RSA-AES128-GCM-SHA256 - AES128-GCM-SHA256 tls-certificates-and-hostnames_verification: type: object required: - certificate_status properties: brand_check: $ref: '#/components/schemas/tls-certificates-and-hostnames_brand_check' cert_pack_uuid: $ref: '#/components/schemas/tls-certificates-and-hostnames_cert_pack_uuid' certificate_status: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_status' signature: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-signature' validation_method: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-validation_method' verification_info: $ref: '#/components/schemas/tls-certificates-and-hostnames_verification_info' verification_status: $ref: '#/components/schemas/tls-certificates-and-hostnames_verification_status' verification_type: $ref: '#/components/schemas/tls-certificates-and-hostnames_verification_type' tls-certificates-and-hostnames_verification_errors: type: array description: These are errors that were encountered while trying to activate a hostname. example: - None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found. items: {} tls-certificates-and-hostnames_verification_info: type: object description: Certificate's required verification information. properties: record_name: type: string format: hostname description: Name of CNAME record. enum: - record_name - http_url - cname - txt_name example: b3b90cfedd89a3e487d3e383c56c4267.example.com record_target: type: string format: hostname description: Target of CNAME record. enum: - record_value - http_body - cname_target - txt_value example: 6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com tls-certificates-and-hostnames_verification_status: type: boolean description: Status of the required verification information, omitted if verification status is unknown. example: true tls-certificates-and-hostnames_verification_type: type: string description: Method of verification. enum: - cname - meta tag example: cname tls-certificates-and-hostnames_zone-authenticated-origin-pull: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificateObject' type: object properties: certificate: $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate' enabled: $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled' id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' private_key: $ref: '#/components/schemas/tls-certificates-and-hostnames_private_key' tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate: type: string description: The zone's leaf certificate. example: | -----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1 CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5 0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2 izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4 9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2 2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq 2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY= -----END CERTIFICATE----- tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled: type: boolean description: Indicates whether zone-level authenticated origin pulls is enabled. example: true 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_api-response-collection: allOf: - $ref: '#/components/schemas/tunnel_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/tunnel_result_info' type: object tunnel_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/tunnel_messages' messages: $ref: '#/components/schemas/tunnel_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true tunnel_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false tunnel_api-response-single: $ref: '#/components/schemas/tunnel_api-response-common' tunnel_arch: type: string description: The cloudflared OS architecture used to establish this connection. example: linux_amd64 tunnel_argo-tunnel: type: object required: - id - name - created_at - connections properties: connections: type: array description: The tunnel connections between your origin and Cloudflare's edge. items: $ref: '#/components/schemas/tunnel_connection' 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' tunnel_cf_account_id: type: string description: Cloudflare account ID example: 699d98642c564d2e855e9661899b7252 maxLength: 32 tunnel_cfd_tunnel: type: object description: A Cloudflare Tunnel that connects your origin to Cloudflare's edge. properties: account_tag: $ref: '#/components/schemas/tunnel_cf_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' tunnel_client_id: type: string description: UUID of the Cloudflare Tunnel client. example: 1bedc50d-42b3-473c-b108-ff3d10c0d925 readOnly: true maxLength: 36 tunnel_colo_name: type: string description: The Cloudflare data center used for this connection. example: DFW tunnel_comment: type: string description: Optional remark describing the route. example: Example comment for this route. tunnel_config: type: object description: The tunnel configuration and ingress rules. properties: ingress: type: array description: List of public hostname definitions items: $ref: '#/components/schemas/tunnel_ingressRule' originRequest: $ref: '#/components/schemas/tunnel_originRequest' warp-routing: type: object description: Enable private network access from WARP users to private network routes properties: enabled: type: boolean default: false tunnel_config_response_single: allOf: - $ref: '#/components/schemas/tunnel_api-response-single' - type: object properties: result: type: object tunnel_config_src: type: string description: Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard or using the [Cloudflare Tunnel configuration](https://api.cloudflare.com/#cloudflare-tunnel-configuration-properties) endpoint. enum: - local - cloudflare default: local example: cloudflare tunnel_config_version: type: integer description: The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard. 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: type: string description: UUID of the Cloudflare Tunnel connection. example: 1bedc50d-42b3-473c-b108-ff3d10c0d925 readOnly: true maxLength: 36 tunnel_connections: type: array description: The Cloudflare Tunnel connections between your origin and Cloudflare's edge. items: $ref: '#/components/schemas/tunnel_schemas-connection' tunnel_conns_active_at: type: string format: date-time description: Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If `null`, the tunnel is inactive. example: "2009-11-10T23:00:00Z" nullable: true tunnel_conns_inactive_at: type: string format: date-time description: Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If `null`, the tunnel is active. example: "2009-11-10T23:00:00Z" nullable: true tunnel_created_at: type: string format: date-time description: Timestamp of when the tunnel was created. example: "2021-01-25T18:22:34.317854Z" tunnel_deleted_at: type: string format: date-time description: Timestamp of when the tunnel was deleted. If `null`, the tunnel has not been deleted. example: "2009-11-10T23:00:00Z" nullable: true tunnel_empty_response: allOf: - $ref: '#/components/schemas/tunnel_api-response-common' - type: object properties: result: type: object tunnel_existed_at: type: string format: date-time description: If provided, include only tunnels that were created (and not deleted) before this time. example: "2019-10-12T07:20:50.52Z" tunnel_features: type: array description: Features enabled for the Cloudflare Tunnel. items: type: string example: ha-origin tunnel_icmp_proxy_enabled: type: boolean description: A flag to enable the ICMP proxy for the account network. example: true tunnel_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 tunnel_ingressRule: type: object description: Public hostname required: - hostname - service properties: hostname: type: string description: Public hostname for this service. example: tunnel.example.com originRequest: $ref: '#/components/schemas/tunnel_originRequest' path: type: string description: Requests with this path route to this public hostname. default: "" example: subpath service: type: string 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 tunnel_ip: type: string example: 10.1.0.137 tunnel_ip_network: type: string description: The private IPv4 or IPv6 range connected by the route, in CIDR notation. example: 172.16.0.0/16 tunnel_ip_network_encoded: type: string description: IP/CIDR range in URL-encoded format example: 172.16.0.0%2F16 tunnel_is_default_network: type: boolean description: If `true`, this virtual network is the default for the account. example: true tunnel_is_pending_reconnect: type: boolean description: Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If `true`, the connection has disconnected but is still being tracked. If `false`, the connection is actively serving traffic. example: false tunnel_legacy-tunnel-response-collection: allOf: - $ref: '#/components/schemas/tunnel_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/tunnel_argo-tunnel' tunnel_legacy-tunnel-response-single: allOf: - $ref: '#/components/schemas/tunnel_api-response-single' - type: object properties: result: $ref: '#/components/schemas/tunnel_argo-tunnel' tunnel_management-resources: type: string description: Management resources the token will have access to. enum: - logs example: logs tunnel_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string tunnel_metadata: type: object description: Metadata associated with the tunnel. example: {} tunnel_offramp_warp_enabled: type: boolean description: A flag to enable WARP to WARP traffic. example: true tunnel_originRequest: type: object description: Configuration parameters of connection between cloudflared and origin server. properties: access: type: object description: For all L7 requests to this hostname, cloudflared will validate each request's Cf-Access-Jwt-Assertion request header. required: - audTag - teamName properties: audTag: type: array 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 required: type: boolean description: Deny traffic that has not fulfilled Access authorization. default: false teamName: type: string default: Your Zero Trust authentication domain. caPool: type: string 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. default: "" connectTimeout: type: integer 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. default: 10 disableChunkedEncoding: type: boolean description: Disables chunked transfer encoding. Useful if you are running a WSGI server. http2Origin: type: boolean description: Attempt to connect to origin using HTTP2. Origin must be configured as https. httpHostHeader: type: string description: Sets the HTTP Host header on requests sent to the local service. keepAliveConnections: type: integer description: Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections. default: 100 keepAliveTimeout: type: integer description: Timeout after which an idle keepalive connection can be discarded. default: 90 noHappyEyeballs: type: boolean description: Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols. default: false noTLSVerify: type: boolean description: Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted. default: false originServerName: type: string description: Hostname that cloudflared should expect from your origin server certificate. default: "" proxyType: type: string 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. default: "" tcpKeepAlive: type: integer description: The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server. default: 30 tlsTimeout: type: integer description: Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server. default: 10 tunnel_per_page: type: number description: Number of results to display. minimum: 1 maximum: 1000 tunnel_remote_config: type: boolean description: If `true`, the tunnel can be configured remotely from the Zero Trust dashboard. If `false`, the tunnel must be configured locally on the origin machine. example: true tunnel_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 tunnel_route: type: object properties: comment: $ref: '#/components/schemas/tunnel_comment' created_at: description: Timestamp of when the route was created. deleted_at: type: string format: date-time description: Timestamp of when the route was deleted. If `null`, the route has not been deleted. example: "2021-01-25T18:22:34.317854Z" nullable: true readOnly: true id: $ref: '#/components/schemas/tunnel_route_id' network: $ref: '#/components/schemas/tunnel_ip_network' tunnel_id: $ref: '#/components/schemas/tunnel_route_tunnel_id' virtual_network_id: $ref: '#/components/schemas/tunnel_route_virtual_network_id' tunnel_route_id: type: string description: UUID of the route. example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 readOnly: true maxLength: 36 tunnel_route_response_single: allOf: - $ref: '#/components/schemas/tunnel_api-response-single' - type: object properties: result: $ref: '#/components/schemas/tunnel_route' tunnel_route_tunnel_id: description: UUID of the Cloudflare Tunnel serving the route. tunnel_route_tunnel_name: description: The user-friendly name of the Cloudflare Tunnel serving the route. tunnel_route_virtual_network_id: description: UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account. tunnel_run_at: type: string format: date-time description: Timestamp of when the tunnel connection was started. example: "2009-11-10T23:00:00Z" tunnel_schemas-comment: type: string description: Optional remark describing the virtual network. example: Staging VPC for data science tunnel_schemas-connection: properties: client_id: description: UUID of the cloudflared instance. 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: type: string format: date-time description: Timestamp of when the connection was established. example: "2021-01-25T18:22:34.317854Z" origin_ip: type: string description: The public IP address of the host running cloudflared. example: 85.12.78.6 uuid: $ref: '#/components/schemas/tunnel_connection_id' tunnel_status: type: string 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). example: healthy tunnel_teamnet: type: object properties: comment: $ref: '#/components/schemas/tunnel_comment' created_at: description: Timestamp of when the route was created. deleted_at: type: string format: date-time description: Timestamp of when the route was deleted. If `null`, the route has not been deleted. example: "2021-01-25T18:22:34.317854Z" nullable: true readOnly: true 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_route_tunnel_id' tunnel_name: $ref: '#/components/schemas/tunnel_route_tunnel_name' virtual_network_id: $ref: '#/components/schemas/tunnel_route_virtual_network_id' virtual_network_name: $ref: '#/components/schemas/tunnel_vnet_name' tunnel_teamnet_response_collection: allOf: - $ref: '#/components/schemas/tunnel_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/tunnel_teamnet' tunnel_teamnet_response_single: allOf: - $ref: '#/components/schemas/tunnel_api-response-single' - type: object properties: result: $ref: '#/components/schemas/tunnel_teamnet' tunnel_tunnel-response-collection: allOf: - $ref: '#/components/schemas/tunnel_api-response-collection' - type: object properties: result: type: array items: anyOf: - $ref: '#/components/schemas/tunnel_cfd_tunnel' - $ref: '#/components/schemas/tunnel_warp_connector_tunnel' tunnel_tunnel-response-single: allOf: - $ref: '#/components/schemas/tunnel_api-response-single' - type: object properties: result: anyOf: - $ref: '#/components/schemas/tunnel_cfd_tunnel' - $ref: '#/components/schemas/tunnel_warp_connector_tunnel' tunnel_tunnel_client: type: object 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' tunnel_tunnel_client_response: allOf: - $ref: '#/components/schemas/tunnel_api-response-single' - type: object properties: result: $ref: '#/components/schemas/tunnel_tunnel_client' tunnel_tunnel_connections_response: allOf: - $ref: '#/components/schemas/tunnel_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/tunnel_tunnel_client' tunnel_tunnel_id: type: string description: UUID of the tunnel. example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 readOnly: true maxLength: 36 tunnel_tunnel_link: type: object 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' tunnel_tunnel_links_response: allOf: - $ref: '#/components/schemas/tunnel_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/tunnel_tunnel_link' tunnel_tunnel_name: type: string description: A user-friendly name for the tunnel. example: blog tunnel_tunnel_response_token: allOf: - $ref: '#/components/schemas/tunnel_api-response-single' - type: object properties: result: type: string example: eyJhIjoiNWFiNGU5Z... tunnel_tunnel_secret: type: string description: Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string. example: AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg= tunnel_tunnel_type: type: string description: The type of tunnel. enum: - cfd_tunnel - warp_connector - ip_sec - gre - cni example: cfd_tunnel tunnel_tunnel_types: type: string description: The types of tunnels to filter separated by a comma. example: cfd_tunnel,warp_connector tunnel_version: type: string description: The cloudflared version used to establish this connection. example: 2022.7.1 tunnel_virtual-network: type: object required: - id - name - is_default_network - comment - created_at properties: comment: $ref: '#/components/schemas/tunnel_schemas-comment' created_at: description: Timestamp of when the virtual network was created. deleted_at: description: Timestamp of when the virtual network was deleted. If `null`, the virtual network has not been deleted. id: $ref: '#/components/schemas/tunnel_vnet_id' is_default_network: $ref: '#/components/schemas/tunnel_is_default_network' name: $ref: '#/components/schemas/tunnel_vnet_name' tunnel_vnet_id: type: string description: UUID of the virtual network. example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 readOnly: true maxLength: 36 tunnel_vnet_name: type: string description: A user-friendly name for the virtual network. example: us-east-1-vpc tunnel_vnet_response_collection: allOf: - $ref: '#/components/schemas/tunnel_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/tunnel_virtual-network' tunnel_vnet_response_single: allOf: - $ref: '#/components/schemas/tunnel_api-response-single' - type: object properties: result: type: object tunnel_warp_connector_tunnel: type: object description: A Warp Connector Tunnel that connects your origin to Cloudflare's edge. properties: account_tag: $ref: '#/components/schemas/tunnel_cf_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' tunnel_zero_trust_connectivity_settings_response: allOf: - $ref: '#/components/schemas/tunnel_api-response-single' - type: object properties: result: type: object properties: icmp_proxy_enabled: $ref: '#/components/schemas/tunnel_icmp_proxy_enabled' offramp_warp_enabled: $ref: '#/components/schemas/tunnel_offramp_warp_enabled' turnstile_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/turnstile_messages' messages: $ref: '#/components/schemas/turnstile_messages' success: type: boolean description: Whether the API call was successful example: true turnstile_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object nullable: true success: type: boolean description: Whether the API call was successful example: false turnstile_bot_fight_mode: type: boolean description: | If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only). example: false turnstile_clearance_level: type: string 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 turnstile_created_on: type: string format: date-time description: When the widget was created. example: "2014-01-01T05:20:00.123123Z" readOnly: true turnstile_domains: type: array example: - 203.0.113.1 - cloudflare.com - blog.example.com maxLength: 10 items: type: string 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 turnstile_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 turnstile_invalidate_immediately: type: boolean 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. default: false turnstile_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string turnstile_mode: type: string description: Widget Mode enum: - non-interactive - invisible - managed example: invisible turnstile_modified_on: type: string format: date-time description: When the widget was modified. example: "2014-01-01T05:20:00.123123Z" readOnly: true turnstile_name: type: string 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 minLength: 1 maxLength: 254 turnstile_offlabel: type: boolean description: | Do not show any Cloudflare branding on the widget (ENT only). example: false turnstile_region: type: string description: Region where this widget can be used. enum: - world default: world turnstile_result_info: type: object required: - page - per_page - count - total_count properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 turnstile_secret: type: string description: Secret key for this widget. example: 0x4AAF00AAAABn0R22HWm098HVBjhdsYUc turnstile_sitekey: type: string description: Widget item identifier tag. example: 0x4AAF00AAAABn0R22HWm-YUc maxLength: 32 turnstile_widget_detail: type: object description: A Turnstile widget's detailed configuration required: - sitekey - secret - created_on - modified_on - name - domains - mode - region - bot_fight_mode - offlabel - clearance_level 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' turnstile_widget_list: type: object description: A Turnstile Widgets configuration as it appears in listings required: - sitekey - created_on - modified_on - name - domains - mode - region - bot_fight_mode - offlabel - clearance_level 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' vectorize_api-response-collection: allOf: - $ref: '#/components/schemas/vectorize_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/vectorize_result_info' type: object vectorize_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/vectorize_messages' messages: $ref: '#/components/schemas/vectorize_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true vectorize_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false vectorize_api-response-single: allOf: - $ref: '#/components/schemas/vectorize_api-response-common' - properties: result: anyOf: - type: object - type: string type: object nullable: true type: object vectorize_create-index-request: type: object required: - name - config properties: config: allOf: - $ref: '#/components/schemas/vectorize_index-configuration' description: $ref: '#/components/schemas/vectorize_index-description' name: $ref: '#/components/schemas/vectorize_index-name' vectorize_create-index-response: type: object 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" readOnly: true 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" readOnly: true name: $ref: '#/components/schemas/vectorize_index-name' vectorize_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 vectorize_index-configuration: oneOf: - $ref: '#/components/schemas/vectorize_index-dimension-configuration' - $ref: '#/components/schemas/vectorize_index-preset-configuration' description: Specifies the type of configuration to use for the index. vectorize_index-delete-vectors-by-id-request: type: object properties: ids: type: array description: A list of vector identifiers to delete from the index indicated by the path. example: - 5121db81354a40c6aedc3fe1ace51c59 - f90eb49c2107486abdfd78c67e853430 items: $ref: '#/components/schemas/vectorize_identifier' vectorize_index-delete-vectors-by-id-response: type: object properties: count: type: integer description: The count of the vectors successfully deleted. example: 42 ids: type: array description: Array of vector identifiers of the vectors that were successfully processed for deletion. items: $ref: '#/components/schemas/vectorize_identifier' vectorize_index-description: type: string description: Specifies the description of the index. example: This is my example index. vectorize_index-dimension-configuration: type: object required: - dimensions - metric properties: dimensions: $ref: '#/components/schemas/vectorize_index-dimensions' metric: $ref: '#/components/schemas/vectorize_index-metric' vectorize_index-dimensions: type: integer description: Specifies the number of dimensions for the index example: 768 minimum: 1 maximum: 1536 vectorize_index-get-vectors-by-id-request: type: object properties: ids: type: array description: A list of vector identifiers to retrieve from the index indicated by the path. example: - 5121db81354a40c6aedc3fe1ace51c59 - f90eb49c2107486abdfd78c67e853430 items: $ref: '#/components/schemas/vectorize_identifier' vectorize_index-get-vectors-by-id-response: type: array 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: type: object properties: id: $ref: '#/components/schemas/vectorize_identifier' metadata: type: object namespace: type: string nullable: true values: type: array items: type: number vectorize_index-insert-response: type: object properties: count: type: integer description: Specifies the count of the vectors successfully inserted. example: 768 ids: type: array description: Array of vector identifiers of the vectors successfully inserted. items: $ref: '#/components/schemas/vectorize_identifier' vectorize_index-metric: type: string description: Specifies the type of metric to use calculating distance. enum: - cosine - euclidean - dot-product vectorize_index-name: type: string example: example-index pattern: ^([a-z]+[a-z0-9_-]*[a-z0-9]+)$ vectorize_index-preset: type: string 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' vectorize_index-preset-configuration: type: object required: - preset properties: preset: $ref: '#/components/schemas/vectorize_index-preset' vectorize_index-query-request: type: object required: - vector properties: filter: type: object description: A metadata filter expression used to limit nearest neighbor results. example: has_viewed: $ne: true streaming_platform: netflix returnMetadata: type: boolean description: Whether to return the metadata associated with the closest vectors. default: false returnValues: type: boolean description: Whether to return the values associated with the closest vectors. default: false topK: type: number description: The number of nearest neighbors to find. default: 5 example: 5 vector: type: array description: The search vector that will be used to find the nearest neighbors. example: - 0.5 - 0.5 - 0.5 items: type: number vectorize_index-query-response: type: object properties: count: type: integer description: Specifies the count of vectors returned by the search matches: type: array description: Array of vectors matched by the search items: type: object properties: id: $ref: '#/components/schemas/vectorize_identifier' metadata: type: object nullable: true score: type: number description: The score of the vector according to the index's distance metric values: type: array nullable: true items: type: number vectorize_index-upsert-response: type: object properties: count: type: integer description: Specifies the count of the vectors successfully inserted. example: 768 ids: type: array description: Array of vector identifiers of the vectors successfully inserted. items: $ref: '#/components/schemas/vectorize_identifier' vectorize_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string vectorize_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 vectorize_update-index-request: type: object required: - description properties: description: $ref: '#/components/schemas/vectorize_index-description' waf-managed-rules_allowed_modes: type: array description: The available states for the rule group. example: - "on" - "off" readOnly: true items: $ref: '#/components/schemas/waf-managed-rules_mode' waf-managed-rules_allowed_modes_allow_traditional: type: array description: Defines the available modes for the current WAF rule. example: - "on" - "off" readOnly: true items: $ref: '#/components/schemas/waf-managed-rules_mode_allow_traditional' waf-managed-rules_allowed_modes_anomaly: type: array description: Defines the available modes for the current WAF rule. Applies to anomaly detection WAF rules. example: - "on" - "off" readOnly: true items: $ref: '#/components/schemas/waf-managed-rules_mode_anomaly' waf-managed-rules_allowed_modes_deny_traditional: type: array description: The list of possible actions of the WAF rule when it is triggered. example: - default - disable - simulate - block - challenge readOnly: true items: $ref: '#/components/schemas/waf-managed-rules_mode_deny_traditional' waf-managed-rules_anomaly_rule: allOf: - $ref: '#/components/schemas/waf-managed-rules_schemas-base' - properties: allowed_modes: $ref: '#/components/schemas/waf-managed-rules_allowed_modes_anomaly' mode: $ref: '#/components/schemas/waf-managed-rules_mode_anomaly' title: Anomaly detection WAF rule description: When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package. required: - id - description - priority - allowed_modes - mode - group - package_id waf-managed-rules_api-response-collection: allOf: - $ref: '#/components/schemas/waf-managed-rules_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/waf-managed-rules_result_info' type: object waf-managed-rules_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/waf-managed-rules_messages' messages: $ref: '#/components/schemas/waf-managed-rules_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true waf-managed-rules_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/waf-managed-rules_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/waf-managed-rules_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false waf-managed-rules_api-response-single: allOf: - $ref: '#/components/schemas/waf-managed-rules_api-response-common' - properties: result: oneOf: - type: object nullable: true - type: string nullable: true type: object waf-managed-rules_base: properties: description: $ref: '#/components/schemas/waf-managed-rules_schemas-description' group: type: object description: The rule group to which the current WAF rule belongs. readOnly: true properties: id: $ref: '#/components/schemas/waf-managed-rules_components-schemas-identifier' name: $ref: '#/components/schemas/waf-managed-rules_name' id: $ref: '#/components/schemas/waf-managed-rules_rule_components-schemas-identifier' package_id: $ref: '#/components/schemas/waf-managed-rules_identifier' priority: $ref: '#/components/schemas/waf-managed-rules_priority' waf-managed-rules_components-schemas-identifier: type: string description: The unique identifier of the rule group. example: de677e5818985db1285d0e80225f06e5 readOnly: true maxLength: 32 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: type: string description: An informative summary of what the rule group does. example: Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks nullable: true readOnly: true waf-managed-rules_group: type: object properties: description: $ref: '#/components/schemas/waf-managed-rules_description' id: $ref: '#/components/schemas/waf-managed-rules_components-schemas-identifier' modified_rules_count: $ref: '#/components/schemas/waf-managed-rules_modified_rules_count' name: $ref: '#/components/schemas/waf-managed-rules_name' package_id: $ref: '#/components/schemas/waf-managed-rules_identifier' rules_count: $ref: '#/components/schemas/waf-managed-rules_rules_count' waf-managed-rules_identifier: type: string description: The unique identifier of a WAF package. example: a25a9a7e9c00afc1fb2e0245519d725b readOnly: true maxLength: 32 waf-managed-rules_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string waf-managed-rules_mode: type: string description: The state of the rules contained in the rule group. When `on`, the rules in the group are configurable/usable. enum: - "on" - "off" default: "on" waf-managed-rules_mode_allow_traditional: type: string description: When set to `on`, the current rule will be used when evaluating the request. Applies to traditional (allow) WAF rules. enum: - "on" - "off" example: "on" waf-managed-rules_mode_anomaly: type: string description: When set to `on`, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules. enum: - "on" - "off" example: "on" waf-managed-rules_mode_deny_traditional: type: string description: The action that the current WAF rule will perform when triggered. Applies to traditional (deny) WAF rules. enum: - default - disable - simulate - block - challenge example: block waf-managed-rules_modified_rules_count: type: number description: The number of rules within the group that have been modified from their default configuration. default: 0 example: 2 readOnly: true waf-managed-rules_name: type: string description: The name of the rule group. example: Project Honey Pot readOnly: true waf-managed-rules_priority: type: string description: The order in which the individual WAF rule is executed within its rule group. readOnly: true waf-managed-rules_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 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: type: string description: The unique identifier of the WAF rule. example: f939de3be84e66e757adcdcb87908023 readOnly: true maxLength: 32 waf-managed-rules_rule_group_response_collection: allOf: - $ref: '#/components/schemas/waf-managed-rules_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/waf-managed-rules_schemas-group' 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: type: array items: $ref: '#/components/schemas/waf-managed-rules_rule' 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: type: number description: The number of rules in the current rule group. default: 0 example: 10 readOnly: true waf-managed-rules_schemas-base: allOf: - $ref: '#/components/schemas/waf-managed-rules_base' waf-managed-rules_schemas-description: type: string description: The public description of the WAF rule. example: SQL injection prevention for SELECT statements readOnly: true waf-managed-rules_schemas-group: allOf: - $ref: '#/components/schemas/waf-managed-rules_group' - properties: allowed_modes: $ref: '#/components/schemas/waf-managed-rules_allowed_modes' mode: $ref: '#/components/schemas/waf-managed-rules_mode' type: object required: - id - name - description - mode - rules_count waf-managed-rules_schemas-identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 waf-managed-rules_traditional_allow_rule: allOf: - $ref: '#/components/schemas/waf-managed-rules_base' - properties: allowed_modes: $ref: '#/components/schemas/waf-managed-rules_allowed_modes_allow_traditional' mode: $ref: '#/components/schemas/waf-managed-rules_mode_allow_traditional' title: Traditional (allow) WAF rule description: When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An 'allow' rule will immediately allow the request and no other rules will be processed. required: - id - description - priority - allowed_modes - default_mode - mode - group - package_id waf-managed-rules_traditional_deny_rule: allOf: - $ref: '#/components/schemas/waf-managed-rules_base' - properties: allowed_modes: $ref: '#/components/schemas/waf-managed-rules_allowed_modes_deny_traditional' default_mode: $ref: '#/components/schemas/waf-managed-rules_default_mode' mode: $ref: '#/components/schemas/waf-managed-rules_mode_deny_traditional' title: Traditional (deny) WAF rule description: When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A 'deny' rule will immediately respond to the request based on the configured rule action/mode (for example, 'block') and no other rules will be processed. required: - id - description - priority - allowed_modes - default_mode - mode - group - package_id waitingroom_additional_routes: type: array description: Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms. items: type: object properties: host: type: string description: The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://). example: shop2.example.com path: type: string description: Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. default: / example: /shop2/checkout waitingroom_api-response-collection: allOf: - $ref: '#/components/schemas/waitingroom_schemas-api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/waitingroom_result_info' type: object waitingroom_api-response-common: type: object required: - success - errors - messages - result waitingroom_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/waitingroom_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/waitingroom_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false waitingroom_api-response-single: allOf: - $ref: '#/components/schemas/waitingroom_api-response-common' - properties: result: oneOf: - type: object - type: string type: object waitingroom_cookie_attributes: type: object description: Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. properties: samesite: type: string description: Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`. enum: - auto - lax - none - strict default: auto example: auto secure: type: string description: Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled. enum: - auto - always - never default: auto example: auto waitingroom_cookie_suffix: type: string description: Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`. example: abcd waitingroom_create_rule: required: - action - expression properties: action: $ref: '#/components/schemas/waitingroom_rule_action' description: $ref: '#/components/schemas/waitingroom_rule_description' enabled: $ref: '#/components/schemas/waitingroom_rule_enabled' expression: $ref: '#/components/schemas/waitingroom_rule_expression' waitingroom_custom_page_html: type: string description: |- Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: 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. default: "" example: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}' waitingroom_default_template_language: type: string description: The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. enum: - en-US - es-ES - de-DE - fr-FR - it-IT - ja-JP - ko-KR - pt-BR - zh-CN - zh-TW - nl-NL - pl-PL - id-ID - tr-TR - ar-EG - ru-RU - fa-IR default: en-US example: es-ES waitingroom_description: type: string description: A note that you can use to add more details about the waiting room. default: "" example: Production - DO NOT MODIFY waitingroom_disable_session_renewal: type: boolean description: Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request. default: false example: false waitingroom_estimated_queued_users: type: integer waitingroom_estimated_total_active_users: type: integer waitingroom_event_custom_page_html: type: string description: If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. example: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}' nullable: true waitingroom_event_description: type: string description: A note that you can use to add more details about the event. default: "" example: Production event - DO NOT MODIFY waitingroom_event_details_custom_page_html: type: string example: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}' waitingroom_event_details_disable_session_renewal: type: boolean example: false waitingroom_event_details_new_users_per_minute: type: integer waitingroom_event_details_queueing_method: type: string example: random 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: type: object properties: created_on: $ref: '#/components/schemas/waitingroom_timestamp' custom_page_html: $ref: '#/components/schemas/waitingroom_event_details_custom_page_html' description: $ref: '#/components/schemas/waitingroom_event_description' disable_session_renewal: $ref: '#/components/schemas/waitingroom_event_details_disable_session_renewal' event_end_time: $ref: '#/components/schemas/waitingroom_event_end_time' event_start_time: $ref: '#/components/schemas/waitingroom_event_start_time' id: $ref: '#/components/schemas/waitingroom_event_id' modified_on: $ref: '#/components/schemas/waitingroom_timestamp' name: $ref: '#/components/schemas/waitingroom_event_name' new_users_per_minute: $ref: '#/components/schemas/waitingroom_event_details_new_users_per_minute' prequeue_start_time: $ref: '#/components/schemas/waitingroom_event_prequeue_start_time' queueing_method: $ref: '#/components/schemas/waitingroom_event_details_queueing_method' session_duration: $ref: '#/components/schemas/waitingroom_event_details_session_duration' shuffle_at_event_start: $ref: '#/components/schemas/waitingroom_event_shuffle_at_event_start' suspended: $ref: '#/components/schemas/waitingroom_event_suspended' total_active_users: $ref: '#/components/schemas/waitingroom_event_details_total_active_users' waitingroom_event_details_session_duration: type: integer waitingroom_event_details_total_active_users: type: integer waitingroom_event_disable_session_renewal: type: boolean description: If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. nullable: true waitingroom_event_end_time: type: string description: An ISO 8601 timestamp that marks the end of the event. example: "2021-09-28T17:00:00.000Z" waitingroom_event_id: type: string example: 25756b2dfe6e378a06b033b670413757 waitingroom_event_id_response: allOf: - $ref: '#/components/schemas/waitingroom_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/waitingroom_event_id' waitingroom_event_name: type: string description: A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. example: production_webinar_event waitingroom_event_new_users_per_minute: type: integer description: If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set. nullable: true minimum: 200 maximum: 2.147483647e+09 waitingroom_event_prequeue_start_time: type: string description: An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. example: "2021-09-28T15:00:00.000Z" nullable: true waitingroom_event_queueing_method: type: string description: If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. example: random nullable: true 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: type: array items: $ref: '#/components/schemas/waitingroom_event_result' waitingroom_event_result: type: object properties: created_on: $ref: '#/components/schemas/waitingroom_timestamp' custom_page_html: $ref: '#/components/schemas/waitingroom_event_custom_page_html' description: $ref: '#/components/schemas/waitingroom_event_description' disable_session_renewal: $ref: '#/components/schemas/waitingroom_event_disable_session_renewal' event_end_time: $ref: '#/components/schemas/waitingroom_event_end_time' event_start_time: $ref: '#/components/schemas/waitingroom_event_start_time' id: $ref: '#/components/schemas/waitingroom_event_id' modified_on: $ref: '#/components/schemas/waitingroom_timestamp' name: $ref: '#/components/schemas/waitingroom_event_name' new_users_per_minute: $ref: '#/components/schemas/waitingroom_event_new_users_per_minute' prequeue_start_time: $ref: '#/components/schemas/waitingroom_event_prequeue_start_time' queueing_method: $ref: '#/components/schemas/waitingroom_event_queueing_method' session_duration: $ref: '#/components/schemas/waitingroom_event_session_duration' shuffle_at_event_start: $ref: '#/components/schemas/waitingroom_event_shuffle_at_event_start' suspended: $ref: '#/components/schemas/waitingroom_event_suspended' total_active_users: $ref: '#/components/schemas/waitingroom_event_total_active_users' waitingroom_event_session_duration: type: integer description: If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. nullable: true minimum: 1 maximum: 30 waitingroom_event_shuffle_at_event_start: type: boolean description: If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. default: false waitingroom_event_start_time: type: string description: An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`. example: "2021-09-28T15:30:00.000Z" waitingroom_event_suspended: type: boolean description: Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. default: false waitingroom_event_total_active_users: type: integer description: If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set. nullable: true minimum: 200 maximum: 2.147483647e+09 waitingroom_host: type: string description: The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. example: shop.example.com waitingroom_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 waitingroom_json_response_enabled: type: boolean description: "Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields:\n1. `inWaitingRoom`: Boolean indicating if the user is in the waiting room (always **true**).\n2. `waitTimeKnown`: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available.\n3. `waitTime`: Valid only when `waitTimeKnown` is **true**. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When `queueingMethod` is **random**, this is set to `waitTime50Percentile`.\n4. `waitTime25Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).\n5. `waitTime50Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before `waitTime50Percentile` and half are expected to be let in after it.\n6. `waitTime75Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).\n7. `waitTimeFormatted`: String displaying the `waitTime` formatted in English for users. If `waitTimeKnown` is **false**, `waitTimeFormatted` will display **unavailable**.\n8. `queueIsFull`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n9. `queueAll`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.\n10. `lastUpdated`: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after `refreshIntervalSeconds` past this time. If the user makes a request too soon, it will be ignored and `lastUpdated` will not change.\n11. `refreshIntervalSeconds`: Integer indicating the number of seconds after `lastUpdated` until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the `queueingMethod` is `reject`, there is no specified refresh time — it will always be **zero**.\n12. `queueingMethod`: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**.\n13. `isFIFOQueue`: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.\n14. `isRandomQueue`: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.\n15. `isPassthroughQueue`: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when `queueAll` is **true** or `isEventPrequeueing` is **true** because in all other cases requests will go directly to the origin.\n16. `isRejectQueue`: Boolean indicating if the waiting room uses a reject queue.\n17. `isEventActive`: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties `prequeue_start_time`, `event_start_time`, and `event_end_time` in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.\n18. `isEventPrequeueing`: Valid only when `isEventActive` is **true**. Boolean indicating if an event is currently prequeueing users before it starts.\n19. `timeUntilEventStart`: Valid only when `isEventPrequeueing` is **true**. Integer indicating the number of minutes until the event starts.\n20. `timeUntilEventStartFormatted`: String displaying the `timeUntilEventStart` formatted in English for users. If `isEventPrequeueing` is **false**, `timeUntilEventStartFormatted` will display **unavailable**.\n21. `timeUntilEventEnd`: Valid only when `isEventActive` is **true**. Integer indicating the number of minutes until the event ends.\n22. `timeUntilEventEndFormatted`: String displaying the `timeUntilEventEnd` formatted in English for users. If `isEventActive` is **false**, `timeUntilEventEndFormatted` will display **unavailable**.\n23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.\n\nAn example cURL to a waiting room could be:\n\n\tcurl -X GET \"https://example.com/waitingroom\" \\\n\t\t-H \"Accept: application/json\"\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **fifo** and no event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 0,\n\t\t\t\"waitTime50Percentile\": 0,\n\t\t\t\"waitTime75Percentile\": 0,\n\t\t\t\"waitTimeFormatted\": \"10 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"fifo\",\n\t\t\t\"isFIFOQueue\": true,\n\t\t\t\"isRandomQueue\": false,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": false,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 0,\n\t\t\t\"timeUntilEventEndFormatted\": \"unavailable\",\n\t\t\t\"shuffleAtEventStart\": false\n\t\t}\n\t}\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **random** and an event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 5,\n\t\t\t\"waitTime50Percentile\": 10,\n\t\t\t\"waitTime75Percentile\": 15,\n\t\t\t\"waitTimeFormatted\": \"5 minutes to 15 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"random\",\n\t\t\t\"isFIFOQueue\": false,\n\t\t\t\"isRandomQueue\": true,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": true,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 15,\n\t\t\t\"timeUntilEventEndFormatted\": \"15 minutes\",\n\t\t\t\"shuffleAtEventStart\": true\n\t\t}\n\t}." default: false example: false waitingroom_max_estimated_time_minutes: type: integer waitingroom_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string waitingroom_name: type: string description: A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. example: production_webinar waitingroom_new_users_per_minute: type: integer description: Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world. minimum: 200 maximum: 2.147483647e+09 waitingroom_next_event_prequeue_start_time: type: string description: An ISO 8601 timestamp that marks when the next event will begin queueing. example: "2021-09-28T15:00:00.000Z" nullable: true waitingroom_next_event_start_time: type: string description: An ISO 8601 timestamp that marks when the next event will start. example: "2021-09-28T15:00:00.000Z" nullable: true waitingroom_patch_rule: required: - action - expression properties: action: $ref: '#/components/schemas/waitingroom_rule_action' description: $ref: '#/components/schemas/waitingroom_rule_description' enabled: $ref: '#/components/schemas/waitingroom_rule_enabled' expression: $ref: '#/components/schemas/waitingroom_rule_expression' position: $ref: '#/components/schemas/waitingroom_rule_position' waitingroom_path: type: string description: Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. default: / example: /shop/checkout waitingroom_preview_response: allOf: - $ref: '#/components/schemas/waitingroom_api-response-single' - properties: result: type: object properties: preview_url: $ref: '#/components/schemas/waitingroom_preview_url' waitingroom_preview_url: type: string description: URL where the custom waiting room page can temporarily be previewed. example: http://waitingrooms.dev/preview/35af8c12-6d68-4608-babb-b53435a5ddfb waitingroom_query_event: type: object required: - name - event_start_time - event_end_time properties: custom_page_html: $ref: '#/components/schemas/waitingroom_event_custom_page_html' description: $ref: '#/components/schemas/waitingroom_event_description' disable_session_renewal: $ref: '#/components/schemas/waitingroom_event_disable_session_renewal' event_end_time: $ref: '#/components/schemas/waitingroom_event_end_time' event_start_time: $ref: '#/components/schemas/waitingroom_event_start_time' name: $ref: '#/components/schemas/waitingroom_event_name' new_users_per_minute: $ref: '#/components/schemas/waitingroom_event_new_users_per_minute' prequeue_start_time: $ref: '#/components/schemas/waitingroom_event_prequeue_start_time' queueing_method: $ref: '#/components/schemas/waitingroom_event_queueing_method' session_duration: $ref: '#/components/schemas/waitingroom_event_session_duration' shuffle_at_event_start: $ref: '#/components/schemas/waitingroom_event_shuffle_at_event_start' suspended: $ref: '#/components/schemas/waitingroom_event_suspended' total_active_users: $ref: '#/components/schemas/waitingroom_event_total_active_users' waitingroom_query_preview: type: object required: - custom_html properties: custom_html: $ref: '#/components/schemas/waitingroom_custom_page_html' waitingroom_query_waitingroom: type: object required: - name - host - new_users_per_minute - total_active_users properties: additional_routes: $ref: '#/components/schemas/waitingroom_additional_routes' cookie_attributes: $ref: '#/components/schemas/waitingroom_cookie_attributes' cookie_suffix: $ref: '#/components/schemas/waitingroom_cookie_suffix' custom_page_html: $ref: '#/components/schemas/waitingroom_custom_page_html' default_template_language: $ref: '#/components/schemas/waitingroom_default_template_language' description: $ref: '#/components/schemas/waitingroom_description' disable_session_renewal: $ref: '#/components/schemas/waitingroom_disable_session_renewal' host: $ref: '#/components/schemas/waitingroom_host' json_response_enabled: $ref: '#/components/schemas/waitingroom_json_response_enabled' name: $ref: '#/components/schemas/waitingroom_name' new_users_per_minute: $ref: '#/components/schemas/waitingroom_new_users_per_minute' path: $ref: '#/components/schemas/waitingroom_path' queue_all: $ref: '#/components/schemas/waitingroom_queue_all' queueing_method: $ref: '#/components/schemas/waitingroom_queueing_method' queueing_status_code: $ref: '#/components/schemas/waitingroom_queueing_status_code' session_duration: $ref: '#/components/schemas/waitingroom_session_duration' suspended: $ref: '#/components/schemas/waitingroom_suspended' total_active_users: $ref: '#/components/schemas/waitingroom_total_active_users' waitingroom_queue_all: type: boolean description: If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable. default: false example: true waitingroom_queueing_method: type: string description: |- Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are: 1. `fifo` **(default)**: First-In-First-Out queue where customers gain access in the order they arrived. 2. `random`: Random queue where customers gain access randomly, regardless of arrival time. 3. `passthrough`: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa. 4. `reject`: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`, `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is prequeueing, the waiting room page **will not refresh automatically**. enum: - fifo - random - passthrough - reject default: fifo example: fifo waitingroom_queueing_status_code: type: integer description: HTTP status code returned to a user while in the queue. enum: - 200 - 202 - 429 default: 200 example: 202 waitingroom_response_collection: allOf: - $ref: '#/components/schemas/waitingroom_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/waitingroom_waitingroom' waitingroom_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 waitingroom_rule_action: type: string description: The action to take when the expression matches. enum: - bypass_waiting_room example: bypass_waiting_room waitingroom_rule_description: type: string description: The description of the rule. default: "" example: allow all traffic from 10.20.30.40 waitingroom_rule_enabled: type: boolean description: When set to true, the rule is enabled. default: true example: true waitingroom_rule_expression: type: string description: Criteria defining when there is a match for the current rule. example: ip.src in {10.20.30.40} waitingroom_rule_id: type: string description: The ID of the rule. example: 25756b2dfe6e378a06b033b670413757 waitingroom_rule_position: oneOf: - type: object properties: index: type: integer description: ' Places the rule in the exact position specified by the integer number . Position numbers start with 1. Existing rules in the ruleset from the specified position number onward are shifted one position (no rule is overwritten).' - type: object properties: before: type: string description: ' Places the rule before rule . Use this argument with an empty rule ID value ("") to set the rule as the first rule in the ruleset.' example: - type: object properties: after: type: string description: Places the rule after rule . Use this argument with an empty rule ID value ("") to set the rule as the last rule in the ruleset. example: type: object description: Reorder the position of a rule waitingroom_rule_result: type: object properties: action: $ref: '#/components/schemas/waitingroom_rule_action' description: $ref: '#/components/schemas/waitingroom_rule_description' enabled: $ref: '#/components/schemas/waitingroom_rule_enabled' expression: $ref: '#/components/schemas/waitingroom_rule_expression' id: $ref: '#/components/schemas/waitingroom_rule_id' last_updated: $ref: '#/components/schemas/waitingroom_timestamp' version: $ref: '#/components/schemas/waitingroom_rule_version' waitingroom_rule_version: type: string description: The version of the rule. example: "1" waitingroom_rules_response_collection: allOf: - $ref: '#/components/schemas/waitingroom_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/waitingroom_rule_result' waitingroom_schemas-api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/waitingroom_messages' messages: $ref: '#/components/schemas/waitingroom_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true waitingroom_search_engine_crawler_bypass: type: boolean description: | Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. Verified search engine crawlers will not be tracked or counted by the waiting room system, and will not appear in waiting room analytics. default: false example: true waitingroom_session_duration: type: integer description: Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route. default: 5 minimum: 1 maximum: 30 waitingroom_single_response: allOf: - $ref: '#/components/schemas/waitingroom_api-response-single' - properties: result: $ref: '#/components/schemas/waitingroom_waitingroom' waitingroom_status: type: string enum: - event_prequeueing - not_queueing - queueing example: queueing waitingroom_status_event_id: type: string example: 25756b2dfe6e378a06b033b670413757 waitingroom_status_response: allOf: - $ref: '#/components/schemas/waitingroom_api-response-single' - properties: result: type: object properties: estimated_queued_users: $ref: '#/components/schemas/waitingroom_estimated_queued_users' estimated_total_active_users: $ref: '#/components/schemas/waitingroom_estimated_total_active_users' event_id: $ref: '#/components/schemas/waitingroom_status_event_id' max_estimated_time_minutes: $ref: '#/components/schemas/waitingroom_max_estimated_time_minutes' status: $ref: '#/components/schemas/waitingroom_status' waitingroom_suspended: type: boolean description: Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. default: false waitingroom_timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true waitingroom_total_active_users: type: integer description: Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world. minimum: 200 maximum: 2.147483647e+09 waitingroom_update_rules: type: array items: $ref: '#/components/schemas/waitingroom_create_rule' waitingroom_waiting_room_id: type: string example: 699d98642c564d2e855e9661899b7252 waitingroom_waiting_room_id_response: allOf: - $ref: '#/components/schemas/waitingroom_api-response-single' - properties: result: type: object properties: id: $ref: '#/components/schemas/waitingroom_waiting_room_id' waitingroom_waitingroom: type: object properties: additional_routes: $ref: '#/components/schemas/waitingroom_additional_routes' cookie_attributes: $ref: '#/components/schemas/waitingroom_cookie_attributes' cookie_suffix: $ref: '#/components/schemas/waitingroom_cookie_suffix' created_on: $ref: '#/components/schemas/waitingroom_timestamp' custom_page_html: $ref: '#/components/schemas/waitingroom_custom_page_html' default_template_language: $ref: '#/components/schemas/waitingroom_default_template_language' description: $ref: '#/components/schemas/waitingroom_description' disable_session_renewal: $ref: '#/components/schemas/waitingroom_disable_session_renewal' host: $ref: '#/components/schemas/waitingroom_host' id: $ref: '#/components/schemas/waitingroom_waiting_room_id' json_response_enabled: $ref: '#/components/schemas/waitingroom_json_response_enabled' modified_on: $ref: '#/components/schemas/waitingroom_timestamp' name: $ref: '#/components/schemas/waitingroom_name' new_users_per_minute: $ref: '#/components/schemas/waitingroom_new_users_per_minute' next_event_prequeue_start_time: $ref: '#/components/schemas/waitingroom_next_event_prequeue_start_time' next_event_start_time: $ref: '#/components/schemas/waitingroom_next_event_start_time' path: $ref: '#/components/schemas/waitingroom_path' queue_all: $ref: '#/components/schemas/waitingroom_queue_all' queueing_method: $ref: '#/components/schemas/waitingroom_queueing_method' queueing_status_code: $ref: '#/components/schemas/waitingroom_queueing_status_code' session_duration: $ref: '#/components/schemas/waitingroom_session_duration' suspended: $ref: '#/components/schemas/waitingroom_suspended' total_active_users: $ref: '#/components/schemas/waitingroom_total_active_users' waitingroom_zone_settings: type: object properties: search_engine_crawler_bypass: $ref: '#/components/schemas/waitingroom_search_engine_crawler_bypass' waitingroom_zone_settings_response: allOf: - $ref: '#/components/schemas/waitingroom_api-response-single' - required: - result properties: result: type: object required: - search_engine_crawler_bypass properties: search_engine_crawler_bypass: $ref: '#/components/schemas/waitingroom_search_engine_crawler_bypass' workers-kv_api-response-collection: allOf: - $ref: '#/components/schemas/workers-kv_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/workers-kv_result_info' type: object workers-kv_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/workers-kv_messages' messages: $ref: '#/components/schemas/workers-kv_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true workers-kv_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false workers-kv_api-response-single: allOf: - $ref: '#/components/schemas/workers-kv_api-response-common' - properties: result: anyOf: - type: object - type: string type: object workers-kv_bulk_delete: type: array items: $ref: '#/components/schemas/workers-kv_key_name_bulk' workers-kv_bulk_write: type: array items: type: object properties: base64: type: boolean description: Whether or not the server should base64 decode the value before storing it. Useful for writing values that wouldn't otherwise be valid JSON strings, such as images. default: false expiration: $ref: '#/components/schemas/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: type: string description: A UTF-8 encoded string to be stored, up to 25 MiB in length. example: Some string maxLength: 26214400 required: - key - value 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: type: object required: - title properties: title: $ref: '#/components/schemas/workers-kv_namespace_title' workers-kv_cursor: type: string description: Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure. example: 6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw workers-kv_expiration: type: number description: The time, measured in number of seconds since the UNIX epoch, at which the key should expire. example: 1.578435e+09 workers-kv_expiration_ttl: type: number description: The number of seconds for which the key should be visible before it expires. At least 60. example: 300 workers-kv_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 workers-kv_key: type: object description: A name for a value. A value stored under a given key may be retrieved via the same key. required: - name properties: expiration: type: number description: The time, measured in number of seconds since the UNIX epoch, at which the key will expire. This property is omitted for keys that will not expire. example: 1.5778368e+09 metadata: $ref: '#/components/schemas/workers-kv_list_metadata' name: $ref: '#/components/schemas/workers-kv_key_name' workers-kv_key_name: type: string description: A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid. Use percent-encoding to define key names as part of a URL. example: My-Key maxLength: 512 workers-kv_key_name_bulk: type: string description: A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid. example: My-Key maxLength: 512 workers-kv_list_metadata: type: object description: Arbitrary JSON that is associated with a key. example: someMetadataKey: someMetadataValue workers-kv_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string workers-kv_metadata: type: string description: Arbitrary JSON to be associated with a key/value pair. example: '{"someMetadataKey": "someMetadataValue"}' workers-kv_namespace: type: object required: - id - title properties: id: $ref: '#/components/schemas/workers-kv_namespace_identifier' supports_url_encoding: type: boolean description: True if keys written on the URL will be URL-decoded before storing. For example, if set to "true", a key written on the URL as "%3F" will be stored as "?". example: true readOnly: true title: $ref: '#/components/schemas/workers-kv_namespace_title' workers-kv_namespace_identifier: type: string description: Namespace identifier tag. example: 0f2ac74b498b48028cb68387c421e279 readOnly: true maxLength: 32 workers-kv_namespace_title: type: string description: A human-readable string name for a Namespace. example: My Own Namespace workers-kv_query: type: object description: For specifying result metrics. properties: dimensions: type: array description: Can be used to break down the data by given attributes. default: '[]' items: type: string description: For drilling down on metrics. filters: type: string description: |- Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: 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 . default: '""' limit: type: integer description: Limit number of returned metrics. default: 10000 metrics: type: array description: One or more metrics to compute. items: type: string description: A quantitative measurement of KV usage. since: type: string format: date-time description: Start of time interval to query, defaults to 6 hours before request received. default: <6 hours ago> example: "2019-01-02T02:20:00Z" sort: type: array description: Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending). default: '[]' items: {} until: type: string format: date-time description: End of time interval to query, defaults to current time. default: example: "2019-01-02T03:20:00Z" workers-kv_result: type: object description: Metrics on Workers KV requests. required: - rows - data - data_lag - min - max - totals - query properties: data: type: array nullable: true items: type: object required: - metrics properties: metrics: type: array description: List of metrics returned by the query. items: {} data_lag: type: number description: Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing. example: 0 minimum: 0 max: description: Maximum results for each metric. min: description: Minimum results for each metric. query: $ref: '#/components/schemas/workers-kv_query' rows: type: number description: Total number of rows in the result. example: 2 minimum: 0 totals: description: Total results for metrics across all data. workers-kv_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 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: type: string description: A byte sequence to be stored, up to 25 MiB in length. example: Some Value workers_account-settings-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: object properties: default_usage_model: readOnly: true green_compute: readOnly: true workers_account_identifier: example: 9a7806061c88ada191ed06f989cc3dac workers_api-response-collection: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/workers_result_info' type: object workers_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/workers_messages' messages: $ref: '#/components/schemas/workers_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true workers_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/workers_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/workers_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false workers_api-response-single: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: anyOf: - type: object - type: string type: object workers_api-response-single-id: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: object nullable: true required: - id properties: id: $ref: '#/components/schemas/workers_identifier' type: object workers_binding: 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 description: A binding to allow the Worker to communicate with resources workers_binding_name: type: string description: A JavaScript variable name for the binding. example: myBinding readOnly: true workers_bindings: type: array description: List of bindings attached to this Worker items: $ref: '#/components/schemas/workers_binding' workers_compatibility_date: type: string description: Opt your Worker into changes after this date example: "2022-04-05" workers_compatibility_flag: type: string description: A flag to opt into a specific change example: formdata_parser_supports_files workers_compatibility_flags: type: array description: Opt your Worker into specific changes items: $ref: '#/components/schemas/workers_compatibility_flag' workers_created_on: type: string format: date-time description: When the script was created. example: "2017-01-01T00:00:00Z" readOnly: true workers_cron-trigger-response-collection: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: object properties: schedules: type: array items: properties: created_on: readOnly: true cron: readOnly: true modified_on: readOnly: true workers_cursor: type: string description: Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure. example: AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc workers_d1_binding: type: object required: - id - name - type - binding properties: binding: $ref: '#/components/schemas/workers_binding_name' id: type: string description: ID of the D1 database to bind to example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx name: type: string description: The name of the D1 database associated with the 'id' provided. example: prod-database-auth type: type: string description: The class of resource that the binding provides. enum: - d1 example: d1 workers_deployment_identifier: type: string example: bcf48806-b317-4351-9ee7-36e7d557d4de readOnly: true maxLength: 36 workers_deployments-base: type: object properties: annotations: type: object properties: workers/message: type: string description: Human-readable message about the deployment. example: Deploy bug fix. maxLength: 50 author_email: type: string example: user@example.com readOnly: true created_on: type: string example: "2022-11-08T17:19:29.176266Z" readOnly: true id: allOf: - $ref: '#/components/schemas/workers_schemas-deployment_identifier' readOnly: true source: type: string example: api readOnly: true strategy: type: string 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: type: object properties: items: type: array example: - id: bcf48806-b317-4351-9ee7-36e7d557d4de metadata: author_email: user@example.com author_id: 408cbcdfd4dda4617efef40b04d168a1 created_on: "2022-11-15T18:25:44.442097Z" modified_on: "2022-11-15T18:25:44.442097Z" source: api number: 2 - id: 18f97339-c287-4872-9bdd-e2135c07ec12 metadata: author_email: user@example.com author_id: 408cbcdfd4dda4617efef40b04d168a1 created_on: "2022-11-08T17:30:56.968096Z" modified_on: "2022-11-08T17:30:56.968096Z" source: api number: 1 items: {} latest: type: object example: id: bcf48806-b317-4351-9ee7-36e7d557d4de metadata: author_email: user@example.com author_id: 408cbcdfd4dda4617efef40b04d168a1 created_on: "2022-11-15T18:25:44.442097Z" modified_on: "2022-11-15T18:25:44.442097Z" source: api number: 2 resources: bindings: - json: example_binding name: JSON_VAR type: json script: etag: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794 handlers: - fetch last_deployed_from: api script_runtime: usage_model: bundled workers_deployments-single-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: object properties: id: type: string example: 18f97339-c287-4872-9bdd-e2135c07ec12 metadata: type: object example: author_email: user@example.com author_id: 408cbcdfd4dda4617efef40b04d168a1 created_on: "2022-11-08T17:19:29.176266Z" modified_on: "2022-11-08T17:19:29.176266Z" source: api number: type: number example: 1 resources: type: object example: bindings: - json: example_binding name: JSON_VAR type: json script: etag: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794 handlers: - fetch last_deployed_from: api script_runtime: usage_model: bundled workers_deployments-strategy-percentage: type: object required: - strategy - versions properties: strategy: type: string enum: - percentage versions: type: array items: type: object required: - version_id - percentage properties: percentage: type: number minimum: 0 maximum: 100 version_id: $ref: '#/components/schemas/workers_schemas-version_identifier' workers_dispatch_namespace_binding: type: object required: - name - type - namespace properties: name: $ref: '#/components/schemas/workers_binding_name' namespace: type: string description: Namespace to bind to example: my-namespace outbound: type: object description: Outbound worker properties: params: type: array description: Pass information from the Dispatch Worker to the Outbound Worker through the parameters items: type: string example: url worker: type: object description: Outbound worker properties: environment: type: string description: Environment of the outbound worker service: type: string description: Name of the outbound worker type: type: string description: The class of resource that the binding provides. enum: - dispatch_namespace example: dispatch_namespace workers_dispatch_namespace_name: type: string description: Name of the Workers for Platforms dispatch namespace. example: my-dispatch-namespace pattern: ^.+$ workers_do_binding: type: object required: - name - type - class_name properties: class_name: type: string description: The exported class name of the Durable Object example: MyDurableObject environment: type: string description: The environment of the script_name to bind to example: production name: $ref: '#/components/schemas/workers_binding_name' namespace_id: $ref: '#/components/schemas/workers_namespace_identifier' script_name: type: string description: The script where the Durable Object is defined, if it is external to this Worker example: my-other-worker type: type: string description: The class of resource that the binding provides. enum: - durable_object_namespace example: durable_object_namespace workers_domain: type: object 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' workers_domain-response-collection: allOf: - $ref: '#/components/schemas/workers_api-response-common' - type: object properties: result: type: array items: $ref: '#/components/schemas/workers_domain' workers_domain-response-single: allOf: - $ref: '#/components/schemas/workers_api-response-common' - type: object properties: result: $ref: '#/components/schemas/workers_domain' workers_domain_identifier: description: Identifer of the Worker Domain. example: dbe10b4bc17c295377eabd600e1787fd workers_enabled: type: boolean title: Whether or not this filter will run a script example: true workers_environment: type: string description: Optional environment if the Worker utilizes one. example: production workers_etag: type: string description: Hashed script content, can be used in a If-None-Match header when updating. example: ea95132c15732412d22c1476fa83f27a readOnly: true workers_filter-no-id: required: - pattern - enabled properties: enabled: $ref: '#/components/schemas/workers_enabled' pattern: $ref: '#/components/schemas/workers_schemas-pattern' workers_filter-response-collection: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/workers_filters' workers_filter-response-single: allOf: - $ref: '#/components/schemas/workers_api-response-single' - properties: result: $ref: '#/components/schemas/workers_filters' workers_filters: type: object required: - id - pattern - enabled properties: enabled: $ref: '#/components/schemas/workers_enabled' id: $ref: '#/components/schemas/workers_identifier' pattern: $ref: '#/components/schemas/workers_schemas-pattern' workers_hostname: type: string description: Hostname of the Worker Domain. example: foo.example.com workers_id: type: string description: Identifier for the tail. example: 03dc9f77817b488fb26c5861ec18f791 workers_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 workers_kv_namespace_binding: type: object required: - name - type - namespace_id properties: name: $ref: '#/components/schemas/workers_binding_name' namespace_id: $ref: '#/components/schemas/workers_namespace_identifier' type: type: string description: The class of resource that the binding provides. enum: - kv_namespace example: kv_namespace workers_limits: type: object description: Limits to apply for this Worker. properties: cpu_ms: type: integer description: The amount of CPU time this Worker can use in milliseconds. example: 50 workers_logpush: type: boolean description: Whether Logpush is turned on for the Worker. example: false workers_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string workers_migration_step: type: object properties: deleted_classes: type: array description: A list of classes to delete Durable Object namespaces from. items: type: string new_classes: type: array description: A list of classes to create Durable Object namespaces from. items: type: string renamed_classes: type: array description: A list of classes with Durable Object namespaces that were renamed. items: type: object properties: from: type: string to: type: string transferred_classes: type: array description: A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker. items: type: object properties: from: type: string from_script: type: string to: type: string workers_migration_tag_conditions: type: object properties: new_tag: type: string description: Tag to set as the latest migration tag. example: v2 old_tag: type: string description: Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected. example: v1 workers_modified_on: type: string format: date-time description: When the script was last modified. example: "2017-01-01T00:00:00Z" readOnly: true workers_mtls_cert_binding: type: object required: - name - type - certificate properties: certificate_id: type: string description: ID of the certificate to bind to example: efwu2n6s-q69d-2kr9-184j-4913e8h391k6 name: $ref: '#/components/schemas/workers_binding_name' type: type: string description: The class of resource that the binding provides. enum: - mtls_certificate example: mtls_certificate workers_namespace: type: object properties: class: readOnly: true id: readOnly: true name: readOnly: true script: readOnly: true workers_namespace-delete-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: object enum: - null nullable: true workers_namespace-list-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/workers_namespace-response' 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: type: object 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' 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: type: string description: Namespace identifier tag. example: 0f2ac74b498b48028cb68387c421e279 readOnly: true maxLength: 32 workers_object: type: object properties: hasStoredData: type: boolean description: Whether the Durable Object has stored data. example: true readOnly: true id: type: string description: ID of the Durable Object. example: fe7803fc55b964e09d94666545aab688d360c6bda69ba349ced1e5f28d2fc2c8 readOnly: true workers_pattern: type: string title: Route pattern example: example.net/* workers_placement_config: type: object properties: mode: type: string description: Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). Only `"smart"` is currently supported enum: - smart workers_placement_mode: type: string description: Specifies the placement mode for the Worker (e.g. 'smart'). example: smart workers_queue_binding: type: object required: - name - type - queue_name properties: name: $ref: '#/components/schemas/workers_binding_name' queue_name: type: string description: Name of the Queue to bind to example: my-queue type: type: string description: The class of resource that the binding provides. enum: - queue example: queue workers_r2_binding: type: object required: - name - type - bucket_name properties: bucket_name: type: string description: R2 bucket to bind to example: my-r2-bucket name: $ref: '#/components/schemas/workers_binding_name' type: type: string description: The class of resource that the binding provides. enum: - r2_bucket example: r2_bucket workers_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 workers_route-no-id: required: - pattern properties: pattern: $ref: '#/components/schemas/workers_pattern' script: $ref: '#/components/schemas/workers_script_name' workers_route-response-collection: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/workers_routes' workers_route-response-single: allOf: - $ref: '#/components/schemas/workers_api-response-single' - properties: result: $ref: '#/components/schemas/workers_routes' workers_routes: type: object required: - id - pattern - script properties: id: $ref: '#/components/schemas/workers_identifier' pattern: $ref: '#/components/schemas/workers_pattern' script: $ref: '#/components/schemas/workers_script_name' workers_schemas-binding: oneOf: - $ref: '#/components/schemas/workers_kv_namespace_binding' - $ref: '#/components/schemas/workers_wasm_module_binding' workers_schemas-deployment_identifier: type: string example: dc78f0bc-05c5-46b7-bb4e-137f55930378 maxLength: 36 workers_schemas-deployments-list-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - type: object properties: result: type: object properties: deployments: type: array items: allOf: - $ref: '#/components/schemas/workers_deployments-base' - oneOf: - $ref: '#/components/schemas/workers_deployments-strategy-percentage' workers_schemas-deployments-single-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - type: object properties: result: allOf: - $ref: '#/components/schemas/workers_deployments-base' - oneOf: - $ref: '#/components/schemas/workers_deployments-strategy-percentage' workers_schemas-environment: type: string description: Worker environment associated with the zone and hostname. example: production workers_schemas-id: type: string description: ID of the namespace. example: 5fd1cafff895419c8bcc647fc64ab8f0 workers_schemas-pattern: type: string title: Filter pattern example: example.net/* workers_schemas-script-response-single: allOf: - $ref: '#/components/schemas/workers_api-response-single' - properties: result: type: object workers_schemas-script_name: type: string description: Name of the script. example: this-is_my_script-01 pattern: ^[a-z0-9_][a-z0-9-_]*$ workers_schemas-service: type: string description: Worker service associated with the zone and hostname. example: foo workers_schemas-version_identifier: type: string example: bcf48806-b317-4351-9ee7-36e7d557d4de maxLength: 36 workers_script-and-version-settings-item: type: object 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: oneOf: - $ref: '#/components/schemas/workers_single_step_migrations' - $ref: '#/components/schemas/workers_stepped_migrations' description: | Migrations to apply for Durable Objects associated with this Worker. 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' 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: type: string description: The id of the script in the Workers system. Usually the script name. example: my-workers-script readOnly: true 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: type: array items: $ref: '#/components/schemas/workers_script-response' workers_script-response-single: allOf: - $ref: '#/components/schemas/workers_api-response-single' - properties: result: $ref: '#/components/schemas/workers_script-response' workers_script-settings-item: type: object properties: logpush: $ref: '#/components/schemas/workers_logpush' tail_consumers: $ref: '#/components/schemas/workers_tail_consumers' workers_script-settings-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: $ref: '#/components/schemas/workers_script-settings-item' workers_script_count: type: integer description: The current number of scripts in this Dispatch Namespace example: 800 workers_script_identifier: type: string example: 8ee82b3a2c0f42928b8f14dae4a97121 readOnly: true maxLength: 32 workers_script_name: type: string description: Name of the script, used in URLs and route configuration. example: this-is_my_script-01 pattern: ^[a-z0-9_][a-z0-9-_]*$ workers_secret: type: object properties: name: type: string description: The name of this secret, this is what will be to access it inside the Worker. example: MY_SECRET text: type: string description: The value of the secret. example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 type: type: string description: The type of secret to put. enum: - secret_text example: secret_text workers_secret-response: type: object properties: name: type: string description: The name of this secret, this is what will be to access it inside the Worker. example: MY_SECRET type: type: string description: The type of secret to put. enum: - secret_text example: secret_text workers_service: type: string description: Name of Worker to bind to example: my-worker workers_service_binding: type: object required: - name - type - service - environment properties: environment: type: string description: Optional environment if the Worker utilizes one. example: production name: $ref: '#/components/schemas/workers_binding_name' service: type: string description: Name of Worker to bind to example: my-worker type: type: string description: The class of resource that the binding provides. enum: - service example: service 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' - type: object properties: steps: type: array description: Migrations to apply in order. items: $ref: '#/components/schemas/workers_migration_step' workers_subdomain-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: object properties: name: readOnly: true workers_tag: type: string description: Tag to help you manage your Worker example: my-tag workers_tags: type: array description: Tags to help you manage your Workers items: $ref: '#/components/schemas/workers_tag' workers_tail-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: object properties: expires_at: readOnly: true id: readOnly: true url: readOnly: true workers_tail_consumers: type: array description: List of Workers that will consume logs from the attached Worker. items: $ref: '#/components/schemas/workers_tail_consumers_script' workers_tail_consumers_script: type: object description: A reference to a script that will consume logs from the attached Worker. required: - service properties: environment: type: string description: Optional environment if the Worker utilizes one. example: production namespace: type: string description: Optional dispatch namespace the script belongs to. example: my-namespace service: type: string description: Name of Worker that is to be the consumer. example: my-log-consumer workers_usage-model-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: object properties: usage_model: readOnly: true workers_usage_model: type: string description: Specifies the usage model for the Worker (e.g. 'bundled' or 'unbound'). example: unbound pattern: ^(bundled|unbound)$ workers_uuid: type: string description: API Resource UUID tag. example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 maxLength: 36 workers_version-item-full: allOf: - $ref: '#/components/schemas/workers_version-item-short' - type: object required: - resources properties: resources: type: object example: bindings: - json: example_binding name: JSON_VAR type: json script: etag: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794 handlers: - fetch last_deployed_from: api script_runtime: usage_model: bundled readOnly: true workers_version-item-short: type: object properties: id: type: string example: 18f97339-c287-4872-9bdd-e2135c07ec12 readOnly: true metadata: type: object example: author_email: user@example.com author_id: 408cbcdfd4dda4617efef40b04d168a1 created_on: "2022-11-08T17:19:29.176266Z" modified_on: "2022-11-08T17:19:29.176266Z" source: api readOnly: true number: type: number example: 1 readOnly: true workers_version_identifier: type: string example: bcf48806-b317-4351-9ee7-36e7d557d4de readOnly: true maxLength: 36 workers_versions-list-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: object properties: items: type: array items: $ref: '#/components/schemas/workers_version-item-short' workers_versions-single-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: $ref: '#/components/schemas/workers_version-item-full' workers_wasm_module_binding: type: object required: - name - type properties: name: $ref: '#/components/schemas/workers_binding_name' type: type: string description: The class of resource that the binding provides. enum: - wasm_module example: wasm_module workers_zone_identifier: description: Identifier of the zone. example: 593c9c94de529bbbfaac7c53ced0447d workers_zone_name: type: string description: Name of the zone. example: example.com zaraz_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/zaraz_messages' messages: $ref: '#/components/schemas/zaraz_messages' success: type: boolean description: Whether the API call was successful example: true zaraz_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/zaraz_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/zaraz_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false zaraz_base-mc: allOf: - $ref: '#/components/schemas/zaraz_base-tool' - required: - component - settings - permissions properties: actions: type: object description: Actions configured on a tool. Either this or neoEvents field is required. component: type: string description: Tool's internal name neoEvents: type: array 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: type: object required: - actionType - blockingTriggers - firingTriggers - data properties: actionType: type: string description: Tool event type blockingTriggers: type: array description: List of blocking triggers IDs items: type: string data: type: object description: Event payload firingTriggers: type: array description: List of firing triggers IDs minItems: 1 items: type: string permissions: type: array description: List of permissions granted to the component items: type: string settings: type: object description: Tool's settings zaraz_base-tool: type: object required: - enabled - blockingTriggers - name - defaultFields properties: blockingTriggers: type: array description: List of blocking trigger IDs items: type: string defaultFields: type: object description: Default fields for tool's actions defaultPurpose: type: string description: Default consent purpose ID enabled: type: boolean description: Whether tool is enabled name: type: string description: Tool's name defined by the user vendorName: type: string description: Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned vendorPolicyUrl: type: string description: Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned zaraz_click-listener-rule: type: object required: - id - action - settings properties: action: type: string enum: - clickListener id: type: string settings: type: object required: - type - selector - waitForTags properties: selector: type: string type: type: string enum: - xpath - css waitForTags: type: integer minimum: 0 zaraz_custom-managed-component: allOf: - $ref: '#/components/schemas/zaraz_base-mc' - required: - worker - type properties: type: type: string enum: - custom-mc worker: type: object description: Cloudflare worker that acts as a managed component required: - workerTag - escapedWorkerName properties: escapedWorkerName: type: string workerTag: type: string zaraz_element-visibility-rule: type: object required: - id - action - settings properties: action: type: string enum: - elementVisibility id: type: string settings: type: object required: - selector properties: selector: type: string zaraz_form-submission-rule: type: object required: - id - action - settings properties: action: type: string enum: - formSubmission id: type: string settings: type: object required: - selector - validate properties: selector: type: string validate: type: boolean zaraz_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 zaraz_legacy-tool: allOf: - $ref: '#/components/schemas/zaraz_base-tool' - required: - library - neoEvents - type properties: library: type: string description: Tool's internal name neoEvents: type: array description: List of actions configured on a tool items: type: object required: - blockingTriggers - firingTriggers - data properties: blockingTriggers: type: array description: List of blocking triggers IDs items: type: string data: type: object description: Event payload firingTriggers: type: array description: List of firing triggers IDs minItems: 1 items: type: string type: type: string enum: - library zaraz_load-rule: type: object required: - id - match - op - value properties: id: type: string match: type: string op: type: string enum: - CONTAINS - EQUALS - STARTS_WITH - ENDS_WITH - MATCH_REGEX - NOT_MATCH_REGEX - GREATER_THAN - GREATER_THAN_OR_EQUAL - LESS_THAN - LESS_THAN_OR_EQUAL value: type: string zaraz_managed-component: allOf: - $ref: '#/components/schemas/zaraz_base-mc' - required: - type properties: type: type: string enum: - component zaraz_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string zaraz_scroll-depth-rule: type: object required: - id - action - settings properties: action: type: string enum: - scrollDepth id: type: string settings: type: object required: - positions properties: positions: type: string zaraz_timer-rule: type: object required: - id - action - settings properties: action: type: string enum: - timer id: type: string settings: type: object required: - interval - limit properties: interval: type: integer minimum: 50 limit: type: integer minimum: 0 zaraz_variable-match-rule: type: object required: - id - action - settings properties: action: type: string enum: - variableMatch id: type: string settings: type: object required: - variable - match properties: match: type: string variable: type: string zaraz_zaraz-config-base: type: object description: Zaraz configuration example: consent: cookieName: zaraz-consent customIntroDisclaimerDismissed: true enabled: false dataLayer: true debugKey: my-debug-key settings: autoInjectScript: true ecommerce: true initPath: /i tools: aJvt: actions: hrnc: actionType: pageview blockingTriggers: [] data: __zaraz_setting_name: Page view ev: PageView firingTriggers: - Pageview component: facebook-pixel defaultFields: testKey: TEST123456 enabled: true name: Facebook Pixel permissions: - access_client_kv settings: accessToken: ABcdEFg ecommerce: true property: "12345" type: component triggers: ktBn: Pageview: clientRules: [] description: All page loads excludeRules: [] loadRules: - match: '{{ client.__zarazTrack }}' op: EQUALS value: Pageview name: Pageview system: pageload variables: Autd: name: ip type: string value: '{{ system.device.ip }}' zarazVersion: 43 required: - tools - triggers - variables - settings - dataLayer - debugKey - zarazVersion properties: consent: type: object description: Consent management configuration. required: - enabled properties: buttonTextTranslations: type: object required: - accept_all - reject_all - confirm_my_choices properties: accept_all: type: object description: Object where keys are language codes confirm_my_choices: type: object description: Object where keys are language codes reject_all: type: object description: Object where keys are language codes companyEmail: type: string companyName: type: string companyStreetAddress: type: string consentModalIntroHTML: type: string consentModalIntroHTMLWithTranslations: type: object description: Object where keys are language codes cookieName: type: string customCSS: type: string customIntroDisclaimerDismissed: type: boolean defaultLanguage: type: string enabled: type: boolean hideModal: type: boolean purposes: type: object description: Object where keys are purpose alpha-numeric IDs purposesWithTranslations: type: object description: Object where keys are purpose alpha-numeric IDs tcfCompliant: type: boolean dataLayer: type: boolean description: Data layer compatibility mode enabled. debugKey: type: string description: The key for Zaraz debug mode. historyChange: type: boolean description: Single Page Application support enabled. settings: type: object description: General Zaraz settings. required: - autoInjectScript properties: autoInjectScript: type: boolean description: Automatic injection of Zaraz scripts enabled. contextEnricher: type: object description: Details of the worker that receives and edits Zaraz Context object. required: - escapedWorkerName - workerTag properties: escapedWorkerName: type: string workerTag: type: string cookieDomain: type: string description: The domain Zaraz will use for writing and reading its cookies. ecommerce: type: boolean description: Ecommerce API enabled. eventsApiPath: type: string description: Custom endpoint for server-side track events. hideExternalReferer: type: boolean description: Hiding external referrer URL enabled. hideIPAddress: type: boolean description: Trimming IP address enabled. hideQueryParams: type: boolean description: Removing URL query params enabled. hideUserAgent: type: boolean description: Removing sensitive data from User Aagent string enabled. initPath: type: string description: Custom endpoint for Zaraz init script. injectIframes: type: boolean description: Injection of Zaraz scripts into iframes enabled. mcRootPath: type: string description: Custom path for Managed Components server functionalities. scriptPath: type: string description: Custom endpoint for Zaraz main script. trackPath: type: string description: Custom endpoint for Zaraz tracking requests. triggers: type: object description: Triggers set up under Zaraz configuration, where key is the trigger alpha-numeric ID and value is the trigger configuration. variables: type: object description: Variables set up under Zaraz configuration, where key is the variable alpha-numeric ID and value is the variable configuration. Values of variables of type secret are not included. zarazVersion: type: integer description: Zaraz internal version of the config. zaraz_zaraz-config-body: allOf: - $ref: '#/components/schemas/zaraz_zaraz-config-base' - properties: tools: type: object description: Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID and value is the tool configuration object. zaraz_zaraz-config-history-response: allOf: - $ref: '#/components/schemas/zaraz_api-response-common' - properties: result: type: object description: Object where keys are numericc onfiguration IDs example: "12345": config: consent: cookieName: zaraz-consent customIntroDisclaimerDismissed: true enabled: false dataLayer: true debugKey: my-debug-key settings: autoInjectScript: true tools: aJvt: component: facebook-pixel defaultFields: testKey: TEST123456 enabled: true name: Facebook Pixel neoEvents: - actionType: pageview blockingTriggers: [] data: __zaraz_setting_name: Page view ev: PageView firingTriggers: - Pageview permissions: - access_client_kv settings: accessToken: ABcdEFg ecommerce: true property: "12345" type: component triggers: ktBn: Pageview: clientRules: [] description: All page loads excludeRules: [] loadRules: - match: '{{ client.__zarazTrack }}' op: EQUALS value: Pageview name: Pageview system: pageload variables: Autd: name: ip type: string value: '{{ system.device.ip }}' zarazVersion: 43 createdAt: "2023-02-23T05:05:55.155273Z" id: 12345 updatedAt: "2023-02-23T05:05:55.155273Z" userId: 278d0d0g123cd8e49d45ea64f12faa37 "23456": null 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: type: object description: Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID and value is the tool configuration object. zaraz_zaraz-config-row-base: required: - id - createdAt - updatedAt - userId properties: createdAt: type: string format: date-time description: Date and time the configuration was created id: type: integer description: ID of the configuration updatedAt: type: string format: date-time description: Date and time the configuration was last updated userId: type: string description: Alpha-numeric ID of the account user who published the configuration zaraz_zaraz-history-response: allOf: - $ref: '#/components/schemas/zaraz_api-response-common' - properties: result: type: array items: allOf: - $ref: '#/components/schemas/zaraz_zaraz-config-row-base' - type: object example: createdAt: "2023-02-23T05:05:55.155273Z" description: Config with enabled ecommerce tracking id: 12345 updatedAt: "2023-02-23T05:05:55.155273Z" userId: 278d0d0g123cd8e49d45ea64f12faa37 required: - description properties: description: type: string description: Configuration description provided by the user who published this configuration zaraz_zaraz-workflow: type: string description: Zaraz workflow enum: - realtime - preview 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: type: string description: The action to preform when the associated traffic, identity, and device posture expressions are either absent or evaluate to `true`. enum: - "on" - "off" - allow - block - scan - noscan - safesearch - ytrestricted - isolate - noisolate - override - l4_override - egress - audit_ssh - resolve example: allow zero-trust-gateway_activity-log-settings: type: object description: Activity log settings. properties: enabled: type: boolean description: Enable activity logging. example: true zero-trust-gateway_anti-virus-settings: type: object 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' zero-trust-gateway_api-response-collection: allOf: - $ref: '#/components/schemas/zero-trust-gateway_api-response-common' - properties: result: type: array nullable: true items: {} result_info: $ref: '#/components/schemas/zero-trust-gateway_result_info' type: object zero-trust-gateway_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/zero-trust-gateway_messages' messages: $ref: '#/components/schemas/zero-trust-gateway_messages' success: type: boolean description: Whether the API call was successful enum: - true example: true zero-trust-gateway_api-response-common-failure: type: object required: - success - errors - messages - result 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: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false zero-trust-gateway_api-response-single: allOf: - $ref: '#/components/schemas/zero-trust-gateway_api-response-common' - properties: result: anyOf: - type: object - type: string type: object zero-trust-gateway_app-types: oneOf: - $ref: '#/components/schemas/zero-trust-gateway_application' - $ref: '#/components/schemas/zero-trust-gateway_application_type' type: object readOnly: true zero-trust-gateway_app-types_components-schemas-name: type: string description: The name of the application or application type. example: Facebook zero-trust-gateway_app-types_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/zero-trust-gateway_app-types' zero-trust-gateway_app_id: type: integer description: The identifier for this application. There is only one application per ID. zero-trust-gateway_app_type_id: type: integer description: The identifier for the type of this application. There can be many applications with the same type. This refers to the `id` of a returned application type. zero-trust-gateway_application: type: object 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' zero-trust-gateway_application_type: type: object properties: created_at: $ref: '#/components/schemas/zero-trust-gateway_timestamp' description: type: string description: A short summary of applications with this type. example: Applications used to communicate or collaborate in a business setting. id: $ref: '#/components/schemas/zero-trust-gateway_app_type_id' name: $ref: '#/components/schemas/zero-trust-gateway_app-types_components-schemas-name' 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: type: string description: Seed ID example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 maxLength: 36 zero-trust-gateway_beta: type: boolean description: True if the category is in beta and subject to change. example: false zero-trust-gateway_block-page-settings: type: object description: Block page layout settings. properties: background_color: type: string description: 'Block page background color in #rrggbb format.' enabled: type: boolean description: Enable only cipher suites and TLS versions compliant with FIPS 140-2. example: true footer_text: type: string description: Block page footer text. example: --footer-- header_text: type: string description: Block page header text. example: --header-- logo_path: type: string description: Full URL to the logo file. example: https://logos.com/a.png mailto_address: type: string description: Admin email for users to contact. example: admin@example.com mailto_subject: type: string description: Subject line for emails created from block page. example: Blocked User Inquiry name: type: string description: Block page title. example: Cloudflare suppress_footer: type: boolean description: Suppress detailed info at the bottom of the block page. example: false zero-trust-gateway_body-scanning-settings: type: object description: DLP body scanning settings. properties: inspection_mode: type: string description: Set the inspection mode to either `deep` or `shallow`. example: deep zero-trust-gateway_browser-isolation-settings: type: object description: Browser isolation settings. properties: non_identity_enabled: type: boolean description: Enable non-identity onramp support for Browser Isolation. example: true url_browser_isolation_enabled: type: boolean description: Enable Clientless Browser Isolation. example: true zero-trust-gateway_categories: type: object readOnly: true 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: type: array description: All subcategories for this category. items: $ref: '#/components/schemas/zero-trust-gateway_subcategory' zero-trust-gateway_categories_components-schemas-name: type: string description: The name of the category. example: Education zero-trust-gateway_categories_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/zero-trust-gateway_categories' zero-trust-gateway_cf_account_id: type: string description: Cloudflare account ID. example: 699d98642c564d2e855e9661899b7252 maxLength: 32 zero-trust-gateway_class: type: string 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 zero-trust-gateway_client-default: type: boolean description: True if the location is the default location. example: false zero-trust-gateway_components-schemas-description: type: string description: A short summary of domains in the category. example: Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions. zero-trust-gateway_components-schemas-name: type: string description: The name of the rule. example: block bad websites zero-trust-gateway_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/zero-trust-gateway_rules' 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_rules' zero-trust-gateway_components-schemas-uuid: type: string description: The API resource UUID. example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 maxLength: 36 zero-trust-gateway_count: type: number description: The number of items in the list. example: 20 readOnly: true zero-trust-gateway_custom-certificate-settings: type: object description: Custom certificate settings for BYO-PKI. required: - enabled properties: binding_status: type: string description: Certificate status (internal). example: pending_deployment readOnly: true enabled: type: boolean description: Enable use of custom certificate authority for signing Gateway traffic. example: true id: type: string description: UUID of certificate (ID from MTLS certificate store). example: d1b364c5-1311-466e-a194-f0e943e0799f updated_at: type: string format: date-time readOnly: true zero-trust-gateway_deleted_at: type: string format: date-time description: Date of deletion, if any. nullable: true readOnly: true zero-trust-gateway_description: type: string description: The description of the list. example: The serial numbers for administrators zero-trust-gateway_device_posture: type: string description: The wirefilter expression used for device posture check matching. example: any(device_posture.checks.passed[*] in {"1308749e-fcfb-4ebc-b051-fe022b632644"}) zero-trust-gateway_dns_resolver_settings_v4: type: object required: - ip properties: ip: type: string description: IPv4 address of upstream resolver. example: 2.2.2.2 port: type: integer description: A port number to use for upstream resolver. Defaults to 53 if unspecified. example: 5053 route_through_private_network: type: boolean description: Whether to connect to this resolver over a private network. Must be set when vnet_id is set. example: true vnet_id: type: string description: Optionally specify a virtual network for this resolver. Uses default virtual network id if omitted. example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 zero-trust-gateway_dns_resolver_settings_v6: type: object required: - ip properties: ip: type: string description: IPv6 address of upstream resolver. example: '2001:DB8::' port: type: integer description: A port number to use for upstream resolver. Defaults to 53 if unspecified. example: 5053 route_through_private_network: type: boolean description: Whether to connect to this resolver over a private network. Must be set when vnet_id is set. example: true vnet_id: type: string description: Optionally specify a virtual network for this resolver. Uses default virtual network id if omitted. example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 zero-trust-gateway_ecs-support: type: boolean description: True if the location needs to resolve EDNS queries. example: false zero-trust-gateway_empty_response: allOf: - $ref: '#/components/schemas/zero-trust-gateway_api-response-single' - properties: result: type: object zero-trust-gateway_enabled: type: boolean description: True if the rule is enabled. example: true zero-trust-gateway_enabled_download_phase: type: boolean description: Enable anti-virus scanning on downloads. example: false zero-trust-gateway_enabled_upload_phase: type: boolean description: Enable anti-virus scanning on uploads. example: false zero-trust-gateway_extended-email-matching: type: object description: Extended e-mail matching settings. properties: enabled: type: boolean description: Enable matching all variants of user emails (with + or . modifiers) used as criteria in Firewall policies. example: true zero-trust-gateway_fail_closed: type: boolean description: Block requests for files that cannot be scanned. example: false zero-trust-gateway_filters: type: array description: The protocol or layer to evaluate the traffic, identity, and device posture expressions. example: - http items: type: string description: The protocol or layer to use. enum: - http - dns - l4 - egress example: http zero-trust-gateway_fips-settings: type: object description: FIPS settings. properties: tls: type: boolean description: Enable only cipher suites and TLS versions compliant with FIPS 140-2. example: true zero-trust-gateway_gateway-account-logging-settings: type: object properties: redact_pii: type: boolean description: 'Redact personally identifiable information from activity logging (PII fields are: source IP, user email, user ID, device ID, URL, referrer, user agent).' example: true settings_by_rule_type: type: object description: Logging settings by rule type. properties: dns: type: object description: Logging settings for DNS firewall. http: type: object description: Logging settings for HTTP/HTTPS firewall. l4: type: object description: Logging settings for Network firewall. 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: type: object description: account settings. properties: settings: type: object 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' 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' zero-trust-gateway_gateway_account: allOf: - $ref: '#/components/schemas/zero-trust-gateway_api-response-single' - properties: result: type: object 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 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: type: string description: Gateway internal ID. example: f174e90afafe4643bbbc4a0ed4fc8415 maxLength: 32 zero-trust-gateway_id: type: integer description: The identifier for this category. There is only one category per ID. zero-trust-gateway_identifier: example: 699d98642c564d2e855e9661899b7252 zero-trust-gateway_identity: type: string description: The wirefilter expression used for identity matching. example: any(identity.groups.name[*] in {"finance"}) zero-trust-gateway_ip: type: string description: IPV6 destination ip assigned to this location. DNS requests sent to this IP will counted as the request under this location. This field is auto-generated by Gateway. example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 zero-trust-gateway_ips: type: array description: A list of CIDRs to restrict ingress connections. items: type: string description: The IPv4 CIDR or IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /109. IPv4 CIDRs are limited to a maximum of /25. example: 192.0.2.1/32 zero-trust-gateway_items: type: array description: The items in the list. items: type: object properties: created_at: $ref: '#/components/schemas/zero-trust-gateway_timestamp' value: $ref: '#/components/schemas/zero-trust-gateway_value' zero-trust-gateway_list_item_response_collection: allOf: - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/zero-trust-gateway_items' - properties: result_info: type: object properties: count: type: number description: Total results returned based on your search parameters. example: 1 page: type: number description: Current page within paginated list of results. example: 1 per_page: type: number description: Number of results per page of results. example: 20 total_count: type: number description: Total results available without any search parameters. example: 2000 zero-trust-gateway_lists: type: object 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_uuid' name: $ref: '#/components/schemas/zero-trust-gateway_name' type: $ref: '#/components/schemas/zero-trust-gateway_type' updated_at: $ref: '#/components/schemas/zero-trust-gateway_timestamp' zero-trust-gateway_locations: type: object properties: client_default: $ref: '#/components/schemas/zero-trust-gateway_client-default' created_at: $ref: '#/components/schemas/zero-trust-gateway_timestamp' doh_subdomain: $ref: '#/components/schemas/zero-trust-gateway_subdomain' ecs_support: $ref: '#/components/schemas/zero-trust-gateway_ecs-support' id: $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid' ip: $ref: '#/components/schemas/zero-trust-gateway_ip' name: $ref: '#/components/schemas/zero-trust-gateway_schemas-name' networks: $ref: '#/components/schemas/zero-trust-gateway_networks' updated_at: $ref: '#/components/schemas/zero-trust-gateway_timestamp' zero-trust-gateway_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string zero-trust-gateway_name: type: string description: The name of the list. example: Admin Serial Numbers zero-trust-gateway_network: type: object required: - network properties: network: type: string description: The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24. example: 192.0.2.1/32 zero-trust-gateway_networks: type: array description: A list of network ranges that requests from this location would originate from. items: $ref: '#/components/schemas/zero-trust-gateway_network' zero-trust-gateway_notification_settings: type: object description: Configure a message to display on the user's device when an antivirus search is performed. properties: enabled: type: boolean description: Set notification on msg: type: string description: Customize the message shown in the notification. support_url: type: string description: Optional URL to direct users to additional information. If not set, the notification will open a block page. zero-trust-gateway_precedence: type: integer 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. zero-trust-gateway_protocol-detection: type: object description: Protocol Detection settings. properties: enabled: type: boolean description: Enable detecting protocol on initial bytes of client traffic. example: true zero-trust-gateway_provider_name: type: string description: The name of the provider. Usually Cloudflare. example: Cloudflare zero-trust-gateway_proxy-endpoints: type: object properties: created_at: $ref: '#/components/schemas/zero-trust-gateway_timestamp' id: $ref: '#/components/schemas/zero-trust-gateway_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' zero-trust-gateway_proxy-endpoints_components-schemas-name: type: string description: The name of the proxy endpoint. example: Devops team zero-trust-gateway_proxy-endpoints_components-schemas-response_collection: allOf: - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints' 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: type: string description: SSH encryption public key example: 1pyl6I1tL7xfJuFYVzXlUW8uXXlpxegHXBzGCBKaSFA= zero-trust-gateway_response_collection: allOf: - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/zero-trust-gateway_lists' zero-trust-gateway_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 zero-trust-gateway_rule-settings: type: object description: Additional settings that modify the rule's action. properties: add_headers: type: object description: Add custom headers to allowed requests, in the form of key-value pairs. Keys are header names, pointing to an array with its header value(s). example: My-Next-Header: - foo - bar X-Custom-Header-Name: - somecustomvalue allow_child_bypass: type: boolean description: Set by parent MSP accounts to enable their children to bypass this rule. example: false audit_ssh: type: object description: Settings for the Audit SSH action. properties: command_logging: type: boolean description: Enable to turn on SSH command logging. example: false biso_admin_controls: type: object description: Configure how browser isolation behaves. properties: dcp: type: boolean description: Set to true to enable copy-pasting. example: false dd: type: boolean description: Set to true to enable downloading. example: false dk: type: boolean description: Set to true to enable keyboard usage. example: false dp: type: boolean description: Set to true to enable printing. example: false du: type: boolean description: Set to true to enable uploading. example: false block_page_enabled: type: boolean description: Enable the custom block page. example: true block_reason: type: string description: The text describing why this block occurred, displayed on the custom block page (if enabled). example: This website is a security risk bypass_parent_rule: type: boolean description: Set by children MSP accounts to bypass their parent's rules. example: false check_session: type: object description: Configure how session check behaves. properties: duration: type: string description: Configure how fresh the session needs to be to be considered valid. example: 300s enforce: type: boolean description: Set to true to enable session enforcement. example: true dns_resolvers: type: object 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: type: array items: $ref: '#/components/schemas/zero-trust-gateway_dns_resolver_settings_v4' ipv6: type: array items: $ref: '#/components/schemas/zero-trust-gateway_dns_resolver_settings_v6' egress: type: object 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: type: string description: The IPv4 address to be used for egress. example: 192.0.2.2 ipv4_fallback: type: string 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 ipv6: type: string description: The IPv6 range to be used for egress. example: 2001:DB8::/64 insecure_disable_dnssec_validation: type: boolean description: INSECURE - disable DNSSEC validation (for Allow actions). example: false ip_categories: type: boolean description: Set to true to enable IPs in DNS resolver category blocks. By default categories only block based on domain names. example: true ip_indicator_feeds: type: boolean 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 l4override: type: object description: Send matching traffic to the supplied destination IP address and port. properties: ip: type: string description: IPv4 or IPv6 address. example: 1.1.1.1 port: type: integer description: A port number to use for TCP/UDP overrides. notification_settings: type: object description: Configure a notification to display on the user's device when this rule is matched. properties: enabled: type: boolean description: Set notification on msg: type: string description: Customize the message shown in the notification. support_url: type: string description: Optional URL to direct users to additional information. If not set, the notification will open a block page. override_host: type: string description: Override matching DNS queries with a hostname. example: example.com override_ips: type: array description: Override matching DNS queries with an IP or set of IPs. example: - 1.1.1.1 - 2.2.2.2 items: type: string description: IPv4 or IPv6 address. example: 1.1.1.1 payload_log: type: object description: Configure DLP payload logging. properties: enabled: type: boolean description: Set to true to enable DLP payload logging for this rule. example: true resolve_dns_through_cloudflare: type: boolean 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 untrusted_cert: type: object description: Configure behavior when an upstream cert is invalid or an SSL error occurs. properties: action: type: string 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 zero-trust-gateway_rules: type: object 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_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' zero-trust-gateway_schedule: type: object description: The schedule for activating DNS policies. This does not apply to HTTP or network policies. properties: fri: type: string 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 mon: type: string 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 sat: type: string 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 sun: type: string 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 thu: type: string 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 time_zone: type: string 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 tue: type: string 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 wed: type: string 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 zero-trust-gateway_schemas-description: type: string description: The description of the rule. example: Block bad websites based on their host name. zero-trust-gateway_schemas-identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 zero-trust-gateway_schemas-name: type: string description: The name of the location. example: Austin Office Location zero-trust-gateway_schemas-response_collection: allOf: - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/zero-trust-gateway_locations' zero-trust-gateway_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_schemas-subdomain: type: string description: The subdomain to be used as the destination in the proxy client. example: oli3n9zkz5.proxy.cloudflare-gateway.com zero-trust-gateway_schemas-uuid: example: ed35569b41ce4d1facfe683550f54086 zero-trust-gateway_settings: type: object 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' zero-trust-gateway_single_response: allOf: - $ref: '#/components/schemas/zero-trust-gateway_api-response-single' - properties: result: $ref: '#/components/schemas/zero-trust-gateway_lists' 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_uuid' items: $ref: '#/components/schemas/zero-trust-gateway_items' name: $ref: '#/components/schemas/zero-trust-gateway_name' type: $ref: '#/components/schemas/zero-trust-gateway_type' updated_at: $ref: '#/components/schemas/zero-trust-gateway_timestamp' zero-trust-gateway_subcategory: type: object 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' zero-trust-gateway_subdomain: type: string description: The DNS over HTTPS domain to send DNS requests to. This field is auto-generated by Gateway. example: oli3n9zkz5 zero-trust-gateway_timestamp: type: string format: date-time example: "2014-01-01T05:20:00.12345Z" readOnly: true zero-trust-gateway_tls-settings: type: object description: TLS interception settings. properties: enabled: type: boolean description: Enable inspecting encrypted HTTP traffic. example: true zero-trust-gateway_traffic: type: string 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 zero-trust-gateway_type: type: string description: The type of list. enum: - SERIAL - URL - DOMAIN - EMAIL - IP example: SERIAL zero-trust-gateway_uuid: type: string description: API Resource UUID tag. example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 maxLength: 36 zero-trust-gateway_value: type: string description: The value of the item in a list. example: 8GE8721REF zone-activation_api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/zone-activation_messages' messages: $ref: '#/components/schemas/zone-activation_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true zone-activation_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/zone-activation_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/zone-activation_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false zone-activation_api-response-single: allOf: - $ref: '#/components/schemas/zone-activation_api-response-common' - properties: result: anyOf: - type: object - type: string type: object zone-activation_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 zone-activation_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string zones_0rtt: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - 0rtt example: 0rtt value: $ref: '#/components/schemas/zones_0rtt_value' title: 0-RTT Value description: 0-RTT session resumption enabled for this zone. zones_0rtt_value: type: string description: Value of the 0-RTT setting. enum: - "on" - "off" default: "off" zones_actions: type: array description: The set of actions to perform if the targets of this rule match the request. Actions can redirect to another URL or override settings, but not both. example: - id: browser_check value: "on" items: oneOf: - $ref: '#/components/schemas/zones_route' zones_advanced_ddos: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - advanced_ddos example: advanced_ddos value: $ref: '#/components/schemas/zones_advanced_ddos_value' title: Advanced DDoS Protection description: Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones. zones_advanced_ddos_value: type: string description: |- Value of the zone setting. Notes: Defaults to on for Business+ plans enum: - "on" - "off" default: "off" zones_always_online: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - always_online example: always_online value: $ref: '#/components/schemas/zones_always_online_value' title: Always Online Mode description: When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information. zones_always_online_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "on" zones_always_use_https: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - always_use_https example: always_use_https value: $ref: '#/components/schemas/zones_always_use_https_value' title: Zone Enable Always Use HTTPS description: Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule. default: "off" zones_always_use_https_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "off" zones_api-response-common: type: object required: - success - errors - messages properties: errors: $ref: '#/components/schemas/zones_messages' messages: $ref: '#/components/schemas/zones_messages' success: type: boolean description: Whether the API call was successful example: true zones_api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/zones_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/zones_messages' example: [] result: type: object nullable: true success: type: boolean description: Whether the API call was successful example: false 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: type: object nullable: true required: - id properties: id: $ref: '#/components/schemas/zones_identifier' 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' title: Zone Enable Automatic HTTPS Rewrites description: Enable the Automatic HTTPS Rewrites feature for this zone. default: "off" zones_automatic_https_rewrites_value: type: string description: |- Value of the zone setting. Notes: Default value depends on the zone's plan level. enum: - "on" - "off" default: "on" zones_automatic_platform_optimization: type: object required: - enabled - cf - wordpress - wp_plugin - hostnames - cache_by_device_type properties: cache_by_device_type: type: boolean description: Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled. example: false cf: type: boolean description: Indicates whether or not Cloudflare proxy is enabled. default: false example: true enabled: type: boolean description: Indicates whether or not Automatic Platform Optimization is enabled. default: false example: true hostnames: type: array description: An array of hostnames where Automatic Platform Optimization for WordPress is activated. example: - www.example.com - example.com - shop.example.com items: type: string format: hostname wordpress: type: boolean description: Indicates whether or not site is powered by WordPress. default: false example: true wp_plugin: type: boolean description: Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed. default: false example: true zones_base: required: - id - value properties: editable: type: boolean description: Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). enum: - true - false default: true readOnly: true id: type: string description: Identifier of the zone setting. example: development_mode modified_on: type: string format: date-time description: last time this setting was modified. example: "2014-01-01T05:20:00.12345Z" nullable: true readOnly: true value: description: Current value of the zone setting. example: "on" zones_brotli: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - brotli example: brotli value: $ref: '#/components/schemas/zones_brotli_value' title: Brotli Compression description: When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. zones_brotli_value: type: string description: Value of the zone setting. enum: - "off" - "on" default: "off" zones_browser_cache_ttl: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - browser_cache_ttl example: browser_cache_ttl value: $ref: '#/components/schemas/zones_browser_cache_ttl_value' title: Browser Cache TTL description: Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276). zones_browser_cache_ttl_value: type: number description: |- Value of the zone setting. Notes: Setting a TTL of 0 is equivalent to selecting `Respect Existing Headers` enum: - 0 - 30 - 60 - 120 - 300 - 1200 - 1800 - 3600 - 7200 - 10800 - 14400 - 18000 - 28800 - 43200 - 57600 - 72000 - 86400 - 172800 - 259200 - 345600 - 432000 - 691200 - 1.3824e+06 - 2.0736e+06 - 2.6784e+06 - 5.3568e+06 - 1.60704e+07 - 3.1536e+07 default: 14400 zones_browser_check: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - browser_check example: browser_check value: $ref: '#/components/schemas/zones_browser_check_value' title: Browser Check description: Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086). zones_browser_check_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "on" zones_cache_level: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - cache_level example: cache_level value: $ref: '#/components/schemas/zones_cache_level_value' title: Cloudflare Cache Level description: Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256). zones_cache_level_value: type: string description: Value of the zone setting. enum: - aggressive - basic - simplified default: aggressive zones_challenge_ttl: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - challenge_ttl example: challenge_ttl value: $ref: '#/components/schemas/zones_challenge_ttl_value' title: Challenge Page TTL description: Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136). zones_challenge_ttl_value: type: number description: Value of the zone setting. enum: - 300 - 900 - 1800 - 2700 - 3600 - 7200 - 10800 - 14400 - 28800 - 57600 - 86400 - 604800 - 2.592e+06 - 3.1536e+07 default: 1800 zones_ciphers: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - ciphers example: ciphers value: $ref: '#/components/schemas/zones_ciphers_value' title: Zone ciphers allowed for TLS termination description: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. default: [] zones_ciphers_value: type: array description: Value of the zone setting. default: [] example: - ECDHE-RSA-AES128-GCM-SHA256 - AES128-SHA uniqueItems: true items: type: string zones_cname_flattening: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: How to flatten the cname destination. enum: - cname_flattening value: $ref: '#/components/schemas/zones_cname_flattening_value' title: Cloudflare CNAME Flattening description: Whether or not cname flattening is on. zones_cname_flattening_value: type: string description: Value of the cname flattening setting. enum: - flatten_at_root - flatten_all default: flatten_at_root zones_created_on: type: string format: date-time description: The timestamp of when the Page Rule was created. example: "2014-01-01T05:20:00.12345Z" readOnly: true zones_development_mode: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - development_mode example: development_mode time_remaining: type: number description: |- Value of the zone setting. Notes: The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is false. example: 3600 readOnly: true value: $ref: '#/components/schemas/zones_development_mode_value' title: Development Mode description: Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off. zones_development_mode_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "off" zones_early_hints: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - early_hints example: early_hints value: $ref: '#/components/schemas/zones_early_hints_value' title: Early Hints description: When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information. zones_early_hints_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "off" zones_edge_cache_ttl: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - edge_cache_ttl example: edge_cache_ttl value: $ref: '#/components/schemas/zones_edge_cache_ttl_value' title: Edge Cache TTL description: Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers. zones_edge_cache_ttl_value: type: number description: |- Value of the zone setting. Notes: The minimum TTL available depends on the plan level of the zone. (Enterprise = 30, Business = 1800, Pro = 3600, Free = 7200) enum: - 30 - 60 - 300 - 1200 - 1800 - 3600 - 7200 - 10800 - 14400 - 18000 - 28800 - 43200 - 57600 - 72000 - 86400 - 172800 - 259200 - 345600 - 432000 - 518400 - 604800 default: 7200 zones_email_obfuscation: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - email_obfuscation example: email_obfuscation value: $ref: '#/components/schemas/zones_email_obfuscation_value' title: Email Obfuscation description: Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016). zones_email_obfuscation_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "on" zones_h2_prioritization: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - h2_prioritization example: h2_prioritization value: $ref: '#/components/schemas/zones_h2_prioritization_value' title: HTTP/2 Edge Prioritization description: HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers. zones_h2_prioritization_value: type: string description: Value of the zone setting. enum: - "on" - "off" - custom default: "off" zones_hotlink_protection: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - hotlink_protection example: hotlink_protection value: $ref: '#/components/schemas/zones_hotlink_protection_value' title: Hotlink Protection description: When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026). zones_hotlink_protection_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "off" zones_http2: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - http2 example: http2 value: $ref: '#/components/schemas/zones_http2_value' title: HTTP2 Value description: HTTP2 enabled for this zone. zones_http2_value: type: string description: Value of the HTTP2 setting. enum: - "on" - "off" default: "off" zones_http3: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - http3 example: http3 value: $ref: '#/components/schemas/zones_http3_value' title: HTTP3 Value description: HTTP3 enabled for this zone. zones_http3_value: type: string description: Value of the HTTP3 setting. enum: - "on" - "off" default: "off" zones_identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 zones_image_resizing: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - image_resizing example: image_resizing value: $ref: '#/components/schemas/zones_image_resizing_value' title: Image Resizing description: Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information. zones_image_resizing_value: type: string description: Whether the feature is enabled, disabled, or enabled in `open proxy` mode. enum: - "on" - "off" - open default: "off" zones_ip_geolocation: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - ip_geolocation example: ip_geolocation value: $ref: '#/components/schemas/zones_ip_geolocation_value' title: IP Geolocation description: Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236). zones_ip_geolocation_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "on" zones_ipv6: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - ipv6 example: ipv6 value: $ref: '#/components/schemas/zones_ipv6_value' title: IPv6 description: Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). zones_ipv6_value: type: string description: Value of the zone setting. enum: - "off" - "on" default: "off" zones_max_upload: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: identifier of the zone setting. enum: - max_upload example: max_upload value: $ref: '#/components/schemas/zones_max_upload_value' title: Max Upload description: Maximum size of an allowable upload. zones_max_upload_value: type: number description: |- Value of the zone setting. Notes: The size depends on the plan level of the zone. (Enterprise = 500, Business = 200, Pro = 100, Free = 100) enum: - 100 - 200 - 500 default: 100 zones_messages: type: array example: [] items: type: object uniqueItems: true required: - code - message properties: code: type: integer minimum: 1000 message: type: string zones_min_tls_version: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - min_tls_version example: min_tls_version value: $ref: '#/components/schemas/zones_min_tls_version_value' title: Zone Minimum TLS Version value description: Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted. default: "1.0" zones_min_tls_version_value: type: string description: Value of the zone setting. enum: - "1.0" - "1.1" - "1.2" - "1.3" default: "1.0" zones_minify: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: Zone setting identifier. enum: - minify example: minify value: $ref: '#/components/schemas/zones_minify_value' title: Auto-Minify Assets description: Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information. zones_minify_value: type: object description: Value of the zone setting. default: css: "off" html: "off" js: "off" properties: css: description: Automatically minify all CSS files for your website. enum: - "on" - "off" default: "off" html: description: Automatically minify all HTML files for your website. enum: - "on" - "off" default: "off" js: description: Automatically minify all JavaScript files for your website. enum: - "on" - "off" default: "off" zones_mirage: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - mirage example: mirage value: $ref: '#/components/schemas/zones_mirage_value' title: Mirage Image Optimization description: | Automatically optimize image loading for website visitors on mobile devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information. zones_mirage_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "off" zones_mobile_redirect: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: Identifier of the zone setting. enum: - mobile_redirect example: mobile_redirect value: $ref: '#/components/schemas/zones_mobile_redirect_value' title: Mobile Redirect description: Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information. zones_mobile_redirect_value: type: object description: Value of the zone setting. default: mobile_subdomain: null status: "off" strip_uri: false properties: mobile_subdomain: type: string description: Which subdomain prefix you wish to redirect visitors on mobile devices to (subdomain must already exist). example: m nullable: true minLength: 1 status: description: Whether or not mobile redirect is enabled. enum: - "on" - "off" default: "off" strip_uri: type: boolean description: Whether to drop the current page path and redirect to the mobile subdomain URL root, or keep the path and redirect to the same page on the mobile subdomain. default: false example: false zones_name: type: string description: The domain name example: example.com maxLength: 253 pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$ zones_nel: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: Zone setting identifier. enum: - nel example: nel value: $ref: '#/components/schemas/zones_nel_value' title: Network Error Logging description: 'Enable Network Error Logging reporting on your zone. (Beta) ' zones_nel_value: type: object description: Value of the zone setting. default: enabled: false properties: enabled: type: boolean default: false example: false zones_opportunistic_encryption: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - opportunistic_encryption example: opportunistic_encryption value: $ref: '#/components/schemas/zones_opportunistic_encryption_value' title: Enable Opportunistic Encryption for a zone description: Enables the Opportunistic Encryption feature for a zone. zones_opportunistic_encryption_value: type: string description: |- Value of the zone setting. Notes: Default value depends on the zone's plan level. enum: - "on" - "off" default: "on" zones_opportunistic_onion: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - opportunistic_onion example: opportunistic_onion value: $ref: '#/components/schemas/zones_opportunistic_onion_value' title: Zone Enable Onion Routing description: Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes. default: "off" zones_opportunistic_onion_value: type: string description: |- Value of the zone setting. Notes: Default value depends on the zone's plan level. enum: - "on" - "off" default: "off" zones_orange_to_orange: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - orange_to_orange example: orange_to_orange value: $ref: '#/components/schemas/zones_orange_to_orange_value' title: Orange to Orange description: Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. zones_orange_to_orange_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "on" zones_origin_error_page_pass_thru: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - origin_error_page_pass_thru example: origin_error_page_pass_thru value: $ref: '#/components/schemas/zones_origin_error_page_pass_thru_value' title: Error Pages On description: Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones. default: "off" zones_origin_error_page_pass_thru_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "off" zones_page-rule: type: object required: - id - targets - actions - priority - status - modified_on - created_on properties: actions: $ref: '#/components/schemas/zones_actions' created_on: $ref: '#/components/schemas/zones_created_on' id: $ref: '#/components/schemas/zones_schemas-identifier' modified_on: $ref: '#/components/schemas/zones_schemas-modified_on' priority: $ref: '#/components/schemas/zones_priority' status: $ref: '#/components/schemas/zones_status' targets: $ref: '#/components/schemas/zones_targets' zones_pagerule_response_collection: allOf: - $ref: '#/components/schemas/zones_schemas-api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/zones_page-rule' 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: type: boolean description: | Indicates whether the zone is only using Cloudflare DNS services. A true value means the zone will not receive security or performance benefits. default: false readOnly: true zones_polish: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - polish example: polish value: $ref: '#/components/schemas/zones_polish_value' title: Polish Image Optimization description: 'Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.' zones_polish_value: type: string description: Value of the zone setting. enum: - "off" - lossless - lossy default: "off" zones_prefetch_preload: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - prefetch_preload example: prefetch_preload value: $ref: '#/components/schemas/zones_prefetch_preload_value' title: Prefetch preload description: Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. default: "off" zones_prefetch_preload_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "off" zones_priority: type: integer description: 'The priority of the rule, used to define which Page Rule is processed over another. A higher number indicates a higher priority. For example, if you have a catch-all Page Rule (rule A: `/images/*`) but want a more specific Page Rule to take precedence (rule B: `/images/special/*`), specify a higher priority for rule B so it overrides rule A.' default: 1 zones_proxy_read_timeout: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - proxy_read_timeout example: proxy_read_timeout value: $ref: '#/components/schemas/zones_proxy_read_timeout_value' title: Proxy Read Timeout description: Maximum time between two read operations from origin. zones_proxy_read_timeout_value: type: number description: |- Value of the zone setting. Notes: Value must be between 1 and 6000 default: 100 zones_pseudo_ipv4: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: Value of the Pseudo IPv4 setting. enum: - pseudo_ipv4 default: pseudo_ipv4 value: $ref: '#/components/schemas/zones_pseudo_ipv4_value' title: Pseudo IPv4 Value description: The value set for the Pseudo IPv4 setting. zones_pseudo_ipv4_value: type: string description: Value of the Pseudo IPv4 setting. enum: - "off" - add_header - overwrite_header default: "off" zones_response_buffering: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - response_buffering example: response_buffering value: $ref: '#/components/schemas/zones_response_buffering_value' title: Response Buffering description: Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones. default: "off" zones_response_buffering_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "off" zones_result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 zones_rocket_loader: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - rocket_loader example: rocket_loader value: $ref: '#/components/schemas/zones_rocket_loader_value' title: Rocket Loader description: Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information. zones_rocket_loader_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "off" zones_route: type: object properties: modified_on: type: string format: date-time description: The timestamp of when the override was last modified. example: "2014-01-01T05:20:00.12345Z" readOnly: true name: description: The type of route. enum: - forward_url example: forward_url value: properties: type: description: The response type for the URL redirect. enum: - temporary - permanent example: temporary url: type: string description: |- The URL to redirect the request to. Notes: ${num} refers to the position of '*' in the constraint value. example: http://www.example.com/somewhere/$1/astring/$2/anotherstring/$3 zones_schemas-api-response-common: type: object required: - success - errors - messages - result properties: errors: $ref: '#/components/schemas/zones_messages' messages: $ref: '#/components/schemas/zones_messages' result: anyOf: - type: object - type: array items: {} - type: string success: type: boolean description: Whether the API call was successful enum: - true example: true zones_schemas-api-response-common-failure: type: object required: - success - errors - messages - result properties: errors: allOf: - $ref: '#/components/schemas/zones_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/zones_messages' example: [] result: type: object enum: - null nullable: true success: type: boolean description: Whether the API call was successful enum: - false example: false zones_schemas-api-response-single-id: allOf: - $ref: '#/components/schemas/zones_schemas-api-response-common' - properties: result: type: object nullable: true required: - id properties: id: $ref: '#/components/schemas/zones_schemas-identifier' type: object zones_schemas-automatic_platform_optimization: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - automatic_platform_optimization example: automatic_platform_optimization value: $ref: '#/components/schemas/zones_automatic_platform_optimization' title: Automatic Platform Optimization for WordPress description: '[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare''s edge network and caches third-party fonts.' zones_schemas-identifier: type: string description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 readOnly: true maxLength: 32 zones_schemas-modified_on: type: string format: date-time description: The timestamp of when the Page Rule was last modified. example: "2014-01-01T05:20:00.12345Z" readOnly: true zones_security_header: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone's security header. enum: - security_header example: security_header value: $ref: '#/components/schemas/zones_security_header_value' title: Security Header description: Cloudflare security header for a zone. zones_security_header_value: type: object default: strict_transport_security: enabled: true include_subdomains: true max_age: 86400 nosniff: true properties: strict_transport_security: type: object description: Strict Transport Security. properties: enabled: type: boolean description: Whether or not strict transport security is enabled. example: true include_subdomains: type: boolean description: Include all subdomains for strict transport security. example: true max_age: type: number description: Max age in seconds of the strict transport security. example: 86400 nosniff: type: boolean description: 'Whether or not to include ''X-Content-Type-Options: nosniff'' header.' example: true zones_security_level: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - security_level example: security_level value: $ref: '#/components/schemas/zones_security_level_value' title: Security Level description: Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056). zones_security_level_value: type: string description: Value of the zone setting. enum: - "off" - essentially_off - low - medium - high - under_attack default: medium zones_server_side_exclude: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - server_side_exclude example: server_side_exclude value: $ref: '#/components/schemas/zones_server_side_exclude_value' title: Server Side Exclude description: 'If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won''t see my phone number, 555-555-5555 . 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).' zones_server_side_exclude_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "on" zones_setting: oneOf: - $ref: '#/components/schemas/zones_0rtt' - $ref: '#/components/schemas/zones_advanced_ddos' - $ref: '#/components/schemas/zones_always_online' - $ref: '#/components/schemas/zones_always_use_https' - $ref: '#/components/schemas/zones_automatic_https_rewrites' - $ref: '#/components/schemas/zones_brotli' - $ref: '#/components/schemas/zones_browser_cache_ttl' - $ref: '#/components/schemas/zones_browser_check' - $ref: '#/components/schemas/zones_cache_level' - $ref: '#/components/schemas/zones_challenge_ttl' - $ref: '#/components/schemas/zones_ciphers' - $ref: '#/components/schemas/zones_cname_flattening' - $ref: '#/components/schemas/zones_development_mode' - $ref: '#/components/schemas/zones_early_hints' - $ref: '#/components/schemas/zones_edge_cache_ttl' - $ref: '#/components/schemas/zones_email_obfuscation' - $ref: '#/components/schemas/zones_h2_prioritization' - $ref: '#/components/schemas/zones_hotlink_protection' - $ref: '#/components/schemas/zones_http2' - $ref: '#/components/schemas/zones_http3' - $ref: '#/components/schemas/zones_image_resizing' - $ref: '#/components/schemas/zones_ip_geolocation' - $ref: '#/components/schemas/zones_ipv6' - $ref: '#/components/schemas/zones_max_upload' - $ref: '#/components/schemas/zones_min_tls_version' - $ref: '#/components/schemas/zones_minify' - $ref: '#/components/schemas/zones_mirage' - $ref: '#/components/schemas/zones_mobile_redirect' - $ref: '#/components/schemas/zones_nel' - $ref: '#/components/schemas/zones_opportunistic_encryption' - $ref: '#/components/schemas/zones_opportunistic_onion' - $ref: '#/components/schemas/zones_orange_to_orange' - $ref: '#/components/schemas/zones_origin_error_page_pass_thru' - $ref: '#/components/schemas/zones_polish' - $ref: '#/components/schemas/zones_prefetch_preload' - $ref: '#/components/schemas/zones_proxy_read_timeout' - $ref: '#/components/schemas/zones_pseudo_ipv4' - $ref: '#/components/schemas/zones_response_buffering' - $ref: '#/components/schemas/zones_rocket_loader' - $ref: '#/components/schemas/zones_schemas-automatic_platform_optimization' - $ref: '#/components/schemas/zones_security_header' - $ref: '#/components/schemas/zones_security_level' - $ref: '#/components/schemas/zones_server_side_exclude' - $ref: '#/components/schemas/zones_sha1_support' - $ref: '#/components/schemas/zones_sort_query_string_for_cache' - $ref: '#/components/schemas/zones_ssl' - $ref: '#/components/schemas/zones_ssl_recommender' - $ref: '#/components/schemas/zones_tls_1_2_only' - $ref: '#/components/schemas/zones_tls_1_3' - $ref: '#/components/schemas/zones_tls_client_auth' - $ref: '#/components/schemas/zones_true_client_ip_header' - $ref: '#/components/schemas/zones_waf' - $ref: '#/components/schemas/zones_webp' - $ref: '#/components/schemas/zones_websockets' type: object zones_setting_readonly: type: boolean enum: - false zones_setting_toggle: type: string description: Value of the zone setting. enum: - "on" - "off" zones_setting_writable: type: boolean enum: - true zones_settings: type: array description: Settings available for the zone. example: - id: browser_check properties: - name: value type: toggle - id: browser_cache_ttl properties: - max: 3.1536e+07 min: 1800 name: value suggested_values: - 1800 - 3600 - 7200 - 10800 - 14400 - 18000 - 28800 - 43200 - 57600 - 72000 - 86400 - 172800 - 259200 - 345600 - 432000 - 691200 - 1.3824e+06 - 2.0736e+06 - 2.6784e+06 - 5.3568e+06 - 1.60704e+07 - 3.1536e+07 type: range - id: browser_check properties: - name: value type: toggle - id: cache_key_fields properties: - name: value properties: - allowEmpty: true choices: - include - exclude multiple: false name: query_string type: select - allowEmpty: true choices: - include - exclude - check_presence multiple: true name: header type: select - allowEmpty: false choices: - resolved multiple: true name: host type: select - allowEmpty: true choices: - include - check_presence multiple: true name: cookie type: select - allowEmpty: false choices: - device_type - geo - lang multiple: true name: user type: select type: object - id: cache_deception_armor properties: - name: value type: toggle - id: cache_level properties: - choices: - bypass - basic - simplified - aggressive - cache_everything multiple: false name: value type: select - id: cache_ttl_by_status properties: - allowEmpty: false name: value type: object - id: disable_apps properties: [] - id: disable_performance properties: [] - id: disable_security properties: [] - id: edge_cache_ttl properties: - max: 2.4192e+06 min: 7200 name: value suggested_values: - 7200 - 10800 - 14400 - 18000 - 28800 - 43200 - 57600 - 72000 - 86400 - 172800 - 259200 - 345600 - 432000 - 518400 - 604800 - 1.2096e+06 - 2.4192e+06 type: range - id: email_obfuscation properties: - name: value type: toggle - id: forwarding_url properties: - choices: - 301 - 302 multiple: false name: status_code type: choice - name: url type: forwardingUrl - id: ip_geolocation properties: - name: value type: toggle - id: minify properties: - allowEmpty: true choices: - html - css - js multiple: true name: value type: select - id: explicit_cache_control properties: - name: value type: toggle - id: rocket_loader properties: - name: value type: toggle - id: security_level properties: - choices: - essentially_off - low - medium - high - under_attack multiple: false name: value type: select - id: server_side_exclude properties: - name: value type: toggle - id: ssl properties: - choices: - "off" - flexible - full - strict multiple: false name: value type: choice items: type: object zones_sha1_support: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: Zone setting identifier. enum: - sha1_support example: sha1_support value: $ref: '#/components/schemas/zones_sha1_support_value' title: Toggle SHA1 support description: Allow SHA1 support. zones_sha1_support_value: type: string description: Value of the zone setting. enum: - "off" - "on" default: "off" zones_sort_query_string_for_cache: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - sort_query_string_for_cache example: sort_query_string_for_cache value: $ref: '#/components/schemas/zones_sort_query_string_for_cache_value' title: Get String Sort description: Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones. default: "off" zones_sort_query_string_for_cache_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "off" zones_ssl: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - ssl example: ssl value: $ref: '#/components/schemas/zones_ssl_value' title: SSL description: 'SSL encrypts your visitor''s connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don''t need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).' zones_ssl_recommender: allOf: - properties: enabled: $ref: '#/components/schemas/zones_ssl_recommender_enabled' id: description: Enrollment value for SSL/TLS Recommender. enum: - ssl_recommender example: ssl_recommender title: SSL/TLS Recommender description: Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. zones_ssl_recommender_enabled: type: boolean description: ssl-recommender enrollment setting. default: false zones_ssl_value: type: string description: |- Value of the zone setting. Notes: Depends on the zone's plan level enum: - "off" - flexible - full - strict default: "off" zones_status: type: string description: The status of the Page Rule. enum: - active - disabled default: disabled example: active zones_string_constraint: type: object description: String constraint. required: - operator - value properties: operator: description: The matches operator can use asterisks and pipes as wildcard and 'or' operators. enum: - matches - contains - equals - not_equal - not_contain default: contains value: type: string description: The value to apply the operator to. zones_target: oneOf: - $ref: '#/components/schemas/zones_url_target' description: A request condition target. required: - target - constraint zones_targets: type: array description: The rule targets to evaluate on each request. example: - constraint: operator: matches value: '*example.com/images/*' target: url items: $ref: '#/components/schemas/zones_target' zones_tls_1_2_only: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: Zone setting identifier. enum: - tls_1_2_only example: tls_1_2_only value: $ref: '#/components/schemas/zones_tls_1_2_only_value' title: TLS1.2 only description: Only allows TLS1.2. zones_tls_1_2_only_value: type: string description: Value of the zone setting. enum: - "off" - "on" default: "off" zones_tls_1_3: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - tls_1_3 example: tls_1_3 value: $ref: '#/components/schemas/zones_tls_1_3_value' title: Enable TLS 1.3 value for a zone description: Enables Crypto TLS 1.3 feature for a zone. default: "off" zones_tls_1_3_value: type: string description: |- Value of the zone setting. Notes: Default value depends on the zone's plan level. enum: - "on" - "off" - zrt default: "off" zones_tls_client_auth: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - tls_client_auth example: tls_client_auth value: $ref: '#/components/schemas/zones_tls_client_auth_value' title: TLS Client Authentication description: TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). zones_tls_client_auth_value: type: string description: value of the zone setting. enum: - "on" - "off" default: "on" zones_true_client_ip_header: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - true_client_ip_header example: true_client_ip_header value: $ref: '#/components/schemas/zones_true_client_ip_header_value' title: True Client IP Header description: Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones. default: "off" zones_true_client_ip_header_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "off" zones_type: type: string description: | A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. enum: - full - partial - secondary example: full zones_url_target: type: object description: URL target. properties: constraint: allOf: - $ref: '#/components/schemas/zones_string_constraint' - properties: value: type: string description: The URL pattern to match against the current request. The pattern may contain up to four asterisks ('*') as placeholders. example: '*example.com/images/*' pattern: ^(https?://)?(([-a-zA-Z0-9*]*\.)+[-a-zA-Z0-9]{2,20})(:(8080|8443|443|80))?(/[\S]+)?$ type: object description: The constraint of a target. target: description: A target based on the URL of the request. enum: - url example: url zones_vanity_name_servers: type: array description: |- An array of domains used for custom name servers. This is only available for Business and Enterprise plans. example: - ns1.example.com - ns2.example.com items: type: string format: hostname maxLength: 253 zones_waf: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - waf example: waf value: $ref: '#/components/schemas/zones_waf_value' title: Web Application Firewall description: The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016). zones_waf_value: type: string description: Value of the zone setting. enum: - "on" - "off" default: "off" zones_webp: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - webp example: webp value: $ref: '#/components/schemas/zones_webp_value' title: Polish WebP Conversion description: When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image. zones_webp_value: type: string description: Value of the zone setting. enum: - "off" - "on" default: "off" zones_websockets: allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. enum: - websockets example: websockets value: $ref: '#/components/schemas/zones_websockets_value' title: WebSockets description: WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-). zones_websockets_value: type: string description: Value of the zone setting. enum: - "off" - "on" default: "off" zones_zone: type: object required: - id - name - development_mode - owner - account - meta - original_name_servers - original_registrar - original_dnshost - created_on - modified_on - activated_on properties: account: type: object description: The account the zone belongs to properties: id: $ref: '#/components/schemas/zones_identifier' name: type: string description: The name of the account example: Example Account Name activated_on: type: string format: date-time description: |- The last time proof of ownership was detected and the zone was made active example: "2014-01-02T00:01:00.12345Z" nullable: true readOnly: true created_on: type: string format: date-time description: When the zone was created example: "2014-01-01T05:20:00.12345Z" readOnly: true development_mode: type: number description: |- The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is 0. example: 7200 readOnly: true id: $ref: '#/components/schemas/zones_identifier' meta: type: object description: Metadata about the zone properties: cdn_only: type: boolean description: The zone is only configured for CDN example: true custom_certificate_quota: type: integer description: Number of Custom Certificates the zone can have example: 1 dns_only: type: boolean description: The zone is only configured for DNS example: true foundation_dns: type: boolean description: The zone is setup with Foundation DNS example: true page_rule_quota: type: integer description: Number of Page Rules a zone can have example: 100 phishing_detected: type: boolean description: The zone has been flagged for phishing example: false step: type: integer example: 2 modified_on: type: string format: date-time description: When the zone was last modified example: "2014-01-01T05:20:00.12345Z" readOnly: true name: type: string description: The domain name example: example.com maxLength: 253 pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$ original_dnshost: type: string description: DNS host at the time of switching to Cloudflare example: NameCheap nullable: true readOnly: true maxLength: 50 original_name_servers: type: array description: |- Original name servers before moving to Cloudflare Notes: Is this only available for full zones? example: - ns1.originaldnshost.com - ns2.originaldnshost.com nullable: true readOnly: true items: type: string format: hostname original_registrar: type: string description: Registrar for the domain at the time of switching to Cloudflare example: GoDaddy nullable: true readOnly: true owner: type: object description: The owner of the zone properties: id: $ref: '#/components/schemas/zones_identifier' name: type: string description: Name of the owner example: Example Org type: type: string description: The type of owner example: organization vanity_name_servers: type: array description: An array of domains used for custom name servers. This is only available for Business and Enterprise plans. example: - ns1.example.com - ns2.example.com items: type: string format: hostname maxLength: 253 zones_zone_settings_response_collection: allOf: - $ref: '#/components/schemas/zones_api-response-common' - properties: result: type: array items: anyOf: - $ref: '#/components/schemas/zones_0rtt' - $ref: '#/components/schemas/zones_advanced_ddos' - $ref: '#/components/schemas/zones_always_online' - $ref: '#/components/schemas/zones_always_use_https' - $ref: '#/components/schemas/zones_automatic_https_rewrites' - $ref: '#/components/schemas/zones_brotli' - $ref: '#/components/schemas/zones_browser_cache_ttl' - $ref: '#/components/schemas/zones_browser_check' - $ref: '#/components/schemas/zones_cache_level' - $ref: '#/components/schemas/zones_challenge_ttl' - $ref: '#/components/schemas/zones_ciphers' - $ref: '#/components/schemas/zones_cname_flattening' - $ref: '#/components/schemas/zones_development_mode' - $ref: '#/components/schemas/zones_early_hints' - $ref: '#/components/schemas/zones_edge_cache_ttl' - $ref: '#/components/schemas/zones_email_obfuscation' - $ref: '#/components/schemas/zones_h2_prioritization' - $ref: '#/components/schemas/zones_hotlink_protection' - $ref: '#/components/schemas/zones_http2' - $ref: '#/components/schemas/zones_http3' - $ref: '#/components/schemas/zones_image_resizing' - $ref: '#/components/schemas/zones_ip_geolocation' - $ref: '#/components/schemas/zones_ipv6' - $ref: '#/components/schemas/zones_max_upload' - $ref: '#/components/schemas/zones_min_tls_version' - $ref: '#/components/schemas/zones_minify' - $ref: '#/components/schemas/zones_mirage' - $ref: '#/components/schemas/zones_mobile_redirect' - $ref: '#/components/schemas/zones_nel' - $ref: '#/components/schemas/zones_opportunistic_encryption' - $ref: '#/components/schemas/zones_opportunistic_onion' - $ref: '#/components/schemas/zones_orange_to_orange' - $ref: '#/components/schemas/zones_origin_error_page_pass_thru' - $ref: '#/components/schemas/zones_polish' - $ref: '#/components/schemas/zones_prefetch_preload' - $ref: '#/components/schemas/zones_proxy_read_timeout' - $ref: '#/components/schemas/zones_pseudo_ipv4' - $ref: '#/components/schemas/zones_response_buffering' - $ref: '#/components/schemas/zones_rocket_loader' - $ref: '#/components/schemas/zones_schemas-automatic_platform_optimization' - $ref: '#/components/schemas/zones_security_header' - $ref: '#/components/schemas/zones_security_level' - $ref: '#/components/schemas/zones_server_side_exclude' - $ref: '#/components/schemas/zones_sha1_support' - $ref: '#/components/schemas/zones_sort_query_string_for_cache' - $ref: '#/components/schemas/zones_ssl' - $ref: '#/components/schemas/zones_ssl_recommender' - $ref: '#/components/schemas/zones_tls_1_2_only' - $ref: '#/components/schemas/zones_tls_1_3' - $ref: '#/components/schemas/zones_tls_client_auth' - $ref: '#/components/schemas/zones_true_client_ip_header' - $ref: '#/components/schemas/zones_waf' - $ref: '#/components/schemas/zones_webp' - $ref: '#/components/schemas/zones_websockets' zones_zone_settings_response_single: allOf: - $ref: '#/components/schemas/zones_api-response-common' - properties: result: type: object parameters: api-shield_api_discovery_origin_parameter: name: origin in: query 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 schema: $ref: '#/components/schemas/api-shield_api_discovery_origin' api-shield_api_discovery_state_parameter: name: state in: query description: | Filter results to only include discovery results in a particular state. States are as follows * `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 schema: $ref: '#/components/schemas/api-shield_api_discovery_state' api-shield_diff_parameter: name: diff in: query schema: type: boolean description: When `true`, only return API Discovery results that are not saved into API Shield Endpoint Management api-shield_direction_parameter: name: direction in: query schema: type: string description: Direction to order results. enum: - asc - desc example: desc api-shield_endpoint_parameter: name: endpoint in: query schema: type: string description: Filter results to only include endpoints containing this pattern. example: /api/v1 api-shield_host_parameter: name: host in: query schema: type: array description: Filter results to only include the specified hosts. uniqueItems: true items: type: string example: api.cloudflare.com api-shield_method_parameter: name: method in: query schema: type: array description: Filter results to only include the specified HTTP methods. uniqueItems: true items: type: string example: GET api-shield_omit_source: name: omit_source in: query description: Omit the source-files of schemas and only retrieve their meta-data. schema: type: boolean default: false api-shield_operation_feature_parameter: name: feature in: query description: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning. schema: type: array example: - thresholds uniqueItems: true items: type: string enum: - thresholds - parameter_schemas - schema_info example: thresholds api-shield_operation_id: name: operation_id in: path description: Identifier for the operation required: true schema: type: string format: uuid readOnly: true maxLength: 36 example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 api-shield_order_parameter: name: order in: query schema: type: string description: Field to order by enum: - host - method - endpoint - traffic_stats.requests - traffic_stats.last_updated example: method api-shield_page: name: page in: query description: Page number of paginated results. schema: default: 1 minimum: 1 api-shield_parameters-operation_id: name: operation_id in: path description: Identifier for the discovered operation required: true schema: $ref: '#/components/schemas/api-shield_uuid' api-shield_per_page: name: per_page in: query description: Maximum number of results per page. schema: default: 20 minimum: 5 maximum: 50 api-shield_schema_id: name: schema_id in: path description: Identifier for the schema-ID required: true schema: type: string format: uuid readOnly: true maxLength: 36 example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 api-shield_zone_id: name: zone_id in: path required: true schema: $ref: '#/components/schemas/api-shield_identifier' healthchecks_page: name: page in: query description: Page number of paginated results. schema: default: 1 minimum: 1 healthchecks_per_page: name: per_page in: query description: Maximum number of results per page. Must be a multiple of 5. schema: default: 25 minimum: 5 maximum: 1000 waitingroom_page: name: page in: query description: Page number of paginated results. schema: default: 1 minimum: 1 waitingroom_per_page: name: per_page in: query description: Maximum number of results per page. Must be a multiple of 5. schema: default: 25 minimum: 5 maximum: 1000 requestBodies: rulesets_CreateRuleset: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/rulesets_Ruleset' - required: - name - kind - phase - rules properties: rules: $ref: '#/components/schemas/rulesets_RequestRules' rulesets_Rule: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/rulesets_RequestRule' - properties: position: oneOf: - allOf: - $ref: '#/components/schemas/rulesets_RulePosition' - title: Before position properties: before: type: string title: Before description: The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. example: da5e8e506c8e7877fe06cdf4c41add54 pattern: ^(?:[0-9a-f]{32})?$ - allOf: - $ref: '#/components/schemas/rulesets_RulePosition' - title: After position properties: after: type: string title: After description: The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. example: 5bccdbb2a5142cd25cad8591255bd209 pattern: ^(?:[0-9a-f]{32})?$ - allOf: - $ref: '#/components/schemas/rulesets_RulePosition' - title: Index position properties: index: type: number title: Index description: An index at which to place the rule, where index 1 is the first rule. example: 1 minimum: 1 rulesets_UpdateRuleset: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/rulesets_Ruleset' - required: - rules properties: rules: $ref: '#/components/schemas/rulesets_RequestRules' workers_script_upload: required: true content: application/javascript: schema: type: string description: Raw javascript content comprising a Worker. Must be in service worker syntax. example: addEventListener('fetch', (event) => event.respondWith(new Response('OK'))) multipart/form-data: schema: oneOf: - type: object properties: : type: array 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: type: string format: binary metadata: type: object description: JSON encoded metadata about the uploaded parts and Worker configuration. properties: bindings: type: array description: List of bindings available to the worker. example: - name: MY_ENV_VAR text: my_data type: plain_text items: type: object body_part: type: string 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 compatibility_date: type: string 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" compatibility_flags: type: array 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 keep_bindings: type: array description: List of binding types to keep from previous_upload. items: type: string logpush: $ref: '#/components/schemas/workers_logpush' main_module: type: string 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 migrations: oneOf: - $ref: '#/components/schemas/workers_single_step_migrations' - $ref: '#/components/schemas/workers_stepped_migrations' description: Migrations to apply for Durable Objects associated with this Worker. placement: $ref: '#/components/schemas/workers_placement_config' tags: type: array description: List of strings to use as tags for this Worker items: type: string tail_consumers: $ref: '#/components/schemas/workers_tail_consumers' usage_model: type: string description: Usage model to apply to invocations. enum: - bundled - unbound version_tags: type: object description: Key-value pairs to use as tags for this version of this Worker - type: object properties: message: type: string description: Rollback message to be associated with this deployment. Only parsed when query param `"rollback_to"` is present. encoding: : contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream, application/source-map text/javascript: schema: type: string description: Raw javascript content comprising a Worker. Must be in service worker syntax. example: addEventListener('fetch', (event) => event.respondWith(new Response('OK'))) workers_version-post: required: true content: multipart/form-data: schema: type: object properties: : type: array 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: type: string format: binary metadata: type: object description: JSON encoded metadata about the uploaded parts and Worker configuration. properties: annotations: type: object properties: workers/message: type: string description: Human-readable message about the version. example: Fixed worker code. maxLength: 50 workers/tag: type: string description: User-provided identifier for the version. example: any-identifier-from-external-system maxLength: 20 bindings: type: array description: List of bindings available to the worker. example: - name: MY_ENV_VAR text: my_data type: plain_text items: type: object compatibility_date: type: string 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" compatibility_flags: type: array 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 keep_bindings: type: array description: List of binding types to keep from previous_upload. items: type: string main_module: type: string 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 usage_model: type: string description: Usage model to apply to invocations. enum: - standard encoding: : contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream responses: rulesets_Empty: description: An empty response. rulesets_Failure: description: A failure response. content: application/json: schema: allOf: - $ref: '#/components/schemas/rulesets_Response' - properties: result: enum: - null success: enum: - false rulesets_Ruleset: description: A ruleset response. content: application/json: schema: allOf: - $ref: '#/components/schemas/rulesets_Response' - properties: errors: enum: - [] result: allOf: - $ref: '#/components/schemas/rulesets_Ruleset' - required: - name - kind - phase - rules properties: rules: $ref: '#/components/schemas/rulesets_ResponseRules' success: enum: - true rulesets_Rulesets: description: A rulesets response. content: application/json: schema: allOf: - $ref: '#/components/schemas/rulesets_Response' - properties: errors: enum: - [] result: type: array title: Rulesets description: A list of rulesets. The returned information will not include the rules in each ruleset. items: allOf: - $ref: '#/components/schemas/rulesets_Ruleset' - required: - name - kind - phase success: enum: - true workers_4XX: description: Upload Worker Module response failure content: application/json: schema: allOf: - example: errors: [] messages: [] result: created_on: "2022-05-05T05:15:11.602148Z" etag: 777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1 handlers: - fetch id: this-is_my_script-01 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' workers_200: description: Upload Worker Module response content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_script-response-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 tail_consumers: - environment: production service: my-log-consumer usage_model: bundled success: true securitySchemes: api_email: type: apiKey name: X-Auth-Email in: header api_key: type: apiKey name: X-Auth-Key in: header api_token: type: http scheme: bearer user_service_key: type: apiKey name: X-Auth-User-Service-Key in: header 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: null 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: null 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: null success: false cache_cache_reserve_off: value: errors: [] messages: [] result: editable: true id: cache_reserve value: "off" success: true cache_dummy_error_response: value: errors: - code: 12345 message: Some error message messages: [] result: null success: false cache_origin_max_http_version_2: value: errors: [] messages: [] result: editable: true id: origin_max_http_version value: "2" success: true info: title: Cloudflare API 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 version: 4.0.0 paths: /accounts: get: tags: - Accounts summary: List Accounts description: List all accounts you have ownership or verified access to. operationId: accounts-list-accounts parameters: - name: name in: query schema: type: string description: Name of the account. example: example.com readOnly: true - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Maximum number of results per page. default: 20 minimum: 5 maximum: 50 - name: direction in: query schema: type: string description: Direction to order results. enum: - asc - desc example: desc responses: 4XX: description: List Accounts response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_collection' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: List Accounts response content: application/json: schema: $ref: '#/components/schemas/iam_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}: get: tags: - Accounts summary: Account Details description: Get information about a specific account that you are a member of. operationId: accounts-account-details parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/iam_schemas-identifier' responses: 4XX: description: Account Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_single' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Account Details response content: application/json: schema: $ref: '#/components/schemas/iam_response_single' security: - api_email: [] api_key: [] put: tags: - Accounts summary: Update Account description: Update an existing account. operationId: accounts-update-account parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/iam_schemas-identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/iam_components-schemas-account' responses: 4XX: description: Update Account response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_single' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Update Account response content: application/json: schema: $ref: '#/components/schemas/iam_response_single' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/address_maps: get: tags: - IP Address Management Address Maps summary: List Address Maps description: List all address maps owned by the account. operationId: ip-address-management-address-maps-list-address-maps parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: List Address Maps response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_components-schemas-response_collection' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: List Address Maps response content: application/json: schema: $ref: '#/components/schemas/addressing_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - IP Address Management Address Maps summary: Create Address Map description: Create a new address map under the account. operationId: ip-address-management-address-maps-create-address-map parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: schema: properties: description: $ref: '#/components/schemas/addressing_schemas-description' enabled: $ref: '#/components/schemas/addressing_enabled' responses: 4XX: description: Create Address Map response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_full_response' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Create Address Map response content: application/json: schema: $ref: '#/components/schemas/addressing_full_response' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/address_maps/{address_map_id}: delete: tags: - IP Address Management Address Maps summary: Delete Address Map 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: - name: address_map_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Address Map response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_api-response-collection' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Delete Address Map response content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-collection' security: - api_email: [] api_key: [] get: tags: - IP Address Management Address Maps summary: Address Map Details description: Show a particular address map owned by the account. operationId: ip-address-management-address-maps-address-map-details parameters: - name: address_map_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: Address Map Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_full_response' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Address Map Details response content: application/json: schema: $ref: '#/components/schemas/addressing_full_response' security: - api_email: [] api_key: [] patch: tags: - IP Address Management Address Maps summary: Update Address Map description: Modify properties of an address map owned by the account. operationId: ip-address-management-address-maps-update-address-map parameters: - name: address_map_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true 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' responses: 4XX: description: Update Address Map response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_components-schemas-single_response' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Update Address Map response content: application/json: schema: $ref: '#/components/schemas/addressing_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}: delete: tags: - IP Address Management Address Maps summary: Remove an account membership from an Address Map description: Remove an account as a member of a particular address map. operationId: ip-address-management-address-maps-remove-an-account-membership-from-an-address-map parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: address_map_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Remove an account membership from an Address Map response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_api-response-collection' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Remove an account membership from an Address Map response content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-collection' security: - api_email: [] api_key: [] put: tags: - IP Address Management Address Maps summary: Add an account membership to an Address Map description: Add an account as a member of a particular address map. operationId: ip-address-management-address-maps-add-an-account-membership-to-an-address-map parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: address_map_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Add an account membership to an Address Map response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_api-response-collection' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Add an account membership to an Address Map response content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-collection' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}: delete: tags: - IP Address Management Address Maps summary: Remove an IP from an Address Map description: Remove an IP from a particular address map. operationId: ip-address-management-address-maps-remove-an-ip-from-an-address-map parameters: - name: ip_address in: path required: true schema: $ref: '#/components/schemas/addressing_ip_address' - name: address_map_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Remove an IP from an Address Map response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_api-response-collection' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Remove an IP from an Address Map response content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-collection' security: - api_email: [] api_key: [] put: tags: - IP Address Management Address Maps summary: Add an IP to an Address Map description: Add an IP from a prefix owned by the account to a particular address map. operationId: ip-address-management-address-maps-add-an-ip-to-an-address-map parameters: - name: ip_address in: path required: true schema: $ref: '#/components/schemas/addressing_ip_address' - name: address_map_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Add an IP to an Address Map response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_api-response-collection' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Add an IP to an Address Map response content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-collection' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}: delete: tags: - IP Address Management Address Maps summary: Remove a zone membership from an Address Map description: Remove a zone as a member of a particular address map. operationId: ip-address-management-address-maps-remove-a-zone-membership-from-an-address-map parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: address_map_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Remove a zone membership from an Address Map response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_api-response-collection' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Remove a zone membership from an Address Map response content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-collection' security: - api_email: [] api_key: [] put: tags: - IP Address Management Address Maps summary: Add a zone membership to an Address Map description: Add a zone as a member of a particular address map. operationId: ip-address-management-address-maps-add-a-zone-membership-to-an-address-map parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: address_map_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Add a zone membership to an Address Map response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_api-response-collection' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Add a zone membership to an Address Map response content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-collection' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/loa_documents: post: tags: - IP Address Management Prefixes summary: Upload LOA Document description: Submit LOA document (pdf format) under the account. operationId: ip-address-management-prefixes-upload-loa-document parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: multipart/form-data: schema: type: object required: - loa_document properties: loa_document: type: string description: LOA document to upload. example: '@document.pdf' responses: 4XX: description: Upload LOA Document response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_loa_upload_response' - $ref: '#/components/schemas/addressing_api-response-common-failure' "201": description: Upload LOA Document response content: application/json: schema: $ref: '#/components/schemas/addressing_loa_upload_response' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/loa_documents/{loa_document_id}/download: get: tags: - IP Address Management Prefixes summary: Download LOA Document description: Download specified LOA document under the account. operationId: ip-address-management-prefixes-download-loa-document parameters: - name: loa_document_id in: path required: true schema: $ref: '#/components/schemas/addressing_loa_document_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: Download LOA Document response failure content: application/json: schema: allOf: - {} - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Download LOA Document response content: application/json: schema: {} security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/prefixes: get: tags: - IP Address Management Prefixes summary: List Prefixes description: List all prefixes owned by the account. operationId: ip-address-management-prefixes-list-prefixes parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: List Prefixes response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_response_collection' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: List Prefixes response content: application/json: schema: $ref: '#/components/schemas/addressing_response_collection' security: - api_email: [] api_key: [] post: tags: - IP Address Management Prefixes summary: Add Prefix description: Add a new prefix under the account. operationId: ip-address-management-prefixes-add-prefix parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: schema: required: - cidr - loa_document_id - asn properties: asn: $ref: '#/components/schemas/addressing_asn' cidr: $ref: '#/components/schemas/addressing_cidr' loa_document_id: $ref: '#/components/schemas/addressing_loa_document_identifier' responses: 4XX: description: Add Prefix response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_single_response' - $ref: '#/components/schemas/addressing_api-response-common-failure' "201": description: Add Prefix response content: application/json: schema: $ref: '#/components/schemas/addressing_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/prefixes/{prefix_id}: delete: tags: - IP Address Management Prefixes summary: Delete Prefix description: Delete an unapproved prefix owned by the account. operationId: ip-address-management-prefixes-delete-prefix parameters: - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Prefix response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_api-response-collection' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Delete Prefix response content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-collection' security: - api_email: [] api_key: [] get: tags: - IP Address Management Prefixes summary: Prefix Details description: List a particular prefix owned by the account. operationId: ip-address-management-prefixes-prefix-details parameters: - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: Prefix Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_single_response' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Prefix Details response content: application/json: schema: $ref: '#/components/schemas/addressing_single_response' security: - api_email: [] api_key: [] patch: tags: - IP Address Management Prefixes summary: Update Prefix Description description: Modify the description for a prefix owned by the account. operationId: ip-address-management-prefixes-update-prefix-description parameters: - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: schema: required: - description properties: description: $ref: '#/components/schemas/addressing_description' responses: 4XX: description: Update Prefix Description response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_single_response' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Update Prefix Description response content: application/json: schema: $ref: '#/components/schemas/addressing_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes: get: tags: - IP Address Management BGP Prefixes summary: List BGP Prefixes 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: List BGP Prefixes response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_response_collection_bgp' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: List BGP Prefixes response content: application/json: schema: $ref: '#/components/schemas/addressing_response_collection_bgp' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}: get: tags: - IP Address Management BGP Prefixes summary: Fetch BGP Prefix description: Retrieve a single BGP Prefix according to its identifier operationId: ip-address-management-prefixes-fetch-bgp-prefix parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: bgp_prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: Fetch BGP Prefix response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_single_response_bgp' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Fetch BGP Prefix response content: application/json: schema: $ref: '#/components/schemas/addressing_single_response_bgp' security: - api_email: [] api_key: [] patch: tags: - IP Address Management BGP Prefixes summary: Update BGP Prefix 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: bgp_prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/addressing_bgp_prefix_update_advertisement' responses: 4XX: description: Update BGP Prefix response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_single_response_bgp' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Update BGP Prefix response content: application/json: schema: $ref: '#/components/schemas/addressing_single_response_bgp' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status: get: tags: - IP Address Management Dynamic Advertisement summary: Get Advertisement Status description: List the current advertisement state for a prefix. operationId: ip-address-management-dynamic-advertisement-get-advertisement-status parameters: - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: Get Advertisement Status response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_advertised_response' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Get Advertisement Status response content: application/json: schema: $ref: '#/components/schemas/addressing_advertised_response' security: - api_email: [] api_key: [] patch: tags: - IP Address Management Dynamic Advertisement summary: Update Prefix Dynamic Advertisement Status description: Advertise or withdraw BGP route for a prefix. operationId: ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status parameters: - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: schema: required: - advertised properties: advertised: $ref: '#/components/schemas/addressing_schemas-advertised' responses: 4XX: description: Update Prefix Dynamic Advertisement Status response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_advertised_response' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Update Prefix Dynamic Advertisement Status response content: application/json: schema: $ref: '#/components/schemas/addressing_advertised_response' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings: get: tags: - IP Address Management Service Bindings summary: List Service Bindings 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: List Service Bindings response failure content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Service Bindings attached to the Prefix content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/addressing_service_binding' security: - api_email: [] api_key: [] post: tags: - IP Address Management Service Bindings summary: Create Service Binding 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/addressing_create_binding_request' responses: 4XX: description: Create Service Binding response failure content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-common-failure' "201": description: The created Service Binding content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_api-response-common' - properties: result: $ref: '#/components/schemas/addressing_service_binding' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings/{binding_id}: delete: tags: - IP Address Management Service Bindings summary: Delete Service Binding description: Delete a Service Binding operationId: ip-address-management-service-bindings-delete-service-binding parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: binding_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: Delete Service Binding response failure content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Service Binding deleted content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-common' security: - api_email: [] api_key: [] get: tags: - IP Address Management Service Bindings summary: Get Service Binding description: Fetch a single Service Binding operationId: ip-address-management-service-bindings-get-service-binding parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: binding_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: Get Service Binding response failure content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: The Service Binding with the requested ID content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_api-response-common' - properties: result: $ref: '#/components/schemas/addressing_service_binding' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations: get: tags: - IP Address Management Prefix Delegation summary: List Prefix Delegations description: List all delegations for a given account IP prefix. operationId: ip-address-management-prefix-delegation-list-prefix-delegations parameters: - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: List Prefix Delegations response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_schemas-response_collection' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: List Prefix Delegations response content: application/json: schema: $ref: '#/components/schemas/addressing_schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - IP Address Management Prefix Delegation summary: Create Prefix Delegation description: Create a new account delegation for a given IP prefix. operationId: ip-address-management-prefix-delegation-create-prefix-delegation parameters: - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: schema: required: - cidr - delegated_account_id properties: cidr: $ref: '#/components/schemas/addressing_cidr' delegated_account_id: $ref: '#/components/schemas/addressing_delegated_account_identifier' responses: 4XX: description: Create Prefix Delegation response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_schemas-single_response' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Create Prefix Delegation response content: application/json: schema: $ref: '#/components/schemas/addressing_schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations/{delegation_id}: delete: tags: - IP Address Management Prefix Delegation summary: Delete Prefix Delegation description: Delete an account delegation for a given IP prefix. operationId: ip-address-management-prefix-delegation-delete-prefix-delegation parameters: - name: delegation_id in: path required: true schema: $ref: '#/components/schemas/addressing_delegation_identifier' - name: prefix_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Prefix Delegation response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_id_response' - $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Delete Prefix Delegation response content: application/json: schema: $ref: '#/components/schemas/addressing_id_response' security: - api_email: [] api_key: [] /accounts/{account_id}/addressing/services: get: tags: - IP Address Management Service Bindings summary: List Services 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/addressing_identifier' responses: 4XX: description: List Services response failure content: application/json: schema: $ref: '#/components/schemas/addressing_api-response-common-failure' "200": description: Service names and IDs content: application/json: schema: allOf: - $ref: '#/components/schemas/addressing_api-response-common' - properties: result: type: array items: properties: id: $ref: '#/components/schemas/addressing_service_identifier' name: $ref: '#/components/schemas/addressing_service_name' security: - api_email: [] api_key: [] /accounts/{account_id}/ai/authors/search: get: tags: - Workers AI summary: Author Search operationId: workers-ai-search-author parameters: - name: account_id in: path required: true schema: type: integer example: 4.8546e+07 responses: "200": description: Returns a list of authors content: application/json: schema: type: object required: - success - result - errors - messages properties: errors: type: array items: type: object messages: type: array items: type: object result: type: array items: type: object success: type: boolean "404": description: Object not found content: application/json: schema: type: object required: - success - error properties: error: type: string success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/finetunes: get: tags: - Workers AI Finetune summary: List Finetunes operationId: workers-ai-list-finetunes parameters: - name: account_id in: path required: true schema: type: integer example: 4.8546e+07 responses: "200": description: Returns all finetunes content: application/json: schema: type: object required: - success - result properties: result: type: object required: - id - model - name properties: description: type: string id: type: string format: uuid model: type: string name: type: string success: type: boolean "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_token: [] - api_email: [] api_key: [] post: tags: - Workers AI Finetune summary: Create a new Finetune operationId: workers-ai-create-finetune parameters: - name: account_id in: path required: true schema: type: integer example: 4.8546e+07 requestBody: content: application/json: schema: type: object required: - model - name properties: description: type: string model: type: string name: type: string responses: "200": description: Returns the created finetune content: application/json: schema: type: object required: - success - result properties: result: type: object required: - id - account_id - created_at - modified_at - model - name properties: account_id: type: integer example: 4.8546e+07 created_at: type: string format: date-time description: type: string id: type: string format: uuid model: type: string modified_at: type: string format: date-time name: type: string success: type: boolean "400": description: Finetune creation failed content: application/json: schema: type: object required: - errors - success properties: errors: type: string success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/finetunes/{finetune_id}/finetune-assets: post: tags: - Workers AI Finetune summary: Upload a Finetune Asset operationId: workers-ai-upload-finetune-asset parameters: - name: account_id in: path required: true schema: type: integer example: 4.8546e+07 - name: finetune_id in: path required: true schema: type: string example: bc451aef-f723-4b26-a6b2-901afd2e7a8a requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary file_name: type: string responses: "200": description: Returns the created finetune asset content: application/json: schema: type: object required: - success - result properties: result: type: object required: - id - finetune_id - file_name - bucket_name - created_at - modified_at properties: bucket_name: type: string created_at: type: string format: date-time file_name: type: string finetune_id: type: string example: bc451aef-f723-4b26-a6b2-901afd2e7a8a id: type: string format: uuid modified_at: type: string format: date-time success: type: boolean "400": description: Finetune creation failed content: application/json: schema: type: object required: - errors - success properties: errors: type: string success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/models/search: get: tags: - Workers AI summary: Model Search operationId: workers-ai-search-model parameters: - name: account_id in: path required: true schema: type: integer example: 4.8546e+07 - name: per_page in: query schema: type: integer - name: page in: query schema: type: integer - name: task in: query description: Filter by Task Name schema: type: string description: Filter by Task Name - name: author in: query description: Filter by Author schema: type: string description: Filter by Author - name: source in: query description: Filter by Source Id schema: type: number description: Filter by Source Id - name: hide_experimental in: query description: Filter to hide experimental models schema: type: boolean description: Filter to hide experimental models - name: search in: query description: Search schema: type: string description: Search responses: "200": description: Returns a list of models content: application/json: schema: type: object required: - success - result - errors - messages properties: errors: type: array items: type: object messages: type: array items: type: object result: type: array items: type: object success: type: boolean "404": description: Object not found content: application/json: schema: type: object required: - success - error properties: error: type: string success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/baai/bge-base-en-v1.5: post: tags: - Workers AI Text Embeddings summary: Execute @cf/baai/bge-base-en-v1.5 model. operationId: workers-ai-post-run-cf-baai-bge-base-en-v1-5 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - text properties: text: oneOf: - type: string minLength: 1 - type: array maxItems: 100 items: type: string minLength: 1 responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: object properties: data: type: array items: type: array items: type: number shape: type: array items: type: number success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/baai/bge-large-en-v1.5: post: tags: - Workers AI Text Embeddings summary: Execute @cf/baai/bge-large-en-v1.5 model. operationId: workers-ai-post-run-cf-baai-bge-large-en-v1-5 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - text properties: text: oneOf: - type: string minLength: 1 - type: array maxItems: 100 items: type: string minLength: 1 responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: object properties: data: type: array items: type: array items: type: number shape: type: array items: type: number success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/baai/bge-small-en-v1.5: post: tags: - Workers AI Text Embeddings summary: Execute @cf/baai/bge-small-en-v1.5 model. operationId: workers-ai-post-run-cf-baai-bge-small-en-v1-5 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - text properties: text: oneOf: - type: string minLength: 1 - type: array maxItems: 100 items: type: string minLength: 1 responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: object properties: data: type: array items: type: array items: type: number shape: type: array items: type: number success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/bytedance/stable-diffusion-xl-lightning: post: tags: - Workers AI Text To Image summary: Execute @cf/bytedance/stable-diffusion-xl-lightning model. operationId: workers-ai-post-run-cf-bytedance-stable-diffusion-xl-lightning parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - prompt properties: guidance: type: number default: 7.5 image: type: array items: type: number mask: type: array items: type: number num_steps: type: integer default: 20 maximum: 20 prompt: type: string minLength: 1 strength: type: number default: 1 responses: "200": description: Successful response content: image/png: schema: type: object properties: result: type: string format: binary success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/deepseek-ai/deepseek-math-7b-instruct: post: tags: - Workers AI Text Generation summary: Execute @cf/deepseek-ai/deepseek-math-7b-instruct model. operationId: workers-ai-post-run-cf-deepseek-ai-deepseek-math-7b-instruct parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/defog/sqlcoder-7b-2: post: tags: - Workers AI Text Generation summary: Execute @cf/defog/sqlcoder-7b-2 model. operationId: workers-ai-post-run-cf-defog-sqlcoder-7b-2 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/facebook/bart-large-cnn: post: tags: - Workers AI Summarization summary: Execute @cf/facebook/bart-large-cnn model. operationId: workers-ai-post-run-cf-facebook-bart-large-cnn parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - input_text properties: input_text: type: string minLength: 1 max_length: type: integer default: 1024 responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: object properties: summary: type: string success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/facebook/detr-resnet-50: post: tags: - Workers AI Object Detection summary: Execute @cf/facebook/detr-resnet-50 model. operationId: workers-ai-post-run-cf-facebook-detr-resnet-50 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/octet-stream: schema: type: string format: binary responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: array items: type: object properties: box: type: object properties: xmax: type: number xmin: type: number ymax: type: number ymin: type: number label: type: string score: type: number success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/google/gemma-2b-it-lora: post: tags: - Workers AI Text Generation summary: Execute @cf/google/gemma-2b-it-lora model. operationId: workers-ai-post-run-cf-google-gemma-2b-it-lora parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/google/gemma-7b-it-lora: post: tags: - Workers AI Text Generation summary: Execute @cf/google/gemma-7b-it-lora model. operationId: workers-ai-post-run-cf-google-gemma-7b-it-lora parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/huggingface/distilbert-sst-2-int8: post: tags: - Workers AI Text Classification summary: Execute @cf/huggingface/distilbert-sst-2-int8 model. operationId: workers-ai-post-run-cf-huggingface-distilbert-sst-2-int8 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - text properties: text: type: string minLength: 1 responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: array items: type: object properties: label: type: string score: type: number success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/inml/inml-roberta-dga: post: tags: - Workers AI Text Classification summary: Execute @cf/inml/inml-roberta-dga model. operationId: workers-ai-post-run-cf-inml-inml-roberta-dga parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - text properties: text: type: string minLength: 1 responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: array items: type: object properties: label: type: string score: type: number success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/jpmorganchase/roberta-spam: post: tags: - Workers AI Text Classification summary: Execute @cf/jpmorganchase/roberta-spam model. operationId: workers-ai-post-run-cf-jpmorganchase-roberta-spam parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - text properties: text: type: string minLength: 1 responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: array items: type: object properties: label: type: string score: type: number success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/lykon/dreamshaper-8-lcm: post: tags: - Workers AI Text To Image summary: Execute @cf/lykon/dreamshaper-8-lcm model. operationId: workers-ai-post-run-cf-lykon-dreamshaper-8-lcm parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - prompt properties: guidance: type: number default: 7.5 image: type: array items: type: number mask: type: array items: type: number num_steps: type: integer default: 20 maximum: 20 prompt: type: string minLength: 1 strength: type: number default: 1 responses: "200": description: Successful response content: image/png: schema: type: object properties: result: type: string format: binary success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/meta-llama/llama-2-7b-chat-hf-lora: post: tags: - Workers AI Text Generation summary: Execute @cf/meta-llama/llama-2-7b-chat-hf-lora model. operationId: workers-ai-post-run-cf-meta-llama-llama-2-7b-chat-hf-lora parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/meta/llama-2-7b-chat-fp16: post: tags: - Workers AI Text Generation summary: Execute @cf/meta/llama-2-7b-chat-fp16 model. operationId: workers-ai-post-run-cf-meta-llama-2-7b-chat-fp16 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/meta/llama-2-7b-chat-int8: post: tags: - Workers AI Text Generation summary: Execute @cf/meta/llama-2-7b-chat-int8 model. operationId: workers-ai-post-run-cf-meta-llama-2-7b-chat-int8 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/meta/llama-3-8b-instruct: post: tags: - Workers AI Text Generation summary: Execute @cf/meta/llama-3-8b-instruct model. operationId: workers-ai-post-run-cf-meta-llama-3-8b-instruct parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/meta/m2m100-1.2b: post: tags: - Workers AI Translation summary: Execute @cf/meta/m2m100-1.2b model. operationId: workers-ai-post-run-cf-meta-m2m100-1-2b parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - text - target_lang properties: source_lang: type: string default: en target_lang: type: string text: type: string minLength: 1 responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: object properties: translated_text: type: string success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/microsoft/phi-2: post: tags: - Workers AI Text Generation summary: Execute @cf/microsoft/phi-2 model. operationId: workers-ai-post-run-cf-microsoft-phi-2 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/microsoft/resnet-50: post: tags: - Workers AI Image Classification summary: Execute @cf/microsoft/resnet-50 model. operationId: workers-ai-post-run-cf-microsoft-resnet-50 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/octet-stream: schema: type: string format: binary responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: array items: type: object properties: label: type: string score: type: number success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.1: post: tags: - Workers AI Text Generation summary: Execute @cf/mistral/mistral-7b-instruct-v0.1 model. operationId: workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-1 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.1-vllm: post: tags: - Workers AI Text Generation summary: Execute @cf/mistral/mistral-7b-instruct-v0.1-vllm model. operationId: workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-1-vllm parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.2-lora: post: tags: - Workers AI Text Generation summary: Execute @cf/mistral/mistral-7b-instruct-v0.2-lora model. operationId: workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-2-lora parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/mistral/mixtral-8x7b-instruct-v0.1-awq: post: tags: - Workers AI Text Generation summary: Execute @cf/mistral/mixtral-8x7b-instruct-v0.1-awq model. operationId: workers-ai-post-run-cf-mistral-mixtral-8x7b-instruct-v0-1-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/openai/whisper: post: tags: - Workers AI Speech Recognition summary: Execute @cf/openai/whisper model. operationId: workers-ai-post-run-cf-openai-whisper parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/octet-stream: schema: type: string format: binary responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: object required: - text properties: text: type: string vtt: type: string word_count: type: number words: type: array items: type: object properties: end: type: number start: type: number word: type: string success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/openai/whisper-sherpa: post: tags: - Workers AI Speech Recognition summary: Execute @cf/openai/whisper-sherpa model. operationId: workers-ai-post-run-cf-openai-whisper-sherpa parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/octet-stream: schema: type: string format: binary responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: object required: - text properties: text: type: string vtt: type: string word_count: type: number words: type: array items: type: object properties: end: type: number start: type: number word: type: string success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/openai/whisper-tiny-en: post: tags: - Workers AI Speech Recognition summary: Execute @cf/openai/whisper-tiny-en model. operationId: workers-ai-post-run-cf-openai-whisper-tiny-en parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/octet-stream: schema: type: string format: binary responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: object required: - text properties: text: type: string vtt: type: string word_count: type: number words: type: array items: type: object properties: end: type: number start: type: number word: type: string success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/openchat/openchat-3.5-0106: post: tags: - Workers AI Text Generation summary: Execute @cf/openchat/openchat-3.5-0106 model. operationId: workers-ai-post-run-cf-openchat-openchat-3-5-0106 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-0.5b-chat: post: tags: - Workers AI Text Generation summary: Execute @cf/qwen/qwen1.5-0.5b-chat model. operationId: workers-ai-post-run-cf-qwen-qwen1-5-0-5b-chat parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-1.8b-chat: post: tags: - Workers AI Text Generation summary: Execute @cf/qwen/qwen1.5-1.8b-chat model. operationId: workers-ai-post-run-cf-qwen-qwen1-5-1-8b-chat parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-7b-chat-awq: post: tags: - Workers AI Text Generation summary: Execute @cf/qwen/qwen1.5-7b-chat-awq model. operationId: workers-ai-post-run-cf-qwen-qwen1-5-7b-chat-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-14b-chat-awq: post: tags: - Workers AI Text Generation summary: Execute @cf/qwen/qwen1.5-14b-chat-awq model. operationId: workers-ai-post-run-cf-qwen-qwen1-5-14b-chat-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/runwayml/stable-diffusion-v1-5-img2img: post: tags: - Workers AI Text To Image summary: Execute @cf/runwayml/stable-diffusion-v1-5-img2img model. operationId: workers-ai-post-run-cf-runwayml-stable-diffusion-v1-5-img2img parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - prompt properties: guidance: type: number default: 7.5 image: type: array items: type: number mask: type: array items: type: number num_steps: type: integer default: 20 maximum: 20 prompt: type: string minLength: 1 strength: type: number default: 1 responses: "200": description: Successful response content: image/png: schema: type: object properties: result: type: string format: binary success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/runwayml/stable-diffusion-v1-5-inpainting: post: tags: - Workers AI Text To Image summary: Execute @cf/runwayml/stable-diffusion-v1-5-inpainting model. operationId: workers-ai-post-run-cf-runwayml-stable-diffusion-v1-5-inpainting parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - prompt properties: guidance: type: number default: 7.5 image: type: array items: type: number mask: type: array items: type: number num_steps: type: integer default: 20 maximum: 20 prompt: type: string minLength: 1 strength: type: number default: 1 responses: "200": description: Successful response content: image/png: schema: type: object properties: result: type: string format: binary success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/stabilityai/stable-diffusion-xl-base-1.0: post: tags: - Workers AI Text To Image summary: Execute @cf/stabilityai/stable-diffusion-xl-base-1.0 model. operationId: workers-ai-post-run-cf-stabilityai-stable-diffusion-xl-base-1-0 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - prompt properties: guidance: type: number default: 7.5 image: type: array items: type: number mask: type: array items: type: number num_steps: type: integer default: 20 maximum: 20 prompt: type: string minLength: 1 strength: type: number default: 1 responses: "200": description: Successful response content: image/png: schema: type: object properties: result: type: string format: binary success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/sven/test: post: tags: - Workers AI Text Generation summary: Execute @cf/sven/test model. operationId: workers-ai-post-run-cf-sven-test parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/thebloke/discolm-german-7b-v1-awq: post: tags: - Workers AI Text Generation summary: Execute @cf/thebloke/discolm-german-7b-v1-awq model. operationId: workers-ai-post-run-cf-thebloke-discolm-german-7b-v1-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/tiiuae/falcon-7b-instruct: post: tags: - Workers AI Text Generation summary: Execute @cf/tiiuae/falcon-7b-instruct model. operationId: workers-ai-post-run-cf-tiiuae-falcon-7b-instruct parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@cf/tinyllama/tinyllama-1.1b-chat-v1.0: post: tags: - Workers AI Text Generation summary: Execute @cf/tinyllama/tinyllama-1.1b-chat-v1.0 model. operationId: workers-ai-post-run-cf-tinyllama-tinyllama-1-1b-chat-v1-0 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/google/gemma-7b-it: post: tags: - Workers AI Text Generation summary: Execute @hf/google/gemma-7b-it model. operationId: workers-ai-post-run-hf-google-gemma-7b-it parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/mistral/mistral-7b-instruct-v0.2: post: tags: - Workers AI Text Generation summary: Execute @hf/mistral/mistral-7b-instruct-v0.2 model. operationId: workers-ai-post-run-hf-mistral-mistral-7b-instruct-v0-2 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/nexusflow/starling-lm-7b-beta: post: tags: - Workers AI Text Generation summary: Execute @hf/nexusflow/starling-lm-7b-beta model. operationId: workers-ai-post-run-hf-nexusflow-starling-lm-7b-beta parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/nousresearch/hermes-2-pro-mistral-7b: post: tags: - Workers AI Text Generation summary: Execute @hf/nousresearch/hermes-2-pro-mistral-7b model. operationId: workers-ai-post-run-hf-nousresearch-hermes-2-pro-mistral-7b parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/sentence-transformers/all-minilm-l6-v2: post: tags: - Workers AI Sentence Similarity summary: Execute @hf/sentence-transformers/all-minilm-l6-v2 model. operationId: workers-ai-post-run-hf-sentence-transformers-all-minilm-l6-v2 parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: type: object required: - source - sentences properties: sentences: type: array items: type: string minLength: 1 source: type: string minLength: 1 responses: "200": description: Successful response content: application/json: schema: type: object properties: result: type: array items: type: number success: type: boolean default: "true" "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/thebloke/codellama-7b-instruct-awq: post: tags: - Workers AI Text Generation summary: Execute @hf/thebloke/codellama-7b-instruct-awq model. operationId: workers-ai-post-run-hf-thebloke-codellama-7b-instruct-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/thebloke/deepseek-coder-6.7b-base-awq: post: tags: - Workers AI Text Generation summary: Execute @hf/thebloke/deepseek-coder-6.7b-base-awq model. operationId: workers-ai-post-run-hf-thebloke-deepseek-coder-6-7b-base-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/thebloke/deepseek-coder-6.7b-instruct-awq: post: tags: - Workers AI Text Generation summary: Execute @hf/thebloke/deepseek-coder-6.7b-instruct-awq model. operationId: workers-ai-post-run-hf-thebloke-deepseek-coder-6-7b-instruct-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/thebloke/llama-2-13b-chat-awq: post: tags: - Workers AI Text Generation summary: Execute @hf/thebloke/llama-2-13b-chat-awq model. operationId: workers-ai-post-run-hf-thebloke-llama-2-13b-chat-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/thebloke/llamaguard-7b-awq: post: tags: - Workers AI Text Generation summary: Execute @hf/thebloke/llamaguard-7b-awq model. operationId: workers-ai-post-run-hf-thebloke-llamaguard-7b-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/thebloke/mistral-7b-instruct-v0.1-awq: post: tags: - Workers AI Text Generation summary: Execute @hf/thebloke/mistral-7b-instruct-v0.1-awq model. operationId: workers-ai-post-run-hf-thebloke-mistral-7b-instruct-v0-1-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/thebloke/neural-chat-7b-v3-1-awq: post: tags: - Workers AI Text Generation summary: Execute @hf/thebloke/neural-chat-7b-v3-1-awq model. operationId: workers-ai-post-run-hf-thebloke-neural-chat-7b-v3-1-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/thebloke/openchat_3.5-awq: post: tags: - Workers AI Text Generation summary: Execute @hf/thebloke/openchat_3.5-awq model. operationId: workers-ai-post-run-hf-thebloke-openchat_3-5-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/thebloke/openhermes-2.5-mistral-7b-awq: post: tags: - Workers AI Text Generation summary: Execute @hf/thebloke/openhermes-2.5-mistral-7b-awq model. operationId: workers-ai-post-run-hf-thebloke-openhermes-2-5-mistral-7b-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/@hf/thebloke/zephyr-7b-beta-awq: post: tags: - Workers AI Text Generation summary: Execute @hf/thebloke/zephyr-7b-beta-awq model. operationId: workers-ai-post-run-hf-thebloke-zephyr-7b-beta-awq parameters: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 requestBody: content: application/json: schema: oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object responses: "200": description: Successful response content: application/json: schema: type: object properties: result: oneOf: - type: object properties: response: type: string - type: string format: binary success: type: boolean default: "true" text/event-stream: schema: {} "400": description: Bad request content: application/json: schema: type: object required: - errors - success - result properties: errors: type: array items: type: object required: - code - message properties: code: type: string message: type: string result: type: object success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/run/{model_name}: post: tags: - Workers AI summary: Execute AI model 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: - name: account_id in: path required: true schema: type: string example: 023e105f4ecef8ad9ca31a8372d0c353 - name: model_name in: path required: true schema: type: string requestBody: content: application/json: schema: oneOf: - type: object title: Text Classification required: - text properties: text: type: string minLength: 1 - type: object title: Text To Image required: - prompt properties: guidance: type: number default: 7.5 image: type: array items: type: number mask: type: array items: type: number num_steps: type: integer default: 20 maximum: 20 prompt: type: string minLength: 1 strength: type: number default: 1 - type: object title: Sentence Similarity required: - source - sentences properties: sentences: type: array items: type: string minLength: 1 source: type: string minLength: 1 - type: object title: Text Embeddings required: - text properties: text: oneOf: - type: string minLength: 1 - type: array maxItems: 100 items: type: string minLength: 1 - oneOf: - type: string format: binary - type: object properties: audio: type: array items: type: number type: object title: Speech Recognition - oneOf: - type: string format: binary - type: object properties: image: type: array items: type: number type: object title: Image Classification - oneOf: - type: string format: binary - type: object properties: image: type: array items: type: number type: object title: Object Detection - oneOf: - required: - prompt properties: lora: type: string max_tokens: type: integer default: 256 prompt: type: string minLength: 1 maxLength: 6144 raw: type: boolean default: false stream: type: boolean default: false - required: - messages properties: max_tokens: type: integer default: 256 messages: type: array items: type: object required: - role - content properties: content: type: string maxLength: 6144 role: type: string stream: type: boolean default: false type: object title: Text Generation - type: object title: Translation required: - text - target_lang properties: source_lang: type: string default: en target_lang: type: string text: type: string minLength: 1 - type: object title: Summarization required: - input_text properties: input_text: type: string minLength: 1 max_length: type: integer default: 1024 - oneOf: - type: string format: binary - type: object properties: image: type: array items: type: number max_tokens: type: integer default: 512 prompt: type: string type: object title: Image To Text type: object responses: "200": description: Model response content: application/json: schema: type: object properties: result: oneOf: - type: array title: Text Classification items: type: object properties: label: type: string score: type: number - type: string title: Text To Image format: binary - type: array title: Sentence Similarity items: type: number - type: object title: Text Embeddings properties: data: type: array items: type: array items: type: number shape: type: array items: type: number - type: object title: Speech Recognition required: - text properties: text: type: string vtt: type: string word_count: type: number words: type: array items: type: object properties: end: type: number start: type: number word: type: string - type: array title: Image Classification items: type: object properties: label: type: string score: type: number - type: array title: Object Detection items: type: object properties: box: type: object properties: xmax: type: number xmin: type: number ymax: type: number ymin: type: number label: type: string score: type: number - oneOf: - type: object properties: response: type: string - type: string format: binary type: object title: Text Generation - type: object title: Translation properties: translated_text: type: string - type: object title: Summarization properties: summary: type: string - type: object title: Image To Text properties: description: type: string type: object "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/ai/tasks/search: get: tags: - Workers AI summary: Task Search operationId: workers-ai-search-task parameters: - name: account_id in: path required: true schema: type: integer example: 4.8546e+07 responses: "200": description: Returns a list of tasks content: application/json: schema: type: object required: - success - result - errors - messages properties: errors: type: array items: type: object messages: type: array items: type: object result: type: array items: type: object success: type: boolean "404": description: Object not found content: application/json: schema: type: object required: - success - error properties: error: type: string success: type: boolean security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/alerting/v3/available_alerts: get: tags: - Notification Alert Types summary: Get Alert Types description: Gets a list of all alert types for which an account is eligible. operationId: notification-alert-types-get-alert-types parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' responses: 4XX: description: Get Alert Types response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_response_collection' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Get Alert Types response content: application/json: schema: $ref: '#/components/schemas/aaa_response_collection' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/alerting/v3/destinations/eligible: get: tags: - Notification Mechanism Eligibility summary: Get delivery mechanism eligibility description: Get a list of all delivery mechanism types for which an account is eligible. operationId: notification-mechanism-eligibility-get-delivery-mechanism-eligibility parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' responses: 4XX: description: Get delivery mechanism eligibility response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_schemas-response_collection' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Get delivery mechanism eligibility response content: application/json: schema: $ref: '#/components/schemas/aaa_schemas-response_collection' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/alerting/v3/destinations/pagerduty: delete: tags: - Notification destinations with PagerDuty summary: Delete PagerDuty Services description: Deletes all the PagerDuty Services connected to the account. operationId: notification-destinations-with-pager-duty-delete-pager-duty-services parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' responses: 4XX: description: Delete PagerDuty Services response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_api-response-collection' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Delete PagerDuty Services response content: application/json: schema: $ref: '#/components/schemas/aaa_api-response-collection' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Notification destinations with PagerDuty summary: List PagerDuty services description: Get a list of all configured PagerDuty services. operationId: notification-destinations-with-pager-duty-list-pager-duty-services parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' responses: 4XX: description: List PagerDuty services response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_components-schemas-response_collection' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: List PagerDuty services response content: application/json: schema: $ref: '#/components/schemas/aaa_components-schemas-response_collection' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect: post: tags: - Notification destinations with PagerDuty summary: Create PagerDuty integration token description: Creates a new token for integrating with PagerDuty. operationId: notification-destinations-with-pager-duty-connect-pager-duty parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' responses: 4XX: description: Create a token for PagerDuty integration failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_id_response' - $ref: '#/components/schemas/aaa_api-response-common-failure' "201": description: Token for PagerDuty integration content: application/json: schema: $ref: '#/components/schemas/aaa_sensitive_id_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect/{token_id}: get: tags: - Notification destinations with PagerDuty summary: Connect PagerDuty description: Links PagerDuty with the account using the integration token. operationId: notification-destinations-with-pager-duty-connect-pager-duty-token parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' - name: token_id in: path required: true schema: $ref: '#/components/schemas/aaa_integration-token' responses: 4XX: description: Create a Notification policy response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_id_response' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Create a Notification policy response content: application/json: schema: $ref: '#/components/schemas/aaa_id_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/alerting/v3/destinations/webhooks: get: tags: - Notification webhooks summary: List webhooks description: Gets a list of all configured webhook destinations. operationId: notification-webhooks-list-webhooks parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' responses: 4XX: description: List webhooks response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_webhooks_components-schemas-response_collection' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: List webhooks response content: application/json: schema: $ref: '#/components/schemas/aaa_webhooks_components-schemas-response_collection' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Notification webhooks summary: Create a webhook description: Creates a new webhook destination. operationId: notification-webhooks-create-a-webhook parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' requestBody: required: true content: application/json: schema: required: - name - url properties: name: $ref: '#/components/schemas/aaa_components-schemas-name' secret: $ref: '#/components/schemas/aaa_secret' url: $ref: '#/components/schemas/aaa_url' responses: 4XX: description: Create a webhook response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_id_response' - $ref: '#/components/schemas/aaa_api-response-common-failure' "201": description: Create a webhook response content: application/json: schema: $ref: '#/components/schemas/aaa_id_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}: delete: tags: - Notification webhooks summary: Delete a webhook description: Delete a configured webhook destination. operationId: notification-webhooks-delete-a-webhook parameters: - name: webhook_id in: path required: true schema: $ref: '#/components/schemas/aaa_webhook-id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' responses: 4XX: description: Delete a webhook response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_api-response-collection' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Delete a webhook response content: application/json: schema: $ref: '#/components/schemas/aaa_api-response-collection' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Notification webhooks summary: Get a webhook description: Get details for a single webhooks destination. operationId: notification-webhooks-get-a-webhook parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' - name: webhook_id in: path required: true schema: $ref: '#/components/schemas/aaa_webhook-id' responses: 4XX: description: Get a webhook response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_schemas-single_response' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Get a webhook response content: application/json: schema: $ref: '#/components/schemas/aaa_schemas-single_response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Notification webhooks summary: Update a webhook description: Update a webhook destination. operationId: notification-webhooks-update-a-webhook parameters: - name: webhook_id in: path required: true schema: $ref: '#/components/schemas/aaa_webhook-id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' requestBody: required: true content: application/json: schema: required: - name - url properties: name: $ref: '#/components/schemas/aaa_components-schemas-name' secret: $ref: '#/components/schemas/aaa_secret' url: $ref: '#/components/schemas/aaa_url' responses: 4XX: description: Update a webhook response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_id_response' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Update a webhook response content: application/json: schema: $ref: '#/components/schemas/aaa_id_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/alerting/v3/history: get: tags: - Notification History summary: List History description: Gets a list of history records for notifications sent to an account. The records are displayed for last `x` number of days based on the zone plan (free = 30, pro = 30, biz = 30, ent = 90). operationId: notification-history-list-history parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' - name: per_page in: query schema: $ref: '#/components/schemas/aaa_per_page' - name: before in: query schema: $ref: '#/components/schemas/aaa_before' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: since in: query schema: type: string format: date-time 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" responses: 4XX: description: List History response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_history_components-schemas-response_collection' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: List History response content: application/json: schema: $ref: '#/components/schemas/aaa_history_components-schemas-response_collection' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/alerting/v3/policies: get: tags: - Notification policies summary: List Notification policies description: Get a list of all Notification policies. operationId: notification-policies-list-notification-policies parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' responses: 4XX: description: List Notification policies response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_policies_components-schemas-response_collection' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: List Notification policies response content: application/json: schema: $ref: '#/components/schemas/aaa_policies_components-schemas-response_collection' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Notification policies summary: Create a Notification policy description: Creates a new Notification policy. operationId: notification-policies-create-a-notification-policy parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' requestBody: required: true content: application/json: schema: required: - name - alert_type - enabled - mechanisms properties: 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' responses: 4XX: description: Create a Notification policy response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_id_response' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Create a Notification policy response content: application/json: schema: $ref: '#/components/schemas/aaa_id_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/alerting/v3/policies/{policy_id}: delete: tags: - Notification policies summary: Delete a Notification policy description: Delete a Notification policy. operationId: notification-policies-delete-a-notification-policy parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' - name: policy_id in: path required: true schema: $ref: '#/components/schemas/aaa_policy-id' responses: 4XX: description: Delete a Notification policy response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_api-response-collection' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Delete a Notification policy response content: application/json: schema: $ref: '#/components/schemas/aaa_api-response-collection' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Notification policies summary: Get a Notification policy description: Get details for a single policy. operationId: notification-policies-get-a-notification-policy parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' - name: policy_id in: path required: true schema: $ref: '#/components/schemas/aaa_policy-id' responses: 4XX: description: Get a Notification policy response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_single_response' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Get a Notification policy response content: application/json: schema: $ref: '#/components/schemas/aaa_single_response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Notification policies summary: Update a Notification policy description: Update a Notification policy. operationId: notification-policies-update-a-notification-policy parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_account-id' - name: policy_id in: path required: true schema: $ref: '#/components/schemas/aaa_policy-id' requestBody: required: true content: application/json: schema: properties: 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' responses: 4XX: description: Update a Notification policy response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_id_response' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Update a Notification policy response content: application/json: schema: $ref: '#/components/schemas/aaa_id_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/audit_logs: get: tags: - Audit Logs summary: Get account audit logs 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/aaa_identifier' - name: id in: query schema: type: string description: Finds a specific log by its ID. example: f174be97-19b1-40d6-954d-70cd5fbd52db - name: export in: query schema: type: boolean description: Indicates that this request is an export of logs in CSV format. example: true - name: action.type in: query schema: type: string description: Filters by the action type. example: add - name: actor.ip in: query schema: type: string 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 - name: actor.email in: query schema: type: string format: email description: Filters by the email address of the actor that made the change. example: alice@example.com - name: since in: query schema: type: string format: date-time description: Limits the returned results to logs newer than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339. example: "2019-04-30T01:12:20Z" - name: before in: query schema: type: string format: date-time description: Limits the returned results to logs older than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339. example: "2019-04-30T01:12:20Z" - name: zone.name in: query schema: type: string description: Filters by the name of the zone associated to the change. example: example.com - name: direction in: query schema: type: string description: Changes the direction of the chronological sorting. enum: - desc - asc default: desc example: desc - name: per_page in: query schema: type: number description: Sets the number of results to return per page. default: 100 example: 25 minimum: 1 maximum: 1000 - name: page in: query schema: type: number description: Defines which page of results to return. default: 1 example: 50 minimum: 1 - name: hide_user_logs in: query schema: type: boolean description: Indicates whether or not to hide user level audit logs. default: false responses: 4XX: description: Get account audit logs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_audit_logs_response_collection' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Get account audit logs response content: application/json: schema: $ref: '#/components/schemas/aaa_audit_logs_response_collection' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/brand-protection/submit: post: tags: - Phishing URL Scanner summary: Submit suspicious URL for scanning operationId: phishing-url-scanner-submit-suspicious-url-for-scanning parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel_identifier' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/intel_url_param' type: object responses: 4XX: description: Submit suspicious URL for scanning response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/intel_phishing-url-submit_components-schemas-single_response' - $ref: '#/components/schemas/intel_api-response-common-failure' "200": description: Submit suspicious URL for scanning response content: application/json: schema: $ref: '#/components/schemas/intel_phishing-url-submit_components-schemas-single_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/brand-protection/url-info: get: tags: - Phishing URL Information summary: Get results for a URL scan operationId: phishing-url-information-get-results-for-a-url-scan parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel_identifier' - name: url_id_param in: query schema: $ref: '#/components/schemas/intel_url_id_param' - name: url in: query schema: type: string responses: 4XX: description: Get results for a URL scan response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/intel_phishing-url-info_components-schemas-single_response' - $ref: '#/components/schemas/intel_api-response-common-failure' "200": description: Get results for a URL scan response content: application/json: schema: $ref: '#/components/schemas/intel_phishing-url-info_components-schemas-single_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/calls/apps: get: tags: - Calls Apps summary: List apps description: Lists all apps in the Cloudflare account operationId: calls-apps-list parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/calls_account_identifier' responses: 4XX: description: List videos response failure content: application/json: schema: $ref: '#/components/schemas/calls_api-response-common-failure' "200": description: List apps response content: application/json: schema: $ref: '#/components/schemas/calls_app_response_collection' security: - api_token: [] post: tags: - Calls Apps summary: Create a new app 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/calls_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/calls_app_editable_fields' responses: "201": description: Created a new app content: application/json: schema: $ref: '#/components/schemas/calls_app_response_single_with_secret' security: - api_token: [] /accounts/{account_id}/calls/apps/{app_id}: delete: tags: - Calls Apps summary: Delete app description: Deletes an app from Cloudflare Calls operationId: calls-apps-delete-app parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/calls_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/calls_account_identifier' responses: 4XX: description: Delete app response failure content: application/json: {} "200": description: Delete app response content: application/json: schema: $ref: '#/components/schemas/calls_app_response_single' security: - api_token: [] get: tags: - Calls Apps summary: Retrieve app details description: Fetches details for a single Calls app. operationId: calls-apps-retrieve-app-details parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/calls_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/calls_account_identifier' responses: 4XX: description: Retrieve video details response failure content: application/json: schema: $ref: '#/components/schemas/calls_api-response-common-failure' "200": description: Retrieve app details response content: application/json: schema: $ref: '#/components/schemas/calls_app_response_single' security: - api_token: [] put: tags: - Calls Apps summary: Edit app details description: Edit details for a single app. operationId: calls-apps-update-app-details parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/calls_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/calls_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/calls_app_editable_fields' responses: 4XX: description: Edit app details response failure content: application/json: schema: $ref: '#/components/schemas/calls_api-response-common-failure' "200": description: Edit app details response content: application/json: schema: $ref: '#/components/schemas/calls_app_response_single' security: - api_token: [] /accounts/{account_id}/cfd_tunnel: get: tags: - Cloudflare Tunnel summary: List Cloudflare Tunnels description: Lists and filters Cloudflare Tunnels in an account. operationId: cloudflare-tunnel-list-cloudflare-tunnels parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' - name: name in: query schema: type: string description: A user-friendly name for the tunnel. example: blog - name: is_deleted in: query schema: type: boolean description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included. example: true - name: existed_at in: query schema: $ref: '#/components/schemas/tunnel_existed_at' - name: uuid in: query schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: was_active_at in: query schema: type: string format: date-time example: "2009-11-10T23:00:00Z" - name: was_inactive_at in: query schema: type: string format: date-time example: "2009-11-10T23:00:00Z" - name: include_prefix in: query schema: type: string example: vpc1- - name: exclude_prefix in: query schema: type: string example: vpc1- - name: per_page in: query schema: $ref: '#/components/schemas/tunnel_per_page' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 responses: 4XX: description: List Cloudflare Tunnels response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel-response-collection' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: List Cloudflare Tunnels response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel-response-collection' security: - api_email: [] api_key: [] post: tags: - Cloudflare Tunnel summary: Create a Cloudflare Tunnel description: Creates a new Cloudflare Tunnel in an account. operationId: cloudflare-tunnel-create-a-cloudflare-tunnel parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object required: - name properties: config_src: $ref: '#/components/schemas/tunnel_config_src' name: $ref: '#/components/schemas/tunnel_tunnel_name' tunnel_secret: $ref: '#/components/schemas/tunnel_tunnel_secret' responses: 4XX: description: Create a Cloudflare Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel-response-single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Create a Cloudflare Tunnel response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel-response-single' security: - api_email: [] api_key: [] /accounts/{account_id}/cfd_tunnel/{tunnel_id}: delete: tags: - Cloudflare Tunnel summary: Delete a Cloudflare Tunnel description: Deletes a Cloudflare Tunnel from an account. operationId: cloudflare-tunnel-delete-a-cloudflare-tunnel parameters: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object responses: 4XX: description: Delete a Cloudflare Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel-response-single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Delete a Cloudflare Tunnel response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel-response-single' security: - api_email: [] api_key: [] get: tags: - Cloudflare Tunnel summary: Get a Cloudflare Tunnel description: Fetches a single Cloudflare Tunnel. operationId: cloudflare-tunnel-get-a-cloudflare-tunnel parameters: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' responses: 4XX: description: Get a Cloudflare Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel-response-single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Get a Cloudflare Tunnel response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel-response-single' security: - api_email: [] api_key: [] patch: tags: - Cloudflare Tunnel summary: Update a Cloudflare Tunnel description: Updates an existing Cloudflare Tunnel. operationId: cloudflare-tunnel-update-a-cloudflare-tunnel parameters: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object properties: name: $ref: '#/components/schemas/tunnel_tunnel_name' tunnel_secret: $ref: '#/components/schemas/tunnel_tunnel_secret' responses: 4XX: description: Update a Cloudflare Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel-response-single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Update a Cloudflare Tunnel response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel-response-single' security: - api_email: [] api_key: [] /accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations: get: tags: - Cloudflare Tunnel configuration summary: Get configuration description: Gets the configuration for a remotely-managed tunnel operationId: cloudflare-tunnel-configuration-get-configuration parameters: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_identifier' responses: 4XX: description: Get configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_config_response_single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Get configuration response content: application/json: schema: $ref: '#/components/schemas/tunnel_config_response_single' security: - api_email: [] api_key: [] put: tags: - Cloudflare Tunnel configuration summary: Put configuration description: Adds or updates the configuration for a remotely-managed tunnel. operationId: cloudflare-tunnel-configuration-put-configuration parameters: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_identifier' requestBody: required: true content: application/json: schema: type: object properties: config: $ref: '#/components/schemas/tunnel_config' responses: 4XX: description: Put configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_config_response_single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Put configuration response content: application/json: schema: $ref: '#/components/schemas/tunnel_config_response_single' security: - api_email: [] api_key: [] /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections: delete: tags: - Cloudflare Tunnel summary: Clean up Cloudflare Tunnel connections 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: client_id in: query schema: type: string description: UUID of the Cloudflare Tunnel Connector to disconnect. requestBody: required: true content: application/json: schema: type: object responses: 4XX: description: Clean up Cloudflare Tunnel connections response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_empty_response' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Clean up Cloudflare Tunnel connections response content: application/json: schema: $ref: '#/components/schemas/tunnel_empty_response' security: - api_email: [] api_key: [] get: tags: - Cloudflare Tunnel summary: List Cloudflare Tunnel connections description: Fetches connection details for a Cloudflare Tunnel. operationId: cloudflare-tunnel-list-cloudflare-tunnel-connections parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' responses: 4XX: description: List Cloudflare Tunnel connections response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel_connections_response' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: List Cloudflare Tunnel connections response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel_connections_response' security: - api_email: [] api_key: [] /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectors/{connector_id}: get: tags: - Cloudflare Tunnel summary: Get Cloudflare Tunnel connector description: Fetches connector and connection details for a Cloudflare Tunnel. operationId: cloudflare-tunnel-get-cloudflare-tunnel-connector parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: connector_id in: path required: true schema: $ref: '#/components/schemas/tunnel_client_id' responses: 4XX: description: Get Cloudflare Tunnel connector response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel_client_response' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Get Cloudflare Tunnel connector response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel_client_response' security: - api_email: [] api_key: [] /accounts/{account_id}/cfd_tunnel/{tunnel_id}/management: post: tags: - Cloudflare Tunnel summary: Get a Cloudflare Tunnel management token 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: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object required: - resources properties: resources: type: array items: $ref: '#/components/schemas/tunnel_management-resources' responses: 4XX: description: Cloudflare API response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel_response_token' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Get a Cloudflare Tunnel management token response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel_response_token' security: - api_email: [] api_key: [] /accounts/{account_id}/cfd_tunnel/{tunnel_id}/token: get: tags: - Cloudflare Tunnel summary: Get a Cloudflare Tunnel token description: Gets the token used to associate cloudflared with a specific tunnel. operationId: cloudflare-tunnel-get-a-cloudflare-tunnel-token parameters: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' responses: 4XX: description: Get a Cloudflare Tunnel token response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel_response_token' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Get a Cloudflare Tunnel token response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel_response_token' security: - api_email: [] api_key: [] /accounts/{account_id}/challenges/widgets: get: tags: - Turnstile summary: List Turnstile Widgets description: Lists all turnstile widgets of an account. operationId: accounts-turnstile-widgets-list responses: 4XX: description: List Turnstile Widgets Error content: application/json: schema: $ref: '#/components/schemas/turnstile_api-response-common-failure' "200": description: List Turnstile Widgets content: application/json: schema: allOf: - $ref: '#/components/schemas/turnstile_api-response-common' - properties: result_info: $ref: '#/components/schemas/turnstile_result_info' - properties: result: type: array items: $ref: '#/components/schemas/turnstile_widget_list' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Turnstile summary: Create a Turnstile Widget description: Lists challenge widgets. operationId: accounts-turnstile-widget-create requestBody: required: true content: application/json: schema: required: - name - mode - domains 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' responses: 4XX: description: Create Turnstile Widget Response Error content: application/json: schema: $ref: '#/components/schemas/turnstile_api-response-common-failure' "200": description: Create Turnstile Widget Response 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' security: - api_token: [] - api_email: [] api_key: [] parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/turnstile_identifier' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of items per page. default: 25 minimum: 5 maximum: 1000 - name: order in: query schema: description: Field to order widgets by. enum: - id - sitekey - name - created_on - modified_on example: id - name: direction in: query schema: description: Direction to order widgets. enum: - asc - desc example: asc /accounts/{account_id}/challenges/widgets/{sitekey}: delete: tags: - Turnstile summary: Delete a Turnstile Widget description: Destroy a Turnstile Widget. operationId: accounts-turnstile-widget-delete responses: 4XX: description: Delete Turnstile Widget Response content: application/json: schema: $ref: '#/components/schemas/turnstile_api-response-common-failure' "200": description: Delete Turnstile Widget Response content: application/json: schema: allOf: - $ref: '#/components/schemas/turnstile_api-response-common' - properties: result: $ref: '#/components/schemas/turnstile_widget_detail' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Turnstile summary: Turnstile Widget Details description: Show a single challenge widget configuration. operationId: accounts-turnstile-widget-get responses: 4XX: description: Turnstile Widget Details Response Error content: application/json: schema: $ref: '#/components/schemas/turnstile_api-response-common-failure' "200": description: Turnstile Widget Details Response content: application/json: schema: allOf: - $ref: '#/components/schemas/turnstile_api-response-common' - properties: result: $ref: '#/components/schemas/turnstile_widget_detail' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Turnstile summary: Update a Turnstile Widget description: Update the configuration of a widget. operationId: accounts-turnstile-widget-update requestBody: required: true content: application/json: schema: required: - name - mode - domains 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' responses: 4XX: description: Update Turnstile Widget Response Error content: application/json: schema: $ref: '#/components/schemas/turnstile_api-response-common-failure' "200": description: Update Turnstile Widget Response content: application/json: schema: allOf: - $ref: '#/components/schemas/turnstile_api-response-common' - properties: result: $ref: '#/components/schemas/turnstile_widget_detail' security: - api_token: [] - api_email: [] api_key: [] parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/turnstile_identifier' - name: sitekey in: path required: true schema: $ref: '#/components/schemas/turnstile_sitekey' /accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret: post: tags: - Turnstile summary: Rotate Secret for a Turnstile Widget 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: required: true content: application/json: schema: properties: invalidate_immediately: $ref: '#/components/schemas/turnstile_invalidate_immediately' responses: 4XX: description: Rotate Secret Response Error content: application/json: schema: $ref: '#/components/schemas/turnstile_api-response-common-failure' "200": description: Rotate Secret Response content: application/json: schema: allOf: - $ref: '#/components/schemas/turnstile_api-response-common' - properties: result: $ref: '#/components/schemas/turnstile_widget_detail' security: - api_token: [] - api_email: [] api_key: [] parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/turnstile_identifier' - name: sitekey in: path required: true schema: $ref: '#/components/schemas/turnstile_sitekey' /accounts/{account_id}/custom_ns: get: tags: - Account-Level Custom Nameservers summary: List Account Custom Nameservers description: List an account's custom nameservers. operationId: account-level-custom-nameservers-list-account-custom-nameservers parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/dns-custom-nameservers_identifier' responses: 4XX: description: List Account Custom Nameservers response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_acns_response_collection' - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure' "200": description: List Account Custom Nameservers response content: application/json: schema: $ref: '#/components/schemas/dns-custom-nameservers_acns_response_collection' security: - api_email: [] api_key: [] post: tags: - Account-Level Custom Nameservers summary: Add Account Custom Nameserver operationId: account-level-custom-nameservers-add-account-custom-nameserver parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/dns-custom-nameservers_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dns-custom-nameservers_CustomNSInput' responses: 4XX: description: Add Account Custom Nameserver response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_acns_response_single' - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure' "200": description: Add Account Custom Nameserver response content: application/json: schema: $ref: '#/components/schemas/dns-custom-nameservers_acns_response_single' security: - api_email: [] api_key: [] /accounts/{account_id}/custom_ns/{custom_ns_id}: delete: tags: - Account-Level Custom Nameservers summary: Delete Account Custom Nameserver operationId: account-level-custom-nameservers-delete-account-custom-nameserver parameters: - name: custom_ns_id in: path required: true schema: $ref: '#/components/schemas/dns-custom-nameservers_ns_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/dns-custom-nameservers_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Account Custom Nameserver response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_empty_response' - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure' "200": description: Delete Account Custom Nameserver response content: application/json: schema: $ref: '#/components/schemas/dns-custom-nameservers_empty_response' security: - api_email: [] api_key: [] /accounts/{account_id}/custom_ns/availability: get: tags: - Account-Level Custom Nameservers summary: Get Eligible Zones for Account Custom Nameservers operationId: account-level-custom-nameservers-get-eligible-zones-for-account-custom-nameservers parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/dns-custom-nameservers_identifier' responses: 4XX: description: Get Eligible Zones for Account Custom Nameservers response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_availability_response' - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure' "200": description: Get Eligible Zones for Account Custom Nameservers response content: application/json: schema: $ref: '#/components/schemas/dns-custom-nameservers_availability_response' security: - api_email: [] api_key: [] /accounts/{account_id}/custom_ns/verify: post: tags: - Account-Level Custom Nameservers summary: Verify Account Custom Nameserver Glue Records operationId: account-level-custom-nameservers-verify-account-custom-nameserver-glue-records parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/dns-custom-nameservers_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Verify Account Custom Nameserver Glue Records response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_acns_response_collection' - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure' "200": description: Verify Account Custom Nameserver Glue Records response content: application/json: schema: $ref: '#/components/schemas/dns-custom-nameservers_acns_response_collection' deprecated: true security: - api_email: [] api_key: [] /accounts/{account_id}/d1/database: get: tags: - D1 summary: List D1 Databases description: Returns a list of D1 databases. operationId: cloudflare-d1-list-databases parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/d1_account-identifier' - name: name in: query schema: type: string description: a database name to search for. - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of items per page. default: 1000 minimum: 10 maximum: 10000 responses: 4XX: description: List D1 databases response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/d1_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/d1_api-response-common-failure' "200": description: List D1 databases response content: application/json: schema: allOf: - $ref: '#/components/schemas/d1_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/d1_create-database-response' result_info: type: object properties: count: type: number description: Total number of results for the requested service example: 1 page: type: number description: Current page within paginated list of results example: 1 per_page: type: number description: Number of results per page of results example: 20 total_count: type: number description: Total results available without any search parameters example: 2000 security: - api_token: [] - api_email: [] api_key: [] post: tags: - D1 summary: Create D1 Database description: Returns the created D1 database. operationId: cloudflare-d1-create-database parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/d1_account-identifier' requestBody: required: true content: application/json: schema: type: object required: - name properties: name: $ref: '#/components/schemas/d1_database-name' responses: 4XX: description: Database details response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/d1_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/d1_api-response-common-failure' "200": description: Returns the created D1 database's metadata content: application/json: schema: allOf: - $ref: '#/components/schemas/d1_api-response-single' - properties: result: $ref: '#/components/schemas/d1_create-database-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/devices: get: tags: - Devices summary: List devices description: Fetches a list of enrolled devices. operationId: devices-list-devices parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: List devices response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_devices_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: List devices response content: application/json: schema: $ref: '#/components/schemas/teams-devices_devices_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/{device_id}: get: tags: - Devices summary: Get device details description: Fetches details for a single device. operationId: devices-device-details parameters: - name: device_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get device details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_device_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get device details response content: application/json: schema: $ref: '#/components/schemas/teams-devices_device_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/{device_id}/override_codes: get: tags: - Devices summary: Get an admin override code for a device 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: - name: device_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get an admin override code for a device response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_override_codes_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get an admin override code for a device response content: application/json: schema: $ref: '#/components/schemas/teams-devices_override_codes_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/dex_tests: get: tags: - Device DEX Tests summary: List Device DEX tests description: Fetch all DEX tests. operationId: device-dex-test-details parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Device DEX test response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_dex-single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Device DEX test details response content: application/json: schema: $ref: '#/components/schemas/teams-devices_dex-response_collection' security: - api_email: [] api_key: [] post: tags: - Device DEX Tests summary: Create Device DEX test description: Create a DEX test. operationId: device-dex-test-create-device-dex-test parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http' responses: 4XX: description: Update Dex test response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_dex-single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Update Dex test response content: application/json: schema: $ref: '#/components/schemas/teams-devices_dex-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/dex_tests/{dex_test_id}: delete: tags: - Device DEX Tests summary: Delete Device DEX test description: Delete a Device DEX test. Returns the remaining device dex tests for the account. operationId: device-dex-test-delete-device-dex-test parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' - name: dex_test_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_uuid' responses: 4XX: description: Delete DEX test response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_dex-response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Delete Device DEX test response content: application/json: schema: $ref: '#/components/schemas/teams-devices_dex-response_collection' security: - api_email: [] api_key: [] get: tags: - Device DEX Tests summary: Get Device DEX test description: Fetch a single DEX test. operationId: device-dex-test-get-device-dex-test parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' - name: dex_test_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_uuid' responses: 4XX: description: Device DEX test response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_dex-single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Device DEX test details response content: application/json: schema: $ref: '#/components/schemas/teams-devices_dex-single_response' security: - api_email: [] api_key: [] put: tags: - Device DEX Tests summary: Update Device DEX test description: Update a DEX test. operationId: device-dex-test-update-device-dex-test parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' - name: dex_test_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_uuid' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http' responses: 4XX: description: Update Dex test response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_dex-single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Update Dex test response content: application/json: schema: $ref: '#/components/schemas/teams-devices_dex-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/networks: get: tags: - Device Managed Networks summary: List your device managed networks description: Fetches a list of managed networks for an account. operationId: device-managed-networks-list-device-managed-networks parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: List your device managed networks response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_components-schemas-response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: List your device managed networks response content: application/json: schema: $ref: '#/components/schemas/teams-devices_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Device Managed Networks summary: Create a device managed network description: Creates a new device managed network. operationId: device-managed-networks-create-device-managed-network parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: required: - name - type - config 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' responses: 4XX: description: Create a device managed networks response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_components-schemas-single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Create a device managed networks response content: application/json: schema: $ref: '#/components/schemas/teams-devices_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/networks/{network_id}: delete: tags: - Device Managed Networks summary: Delete a device managed network 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: - name: network_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a device managed network response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_components-schemas-response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Delete a device managed network response content: application/json: schema: $ref: '#/components/schemas/teams-devices_components-schemas-response_collection' security: - api_email: [] api_key: [] get: tags: - Device Managed Networks summary: Get device managed network details description: Fetches details for a single managed network. operationId: device-managed-networks-device-managed-network-details parameters: - name: network_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get device managed network details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_components-schemas-single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get device managed network details response content: application/json: schema: $ref: '#/components/schemas/teams-devices_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Device Managed Networks summary: Update a device managed network description: Updates a configured device managed network. operationId: device-managed-networks-update-device-managed-network parameters: - name: network_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true 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' responses: 4XX: description: Update a device managed network response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_components-schemas-single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Update a device managed network response content: application/json: schema: $ref: '#/components/schemas/teams-devices_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/policies: get: tags: - Devices summary: List device settings profiles description: Fetches a list of the device settings profiles for an account. operationId: devices-list-device-settings-policies parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: List device settings profiles response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_device_settings_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: List device settings profiles response content: application/json: schema: $ref: '#/components/schemas/teams-devices_device_settings_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/policy: get: tags: - Devices summary: Get the default device settings profile description: Fetches the default device settings profile for an account. operationId: devices-get-default-device-settings-policy parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get the default device settings profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_default_device_settings_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get the default device settings profile response content: application/json: schema: $ref: '#/components/schemas/teams-devices_default_device_settings_response' security: - api_email: [] api_key: [] patch: tags: - Devices summary: Update the default device settings profile description: Updates the default device settings profile for an account. operationId: devices-update-default-device-settings-policy parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true 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' responses: 4XX: description: Update the default device settings profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_default_device_settings_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Update the default device settings profile response content: application/json: schema: $ref: '#/components/schemas/teams-devices_default_device_settings_response' security: - api_email: [] api_key: [] post: tags: - Devices summary: Create a device settings profile description: Creates a device settings profile to be applied to certain devices matching the criteria. operationId: devices-create-device-settings-policy parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: required: - name - precedence - match 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: type: boolean description: Whether the policy will be applied to matching devices. example: true 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: type: string description: The name of the device settings profile. example: Allow Developers maxLength: 100 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' responses: 4XX: description: Create a device settings profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_device_settings_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Create a device settings profile response content: application/json: schema: $ref: '#/components/schemas/teams-devices_device_settings_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/policy/{policy_id}: delete: tags: - Devices summary: Delete a device settings profile description: Deletes a device settings profile and fetches a list of the remaining profiles for an account. operationId: devices-delete-device-settings-policy parameters: - name: policy_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a device settings profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_device_settings_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Delete a device settings profile response content: application/json: schema: $ref: '#/components/schemas/teams-devices_device_settings_response_collection' security: - api_email: [] api_key: [] get: tags: - Devices summary: Get device settings profile by ID description: Fetches a device settings profile by ID. operationId: devices-get-device-settings-policy-by-id parameters: - name: policy_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get device settings profile by ID response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_device_settings_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get device settings profile by ID response content: application/json: schema: $ref: '#/components/schemas/teams-devices_device_settings_response' security: - api_email: [] api_key: [] patch: tags: - Devices summary: Update a device settings profile description: Updates a configured device settings profile. operationId: devices-update-device-settings-policy parameters: - name: policy_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true 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: type: boolean description: Whether the policy will be applied to matching devices. example: true exclude_office_ips: $ref: '#/components/schemas/teams-devices_exclude_office_ips' match: $ref: '#/components/schemas/teams-devices_schemas-match' name: type: string description: The name of the device settings profile. example: Allow Developers maxLength: 100 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' responses: 4XX: description: Update a device settings profile Policy response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_device_settings_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Update a device settings profile Policy response content: application/json: schema: $ref: '#/components/schemas/teams-devices_device_settings_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/policy/{policy_id}/exclude: get: tags: - Devices summary: Get the Split Tunnel exclude list for a device settings profile 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: - name: policy_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get the Split Tunnel exclude list for a device settings profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get the Split Tunnel exclude list for a device settings profile response content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' security: - api_email: [] api_key: [] put: tags: - Devices summary: Set the Split Tunnel exclude list for a device settings profile 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: - name: policy_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/teams-devices_split_tunnel' responses: 4XX: description: Set the Split Tunnel exclude list for a device settings profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Set the Split Tunnel exclude list for a device settings profile response content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/policy/{policy_id}/fallback_domains: get: tags: - Devices summary: Get the Local Domain Fallback list for a device settings profile 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: - name: policy_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get the Local Domain Fallback list for a device settings profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get the Local Domain Fallback list for a device settings profile response content: application/json: schema: $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' security: - api_email: [] api_key: [] put: tags: - Devices summary: Set the Local Domain Fallback list for a device settings profile 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: - name: policy_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/teams-devices_fallback_domain' responses: 4XX: description: Set the Local Domain Fallback list for a device settings profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Set the Local Domain Fallback list for a device settings profile response content: application/json: schema: $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/policy/{policy_id}/include: get: tags: - Devices summary: Get the Split Tunnel include list for a device settings profile 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: - name: policy_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get the Split Tunnel include list for a device settings profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get the Split Tunnel include list for a device settings profile response content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' security: - api_email: [] api_key: [] put: tags: - Devices summary: Set the Split Tunnel include list for a device settings profile 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: - name: policy_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/teams-devices_split_tunnel_include' responses: 4XX: description: Set the Split Tunnel include list for a device settings profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Set the Split Tunnel include list for a device settings profile response content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/policy/exclude: get: tags: - Devices summary: Get the Split Tunnel exclude list description: Fetches the list of routes excluded from the WARP client's tunnel. operationId: devices-get-split-tunnel-exclude-list parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get the Split Tunnel exclude list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get the Split Tunnel exclude list response content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' security: - api_email: [] api_key: [] put: tags: - Devices summary: Set the Split Tunnel exclude list description: Sets the list of routes excluded from the WARP client's tunnel. operationId: devices-set-split-tunnel-exclude-list parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/teams-devices_split_tunnel' responses: 4XX: description: Set the Split Tunnel exclude list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Set the Split Tunnel exclude list response content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/policy/fallback_domains: get: tags: - Devices summary: Get your Local Domain Fallback list 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get your Local Domain Fallback list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get your Local Domain Fallback list response content: application/json: schema: $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' security: - api_email: [] api_key: [] put: tags: - Devices summary: Set your Local Domain Fallback list 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/teams-devices_fallback_domain' responses: 4XX: description: Set your Local Domain Fallback list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Set your Local Domain Fallback list response content: application/json: schema: $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/policy/include: get: tags: - Devices summary: Get the Split Tunnel include list description: Fetches the list of routes included in the WARP client's tunnel. operationId: devices-get-split-tunnel-include-list parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get the Split Tunnel include list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get the Split Tunnel include list response content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' security: - api_email: [] api_key: [] put: tags: - Devices summary: Set the Split Tunnel include list description: Sets the list of routes included in the WARP client's tunnel. operationId: devices-set-split-tunnel-include-list parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/teams-devices_split_tunnel_include' responses: 4XX: description: Set the Split Tunnel include list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Set the Split Tunnel include list response content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/posture: get: tags: - Device posture rules summary: List device posture rules description: Fetches device posture rules for a Zero Trust account. operationId: device-posture-rules-list-device-posture-rules parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: List device posture rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: List device posture rules response content: application/json: schema: $ref: '#/components/schemas/teams-devices_response_collection' security: - api_email: [] api_key: [] post: tags: - Device posture rules summary: Create a device posture rule description: Creates a new device posture rule. operationId: device-posture-rules-create-device-posture-rule parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: required: - name - type 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' responses: 4XX: description: Create device posture rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Create device posture rule response content: application/json: schema: $ref: '#/components/schemas/teams-devices_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/posture/{rule_id}: delete: tags: - Device posture rules summary: Delete a device posture rule description: Deletes a device posture rule. operationId: device-posture-rules-delete-device-posture-rule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a device posture rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_id_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Delete a device posture rule response content: application/json: schema: $ref: '#/components/schemas/teams-devices_id_response' security: - api_email: [] api_key: [] get: tags: - Device posture rules summary: Get device posture rule details description: Fetches a single device posture rule. operationId: device-posture-rules-device-posture-rules-details parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get device posture rule details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get device posture rule details response content: application/json: schema: $ref: '#/components/schemas/teams-devices_single_response' security: - api_email: [] api_key: [] put: tags: - Device posture rules summary: Update a device posture rule description: Updates a device posture rule. operationId: device-posture-rules-update-device-posture-rule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: required: - name - type 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' responses: 4XX: description: Update a device posture rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Update a device posture rule response content: application/json: schema: $ref: '#/components/schemas/teams-devices_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/posture/integration: get: tags: - Device Posture Integrations summary: List your device posture integrations description: Fetches the list of device posture integrations for an account. operationId: device-posture-integrations-list-device-posture-integrations parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: List your device posture integrations response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_schemas-response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: List your device posture integrations response content: application/json: schema: $ref: '#/components/schemas/teams-devices_schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Device Posture Integrations summary: Create a device posture integration description: Create a new device posture integration. operationId: device-posture-integrations-create-device-posture-integration parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: required: - name - type - interval - config 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' responses: 4XX: description: Create a device posture integration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_schemas-single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Create a device posture integration response content: application/json: schema: $ref: '#/components/schemas/teams-devices_schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/posture/integration/{integration_id}: delete: tags: - Device Posture Integrations summary: Delete a device posture integration description: Delete a configured device posture integration. operationId: device-posture-integrations-delete-device-posture-integration parameters: - name: integration_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a device posture integration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_schemas-id_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Delete a device posture integration response content: application/json: schema: $ref: '#/components/schemas/teams-devices_schemas-id_response' security: - api_email: [] api_key: [] get: tags: - Device Posture Integrations summary: Get device posture integration details description: Fetches details for a single device posture integration. operationId: device-posture-integrations-device-posture-integration-details parameters: - name: integration_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get device posture integration details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_schemas-single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Get device posture integration details response content: application/json: schema: $ref: '#/components/schemas/teams-devices_schemas-single_response' security: - api_email: [] api_key: [] patch: tags: - Device Posture Integrations summary: Update a device posture integration description: Updates a configured device posture integration. operationId: device-posture-integrations-update-device-posture-integration parameters: - name: integration_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true 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' responses: 4XX: description: Update a device posture integration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_schemas-single_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Update a device posture integration response content: application/json: schema: $ref: '#/components/schemas/teams-devices_schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/revoke: post: tags: - Devices summary: Revoke devices description: Revokes a list of devices. operationId: devices-revoke-devices parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/teams-devices_revoke_devices_request' responses: 4XX: description: Revoke devices response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_api-response-single' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Revoke devices response content: application/json: schema: $ref: '#/components/schemas/teams-devices_api-response-single' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/settings: get: tags: - Zero Trust accounts summary: Get device settings for a Zero Trust account description: Describes the current device settings for a Zero Trust account. operationId: zero-trust-accounts-get-device-settings-for-zero-trust-account parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: description: Get device settings for a Zero Trust account response failure 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' "200": description: Get device settings for a Zero Trust account response content: application/json: schema: $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response' security: - api_email: [] api_key: [] put: tags: - Zero Trust accounts summary: Update device settings for a Zero Trust account description: Updates the current device settings for a Zero Trust account. operationId: zero-trust-accounts-update-device-settings-for-the-zero-trust-account parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings' responses: 4XX: description: Update device settings for a Zero Trust account response failure 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' "200": description: Update device settings for a Zero Trust account response content: application/json: schema: $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response' security: - api_email: [] api_key: [] /accounts/{account_id}/devices/unrevoke: post: tags: - Devices summary: Unrevoke devices description: Unrevokes a list of devices. operationId: devices-unrevoke-devices parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/teams-devices_unrevoke_devices_request' responses: 4XX: description: Unrevoke devices response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_api-response-single' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' "200": description: Unrevoke devices response content: application/json: schema: $ref: '#/components/schemas/teams-devices_api-response-single' security: - api_email: [] api_key: [] /accounts/{account_id}/dex/colos: get: tags: - DEX Synthetic Application Montitoring summary: List Cloudflare colos 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: - name: account_id in: path description: unique identifier linked to an account in the API request path. required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_account_identifier' - name: timeStart in: query description: Start time for connection period in RFC3339 (ISO 8601) format. required: true schema: type: string example: "2023-08-20T20:45:00Z" - name: timeEnd in: query description: End time for connection period in RFC3339 (ISO 8601) format. required: true schema: type: string example: "2023-08-24T20:45:00Z" - name: sortBy in: query description: Type of usage that colos should be sorted by. If unspecified, returns all Cloudflare colos sorted alphabetically. schema: type: string enum: - fleet-status-usage - application-tests-usage responses: 4XX: description: List colos failure response content: application/json: schema: $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure' "200": description: List colos response content: application/json: schema: allOf: - $ref: '#/components/schemas/digital-experience-monitoring_api-response-collection' - properties: result: $ref: '#/components/schemas/digital-experience-monitoring_colos_response' security: - api_email: [] api_key: [] - api_email: [] api_key: [] /accounts/{account_id}/dex/fleet-status/devices: get: tags: - DEX Synthetic Application Montitoring summary: List fleet status devices description: List details for devices using WARP operationId: dex-fleet-status-devices parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_account_identifier' - name: time_end in: query required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_timestamp' - name: time_start in: query required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_timestamp' - name: page in: query required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_page' - name: per_page in: query required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_per_page' - name: sort_by in: query schema: $ref: '#/components/schemas/digital-experience-monitoring_sort_by' - name: colo in: query schema: $ref: '#/components/schemas/digital-experience-monitoring_colo' - name: device_id in: query schema: $ref: '#/components/schemas/digital-experience-monitoring_device_id' - name: mode in: query schema: $ref: '#/components/schemas/digital-experience-monitoring_mode' - name: status in: query schema: $ref: '#/components/schemas/digital-experience-monitoring_status' - name: platform in: query schema: $ref: '#/components/schemas/digital-experience-monitoring_platform' - name: version in: query schema: $ref: '#/components/schemas/digital-experience-monitoring_version' responses: 4xx: description: List devices response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single' - $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure' "200": description: List devices response content: application/json: schema: $ref: '#/components/schemas/digital-experience-monitoring_fleet_status_devices_response' security: - api_email: [] api_key: [] - api_email: [] api_key: [] /accounts/{account_id}/dex/fleet-status/live: get: tags: - DEX Synthetic Application Montitoring summary: List fleet status details by dimension description: List details for live (up to 60 minutes) devices using WARP operationId: dex-fleet-status-live parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_account_identifier' - name: since_minutes in: query required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_since_minutes' responses: 4xx: description: List device details (live) response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single' - $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure' "200": description: List device details (live) response content: application/json: schema: $ref: '#/components/schemas/digital-experience-monitoring_fleet_status_live_response' security: - api_email: [] api_key: [] - api_email: [] api_key: [] /accounts/{account_id}/dex/fleet-status/over-time: get: tags: - DEX Synthetic Application Montitoring summary: List fleet status aggregate details by dimension description: List details for devices using WARP, up to 7 days operationId: dex-fleet-status-over-time parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_account_identifier' - name: time_end in: query required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_timestamp' - name: time_start in: query required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_timestamp' - name: colo in: query schema: $ref: '#/components/schemas/digital-experience-monitoring_colo' - name: device_id in: query schema: $ref: '#/components/schemas/digital-experience-monitoring_device_id' responses: 4xx: description: DEX HTTP test details failure response content: application/json: schema: allOf: - $ref: '#/components/schemas/digital-experience-monitoring_api-response-single' - $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure' "200": description: List DEX devices response security: - api_email: [] api_key: [] - api_email: [] api_key: [] /accounts/{account_id}/dex/http-tests/{test_id}: get: tags: - DEX Synthetic Application Montitoring summary: Get details and aggregate metrics for an http test 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: - name: account_id in: path description: unique identifier linked to an account in the API request path. required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_account_identifier' - name: test_id in: path description: unique identifier for a specific test required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_uuid' - name: deviceId in: query description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. schema: type: array items: type: string - name: timeStart in: query description: Start time for aggregate metrics in ISO ms required: true schema: type: string example: 1.689520412e+12 - name: timeEnd in: query description: End time for aggregate metrics in ISO ms required: true schema: type: string example: 1.689606812e+12 - name: interval in: query description: Time interval for aggregate time slots. required: true schema: type: string enum: - minute - hour - name: colo in: query description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param. schema: type: string responses: 4XX: description: DEX HTTP test details failure response content: application/json: schema: $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure' "200": description: DEX HTTP test details response 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' security: - api_email: [] api_key: [] - api_email: [] api_key: [] /accounts/{account_id}/dex/http-tests/{test_id}/percentiles: get: tags: - DEX Synthetic Application Montitoring summary: Get percentiles for an http test 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: - name: account_id in: path description: unique identifier linked to an account in the API request path. required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_account_identifier' - name: test_id in: path description: unique identifier for a specific test required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_uuid' - name: deviceId in: query description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. schema: type: array items: type: string - name: timeStart in: query description: Start time for aggregate metrics in ISO format required: true schema: type: string example: "2023-09-20T17:00:00Z" - name: timeEnd in: query description: End time for aggregate metrics in ISO format required: true schema: type: string example: "2023-09-20T17:00:00Z" - name: colo in: query description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param. schema: type: string responses: 4XX: description: DEX HTTP test percentiles failure response content: application/json: schema: $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure' "200": description: DEX HTTP test percentiles response 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' security: - api_email: [] api_key: [] - api_email: [] api_key: [] /accounts/{account_id}/dex/tests: get: tags: - DEX Synthetic Application Montitoring summary: List DEX test analytics description: List DEX tests operationId: dex-endpoints-list-tests parameters: - name: account_id in: path description: unique identifier linked to an account in the API request path. required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_account_identifier' - name: colo in: query description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param. schema: type: string - name: testName in: query description: Optionally filter results by test name schema: type: string - name: deviceId in: query description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. schema: type: array items: type: string - name: page in: query description: Page number of paginated results schema: type: number default: 1 minimum: 1 - name: per_page in: query description: Number of items per page schema: type: number default: 10 minimum: 1 maximum: 50 responses: 4XX: description: List DEX tests failure response content: application/json: schema: $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure' "200": description: DEX tests list response 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' security: - api_email: [] api_key: [] - api_email: [] api_key: [] /accounts/{account_id}/dex/tests/unique-devices: get: tags: - DEX Synthetic Application Montitoring summary: Get count of devices targeted 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: - name: account_id in: path description: unique identifier linked to an account in the API request path. required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_account_identifier' - name: testName in: query description: Optionally filter results by test name schema: type: string - name: deviceId in: query description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. schema: type: array items: type: string responses: 4XX: description: DEX unique devices targeted failure response content: application/json: schema: $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure' "200": description: DEX unique devices targeted response 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' security: - api_email: [] api_key: [] - api_email: [] api_key: [] /accounts/{account_id}/dex/traceroute-test-results/{test_result_id}/network-path: get: tags: - DEX Synthetic Application Montitoring summary: Get details for a specific traceroute test run description: Get a breakdown of hops and performance metrics for a specific traceroute test run operationId: dex-endpoints-traceroute-test-result-network-path parameters: - name: account_id in: path description: unique identifier linked to an account required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_account_identifier' - name: test_result_id in: path description: unique identifier for a specific traceroute test required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_uuid' responses: 4XX: description: DEX traceroute test result network path failure response content: application/json: schema: $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure' "200": description: DEX traceroute test result network path response 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' security: - api_email: [] api_key: [] - api_email: [] api_key: [] /accounts/{account_id}/dex/traceroute-tests/{test_id}: get: tags: - DEX Synthetic Application Montitoring summary: Get details and aggregate metrics for a traceroute test 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: - name: account_id in: path description: Unique identifier linked to an account required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_account_identifier' - name: test_id in: path description: Unique identifier for a specific test required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_uuid' - name: deviceId in: query description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. schema: type: array items: type: string - name: timeStart in: query description: Start time for aggregate metrics in ISO ms required: true schema: type: string example: 1.689520412e+12 - name: timeEnd in: query description: End time for aggregate metrics in ISO ms required: true schema: type: string example: 1.689606812e+12 - name: interval in: query description: Time interval for aggregate time slots. required: true schema: type: string enum: - minute - hour - name: colo in: query description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param. schema: type: string responses: 4XX: description: DEX traceroute test details response failure response content: application/json: schema: $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure' "200": description: DEX traceroute test details response 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' security: - api_email: [] api_key: [] - api_email: [] api_key: [] /accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path: get: tags: - DEX Synthetic Application Montitoring summary: Get network path breakdown for a traceroute test description: Get a breakdown of metrics by hop for individual traceroute test runs operationId: dex-endpoints-traceroute-test-network-path parameters: - name: account_id in: path description: unique identifier linked to an account required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_account_identifier' - name: test_id in: path description: unique identifier for a specific test required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_uuid' - name: deviceId in: query description: Device to filter tracroute result runs to required: true schema: type: string - name: timeStart in: query description: Start time for aggregate metrics in ISO ms required: true schema: type: string example: 1.689520412e+12 - name: timeEnd in: query description: End time for aggregate metrics in ISO ms required: true schema: type: string example: 1.689606812e+12 - name: interval in: query description: Time interval for aggregate time slots. required: true schema: type: string enum: - minute - hour responses: 4XX: description: DEX traceroute test network path failure response content: application/json: schema: $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure' "200": description: DEX traceroute test network path response 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' security: - api_email: [] api_key: [] - api_email: [] api_key: [] /accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles: get: tags: - DEX Synthetic Application Montitoring summary: Get percentiles for a traceroute test 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: - name: account_id in: path description: unique identifier linked to an account in the API request path. required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_account_identifier' - name: test_id in: path description: unique identifier for a specific test required: true schema: $ref: '#/components/schemas/digital-experience-monitoring_uuid' - name: deviceId in: query description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param. schema: type: array items: type: string - name: timeStart in: query description: Start time for aggregate metrics in ISO format required: true schema: type: string example: "2023-09-20T17:00:00Z" - name: timeEnd in: query description: End time for aggregate metrics in ISO format required: true schema: type: string example: "2023-09-20T17:00:00Z" - name: colo in: query description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param. schema: type: string responses: 4XX: description: DEX Traceroute test percentiles failure response content: application/json: schema: $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure' "200": description: DEX Traceroute test percentiles response 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' security: - api_email: [] api_key: [] - api_email: [] api_key: [] /accounts/{account_id}/diagnostics/traceroute: post: tags: - Diagnostics summary: Traceroute description: Run traceroutes from Cloudflare colos. operationId: diagnostics-traceroute parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-transit_identifier' requestBody: required: true content: application/json: schema: required: - targets properties: colos: $ref: '#/components/schemas/magic-transit_colos' options: $ref: '#/components/schemas/magic-transit_options' targets: $ref: '#/components/schemas/magic-transit_targets' responses: 4XX: description: Traceroute response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-transit_traceroute_response_collection' - $ref: '#/components/schemas/magic-transit_api-response-common-failure' "200": description: Traceroute response content: application/json: schema: $ref: '#/components/schemas/magic-transit_traceroute_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/dlp/datasets: get: tags: - DLP Datasets summary: Fetch all datasets with information about available versions. description: Fetch all datasets with information about available versions. operationId: dlp-datasets-read-all parameters: - name: account_id in: path required: true schema: type: string responses: 4XX: description: Datasets read failed content: application/json: schema: $ref: '#/components/schemas/dlp_V4ResponseError' "200": description: Datasets read successfully content: application/json: schema: $ref: '#/components/schemas/dlp_DatasetArrayResponse' security: - api_email: [] api_key: [] api_token: [] post: tags: - DLP Datasets summary: Create a new dataset. description: Create a new dataset. operationId: dlp-datasets-create parameters: - name: account_id in: path required: true schema: type: string requestBody: description: Dataset description required: true content: application/json: schema: $ref: '#/components/schemas/dlp_NewDataset' responses: 4XX: description: Dataset creation failed content: application/json: schema: $ref: '#/components/schemas/dlp_V4ResponseError' "200": description: Dataset created successfully content: application/json: schema: $ref: '#/components/schemas/dlp_DatasetCreationResponse' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/dlp/datasets/{dataset_id}: delete: tags: - DLP Datasets summary: Delete a dataset. description: |- Delete a dataset. This deletes all versions of the dataset. operationId: dlp-datasets-delete parameters: - name: account_id in: path required: true schema: type: string - name: dataset_id in: path required: true schema: type: string format: uuid responses: 4XX: description: Dataset delete failed content: application/json: schema: $ref: '#/components/schemas/dlp_V4ResponseError' "200": description: Dataset deleted successfully security: - api_email: [] api_key: [] api_token: [] get: tags: - DLP Datasets summary: Fetch a specific dataset with information about available versions. description: Fetch a specific dataset with information about available versions. operationId: dlp-datasets-read parameters: - name: account_id in: path required: true schema: type: string - name: dataset_id in: path required: true schema: type: string format: uuid responses: 4XX: description: Dataset read failed content: application/json: schema: $ref: '#/components/schemas/dlp_V4ResponseError' "200": description: Dataset read successfully content: application/json: schema: $ref: '#/components/schemas/dlp_DatasetResponse' security: - api_email: [] api_key: [] api_token: [] put: tags: - DLP Datasets summary: Update details about a dataset. description: Update details about a dataset. operationId: dlp-datasets-update parameters: - name: account_id in: path required: true schema: type: string - name: dataset_id in: path required: true schema: type: string format: uuid requestBody: description: Dataset description required: true content: application/json: schema: $ref: '#/components/schemas/dlp_DatasetUpdate' responses: 4XX: description: Dataset update failed content: application/json: schema: $ref: '#/components/schemas/dlp_V4ResponseError' "200": description: Dataset updated successfully content: application/json: schema: $ref: '#/components/schemas/dlp_DatasetResponse' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/dlp/datasets/{dataset_id}/upload: post: tags: - DLP Datasets summary: Prepare to upload a new version of a dataset. description: Prepare to upload a new version of a dataset. operationId: dlp-datasets-create-version parameters: - name: account_id in: path required: true schema: type: string - name: dataset_id in: path required: true schema: type: string format: uuid responses: 4XX: description: Dataset version creation failed content: application/json: schema: $ref: '#/components/schemas/dlp_V4ResponseError' "200": description: Dataset version created successfully content: application/json: schema: $ref: '#/components/schemas/dlp_DatasetNewVersionResponse' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version}: post: tags: - DLP Datasets summary: Upload a new version of a dataset. description: Upload a new version of a dataset. operationId: dlp-datasets-upload-version parameters: - name: account_id in: path required: true schema: type: string - name: dataset_id in: path required: true schema: type: string format: uuid - name: version in: path required: true schema: type: integer format: int64 requestBody: description: Dataset. For custom wordlists this contains UTF-8 patterns separated by newline characters. required: true content: application/octet-stream: schema: type: string responses: 4XX: description: Dataset version upload failed content: application/json: schema: $ref: '#/components/schemas/dlp_V4ResponseError' "200": description: Dataset version uploaded successfully content: application/json: schema: $ref: '#/components/schemas/dlp_DatasetResponse' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/dlp/patterns/validate: post: tags: - DLP Pattern Validation summary: Validate pattern description: Validates whether this pattern is a valid regular expression. Rejects it if the regular expression is too complex or can match an unbounded-length string. Your regex will be rejected if it uses the Kleene Star -- be sure to bound the maximum number of characters that can be matched. operationId: dlp-pattern-validation-validate-pattern parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dlp_validate_pattern' responses: 4XX: description: Validate pattern response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dlp_validate_response' - $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Validate pattern response content: application/json: schema: $ref: '#/components/schemas/dlp_validate_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/dlp/payload_log: get: tags: - DLP Payload Log Settings summary: Get settings description: Gets the current DLP payload log settings for this account. operationId: dlp-payload-log-settings-get-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' responses: 4XX: description: Get settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dlp_get_settings_response' - $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Get settings response content: application/json: schema: $ref: '#/components/schemas/dlp_get_settings_response' security: - api_email: [] api_key: [] api_token: [] put: tags: - DLP Payload Log Settings summary: Update settings description: Updates the DLP payload log settings for this account. operationId: dlp-payload-log-settings-update-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dlp_update_settings' responses: 4XX: description: Update settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dlp_update_settings_response' - $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Update settings response content: application/json: schema: $ref: '#/components/schemas/dlp_update_settings_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/dlp/profiles: get: tags: - DLP Profiles summary: List all profiles description: Lists all DLP profiles in an account. operationId: dlp-profiles-list-all-profiles parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' responses: 4XX: description: List all profiles response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dlp_response_collection' - $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: List all profiles response content: application/json: schema: $ref: '#/components/schemas/dlp_response_collection' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/dlp/profiles/{profile_id}: get: tags: - DLP Profiles summary: Get DLP Profile description: Fetches a DLP profile by ID. Supports both predefined and custom profiles operationId: dlp-profiles-get-dlp-profile parameters: - name: profile_id in: path required: true schema: $ref: '#/components/schemas/dlp_profile_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' responses: 4XX: description: Get DLP Profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dlp_either_profile_response' - $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Get DLP Profile response content: application/json: schema: $ref: '#/components/schemas/dlp_either_profile_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/dlp/profiles/custom: post: tags: - DLP Profiles summary: Create custom profiles description: Creates a set of DLP custom profiles. operationId: dlp-profiles-create-custom-profiles parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dlp_create_custom_profiles' responses: 4XX: description: Create custom profiles response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dlp_create_custom_profile_response' - $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Create custom profiles response content: application/json: schema: $ref: '#/components/schemas/dlp_create_custom_profile_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/dlp/profiles/custom/{profile_id}: delete: tags: - DLP Profiles summary: Delete custom profile description: Deletes a DLP custom profile. operationId: dlp-profiles-delete-custom-profile parameters: - name: profile_id in: path required: true schema: $ref: '#/components/schemas/dlp_profile_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete custom profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dlp_api-response-single' - $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Delete custom profile response content: application/json: schema: $ref: '#/components/schemas/dlp_api-response-single' security: - api_email: [] api_key: [] api_token: [] get: tags: - DLP Profiles summary: Get custom profile description: Fetches a custom DLP profile. operationId: dlp-profiles-get-custom-profile parameters: - name: profile_id in: path required: true schema: $ref: '#/components/schemas/dlp_profile_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' responses: 4XX: description: Get custom profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dlp_custom_profile_response' - $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Get custom profile response content: application/json: schema: $ref: '#/components/schemas/dlp_custom_profile_response' security: - api_email: [] api_key: [] api_token: [] put: tags: - DLP Profiles summary: Update custom profile description: Updates a DLP custom profile. operationId: dlp-profiles-update-custom-profile parameters: - name: profile_id in: path required: true schema: $ref: '#/components/schemas/dlp_profile_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dlp_update_custom_profile' responses: 4XX: description: Update custom profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dlp_custom_profile' - $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Update custom profile response content: application/json: schema: $ref: '#/components/schemas/dlp_custom_profile' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/dlp/profiles/predefined/{profile_id}: get: tags: - DLP Profiles summary: Get predefined profile description: Fetches a predefined DLP profile. operationId: dlp-profiles-get-predefined-profile parameters: - name: profile_id in: path required: true schema: $ref: '#/components/schemas/dlp_profile_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' responses: 4XX: description: Get predefined profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dlp_predefined_profile_response' - $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Get predefined profile response content: application/json: schema: $ref: '#/components/schemas/dlp_predefined_profile_response' security: - api_email: [] api_key: [] api_token: [] put: tags: - DLP Profiles summary: Update predefined profile description: Updates a DLP predefined profile. Only supports enabling/disabling entries. operationId: dlp-profiles-update-predefined-profile parameters: - name: profile_id in: path required: true schema: $ref: '#/components/schemas/dlp_profile_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dlp_update_predefined_profile' responses: 4XX: description: Update predefined profile response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dlp_predefined_profile' - $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Update predefined profile response content: application/json: schema: $ref: '#/components/schemas/dlp_predefined_profile' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/dns_firewall: get: tags: - DNS Firewall summary: List DNS Firewall Clusters description: List configured DNS Firewall clusters for an account. operationId: dns-firewall-list-dns-firewall-clusters parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/dns-firewall_identifier' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of clusters per page. default: 20 minimum: 1 maximum: 100 responses: 4XX: description: List DNS Firewall Clusters response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-firewall_dns_firewall_response_collection' - $ref: '#/components/schemas/dns-firewall_api-response-common-failure' "200": description: List DNS Firewall Clusters response content: application/json: schema: $ref: '#/components/schemas/dns-firewall_dns_firewall_response_collection' security: - api_email: [] api_key: [] post: tags: - DNS Firewall summary: Create DNS Firewall Cluster description: Create a configured DNS Firewall Cluster. operationId: dns-firewall-create-dns-firewall-cluster parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/dns-firewall_identifier' requestBody: required: true content: application/json: schema: required: - name - upstream_ips 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' responses: 4XX: description: Create DNS Firewall Cluster response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response' - $ref: '#/components/schemas/dns-firewall_api-response-common-failure' "200": description: Create DNS Firewall Cluster response content: application/json: schema: $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/dns_firewall/{dns_firewall_id}: delete: tags: - DNS Firewall summary: Delete DNS Firewall Cluster description: Delete a configured DNS Firewall Cluster. operationId: dns-firewall-delete-dns-firewall-cluster parameters: - name: dns_firewall_id in: path required: true schema: $ref: '#/components/schemas/dns-firewall_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/dns-firewall_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete DNS Firewall Cluster response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/dns-firewall_api-response-single' - properties: result: properties: id: $ref: '#/components/schemas/dns-firewall_identifier' - $ref: '#/components/schemas/dns-firewall_api-response-common-failure' "200": description: Delete DNS Firewall Cluster response content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-firewall_api-response-single' - properties: result: properties: id: $ref: '#/components/schemas/dns-firewall_identifier' security: - api_email: [] api_key: [] get: tags: - DNS Firewall summary: DNS Firewall Cluster Details description: Show a single configured DNS Firewall cluster for an account. operationId: dns-firewall-dns-firewall-cluster-details parameters: - name: dns_firewall_id in: path required: true schema: $ref: '#/components/schemas/dns-firewall_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/dns-firewall_identifier' responses: 4XX: description: DNS Firewall Cluster Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response' - $ref: '#/components/schemas/dns-firewall_api-response-common-failure' "200": description: DNS Firewall Cluster Details response content: application/json: schema: $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response' security: - api_email: [] api_key: [] patch: tags: - DNS Firewall summary: Update DNS Firewall Cluster description: Modify a DNS Firewall Cluster configuration. operationId: dns-firewall-update-dns-firewall-cluster parameters: - name: dns_firewall_id in: path required: true schema: $ref: '#/components/schemas/dns-firewall_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/dns-firewall_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dns-firewall_schemas-dns-firewall' responses: 4XX: description: Update DNS Firewall Cluster response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response' - $ref: '#/components/schemas/dns-firewall_api-response-common-failure' "200": description: Update DNS Firewall Cluster response content: application/json: schema: $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report: get: tags: - DNS Firewall Analytics summary: Table description: |- Retrieves a list of summarised aggregate metrics over a given time period. See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters. operationId: dns-firewall-analytics-table parameters: - name: dns_firewall_id in: path required: true schema: $ref: '#/components/schemas/dns-analytics_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/dns-analytics_identifier' - name: metrics in: query schema: $ref: '#/components/schemas/dns-analytics_metrics' - name: dimensions in: query schema: $ref: '#/components/schemas/dns-analytics_dimensions' - name: since in: query schema: $ref: '#/components/schemas/dns-analytics_since' - name: until in: query schema: $ref: '#/components/schemas/dns-analytics_until' - name: limit in: query schema: $ref: '#/components/schemas/dns-analytics_limit' - name: sort in: query schema: $ref: '#/components/schemas/dns-analytics_sort' - name: filters in: query schema: $ref: '#/components/schemas/dns-analytics_filters' responses: 4XX: description: Table response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/dns-analytics_api-response-single' - type: object properties: result: $ref: '#/components/schemas/dns-analytics_report' - $ref: '#/components/schemas/dns-analytics_api-response-common-failure' "200": description: Table response content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-analytics_api-response-single' - type: object properties: result: $ref: '#/components/schemas/dns-analytics_report' security: - api_email: [] api_key: [] /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report/bytime: get: tags: - DNS Firewall Analytics summary: By Time description: |- Retrieves a list of aggregate metrics grouped by time interval. See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters. operationId: dns-firewall-analytics-by-time parameters: - name: dns_firewall_id in: path required: true schema: $ref: '#/components/schemas/dns-analytics_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/dns-analytics_identifier' - name: metrics in: query schema: $ref: '#/components/schemas/dns-analytics_metrics' - name: dimensions in: query schema: $ref: '#/components/schemas/dns-analytics_dimensions' - name: since in: query schema: $ref: '#/components/schemas/dns-analytics_since' - name: until in: query schema: $ref: '#/components/schemas/dns-analytics_until' - name: limit in: query schema: $ref: '#/components/schemas/dns-analytics_limit' - name: sort in: query schema: $ref: '#/components/schemas/dns-analytics_sort' - name: filters in: query schema: $ref: '#/components/schemas/dns-analytics_filters' - name: time_delta in: query schema: $ref: '#/components/schemas/dns-analytics_time_delta' responses: 4XX: description: By Time response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/dns-analytics_api-response-single' - type: object properties: result: $ref: '#/components/schemas/dns-analytics_report_bytime' - $ref: '#/components/schemas/dns-analytics_api-response-common-failure' "200": description: By Time response content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-analytics_api-response-single' - type: object properties: result: $ref: '#/components/schemas/dns-analytics_report_bytime' security: - api_email: [] api_key: [] /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration: get: tags: - R2 Event Notification summary: Read Configuration description: Returns all notification rules for each queue for which bucket notifications are produced. operationId: event-notification-get-r2-bucket-configs parameters: - name: bucket_name in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' responses: "200": description: Read Configuration response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-common' - type: object properties: result: $ref: '#/components/schemas/mq_bucket-config' "404": description: No Configuration Found response content: application/json: schema: $ref: '#/components/schemas/mq_api-response-common-failure' example: errors: - code: 11015 message: workers.api.error.no_configs_found_for_bucket messages: [] result: null success: false 4XX: description: Read Configuration failure content: application/json: schema: $ref: '#/components/schemas/mq_api-response-common-failure' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id}: delete: tags: - R2 Event Notification summary: Delete Configuration 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: - name: queue_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: bucket_name in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' responses: 4XX: description: Create Configuration failure content: application/json: schema: $ref: '#/components/schemas/mq_api-response-common-failure' "200": description: Delete Configuration response content: application/json: schema: $ref: '#/components/schemas/mq_api-response-common' security: - api_email: [] api_key: [] api_token: [] put: tags: - R2 Event Notification summary: Create Configuration description: Define the rules for a given queue which will determine event notification production. operationId: event-notification-create-queue-config parameters: - name: queue_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: bucket_name in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' requestBody: required: true content: application/json: schema: type: object properties: rules: type: array description: Array of rules to drive notifications items: $ref: '#/components/schemas/mq_rule' responses: "200": description: Create Configuration response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-common' - type: object properties: result: type: object properties: event_notification_detail_id: type: string example: deadbeef-1234-4e81-5678-abadfeedbead "409": description: Duplicate Configuration failure content: application/json: schema: $ref: '#/components/schemas/mq_api-response-common-failure' example: errors: - code: 11010 message: workers.api.error.event_notification_detail_exists messages: [] result: null success: false 4XX: description: Create Configuration failure content: application/json: schema: $ref: '#/components/schemas/mq_api-response-common-failure' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/gateway: get: tags: - Zero Trust accounts summary: Get Zero Trust account information description: Gets information about the current Zero Trust account. operationId: zero-trust-accounts-get-zero-trust-account-information parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: Get Zero Trust account information response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_gateway_account' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Get Zero Trust account information response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_gateway_account' security: - api_email: [] api_key: [] post: tags: - Zero Trust accounts summary: Create Zero Trust account description: Creates a Zero Trust account with an existing Cloudflare account. operationId: zero-trust-accounts-create-zero-trust-account parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: Create Zero Trust account response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_gateway_account' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Create Zero Trust account response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_gateway_account' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/app_types: get: tags: - Zero Trust Gateway application and application type mappings summary: List application and application type mappings description: Fetches all application and application type mappings. operationId: zero-trust-gateway-application-and-application-type-mappings-list-application-and-application-type-mappings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_schemas-identifier' responses: 4XX: description: List application and application type mappings response failure 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' "200": description: List application and application type mappings response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_app-types_components-schemas-response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/audit_ssh_settings: get: tags: - Zero Trust Audit SSH Settings summary: Get Zero Trust Audit SSH settings description: Get all Zero Trust Audit SSH settings for an account. operationId: zero-trust-get-audit-ssh-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: Get Zero Trust Audit SSH Settings response failure 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' "200": description: Get Zero Trust Audit SSH settings response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Zero Trust Audit SSH Settings summary: Update Zero Trust Audit SSH settings description: Updates Zero Trust Audit SSH settings. operationId: zero-trust-update-audit-ssh-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: schema: required: - public_key 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' responses: 4XX: description: Update Zero Trust Audit SSH Setting response failure 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' "200": description: Update Zero Trust Audit SSH Setting response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/categories: get: tags: - Zero Trust Gateway categories summary: List categories description: Fetches a list of all categories. operationId: zero-trust-gateway-categories-list-categories parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_schemas-identifier' responses: 4XX: description: List categories response failure 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' "200": description: List categories response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/configuration: get: tags: - Zero Trust accounts summary: Get Zero Trust account configuration description: Fetches the current Zero Trust account configuration. operationId: zero-trust-accounts-get-zero-trust-account-configuration parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: Get Zero Trust account configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Get Zero Trust account configuration response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config' security: - api_email: [] api_key: [] patch: tags: - Zero Trust accounts summary: Patch Zero Trust account configuration 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 `custom_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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_gateway-account-settings' responses: 4XX: description: Update Zero Trust account configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Update Zero Trust account configuration response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config' security: - api_email: [] api_key: [] put: tags: - Zero Trust accounts summary: Update Zero Trust account configuration description: Updates the current Zero Trust account configuration. operationId: zero-trust-accounts-update-zero-trust-account-configuration parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_gateway-account-settings' responses: 4XX: description: Update Zero Trust account configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Update Zero Trust account configuration response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/lists: get: tags: - Zero Trust lists summary: List Zero Trust lists description: Fetches all Zero Trust lists for an account. operationId: zero-trust-lists-list-zero-trust-lists parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: List Zero Trust lists response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_response_collection' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: List Zero Trust lists response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_response_collection' security: - api_email: [] api_key: [] post: tags: - Zero Trust lists summary: Create Zero Trust list description: Creates a new Zero Trust list. operationId: zero-trust-lists-create-zero-trust-list parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: schema: required: - name - type 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_type' responses: 4XX: description: Create Zero Trust list response failure 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' "200": description: Create Zero Trust list response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_single_response_with_list_items' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/lists/{list_id}: delete: tags: - Zero Trust lists summary: Delete Zero Trust list description: Deletes a Zero Trust list. operationId: zero-trust-lists-delete-zero-trust-list parameters: - name: list_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Zero Trust list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_empty_response' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Delete Zero Trust list response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_empty_response' security: - api_email: [] api_key: [] get: tags: - Zero Trust lists summary: Get Zero Trust list details description: Fetches a single Zero Trust list. operationId: zero-trust-lists-zero-trust-list-details parameters: - name: list_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: Get Zero Trust list details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_single_response' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Get Zero Trust list details response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_single_response' security: - api_email: [] api_key: [] patch: tags: - Zero Trust lists summary: Patch Zero Trust list description: Appends or removes an item from a configured Zero Trust list. operationId: zero-trust-lists-patch-zero-trust-list parameters: - name: list_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: schema: properties: append: $ref: '#/components/schemas/zero-trust-gateway_items' remove: type: array description: A list of the item values you want to remove. items: $ref: '#/components/schemas/zero-trust-gateway_value' responses: 4XX: description: Patch Zero Trust list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_single_response' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Patch Zero Trust list response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_single_response' security: - api_email: [] api_key: [] put: tags: - Zero Trust lists summary: Update Zero Trust list description: Updates a configured Zero Trust list. operationId: zero-trust-lists-update-zero-trust-list parameters: - name: list_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: schema: required: - name properties: description: $ref: '#/components/schemas/zero-trust-gateway_description' name: $ref: '#/components/schemas/zero-trust-gateway_name' responses: 4XX: description: Update Zero Trust list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_single_response' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Update Zero Trust list response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/lists/{list_id}/items: get: tags: - Zero Trust lists summary: Get Zero Trust list items description: Fetches all items in a single Zero Trust list. operationId: zero-trust-lists-zero-trust-list-items parameters: - name: list_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: Get Zero Trust list items response failure 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' "200": description: Get Zero Trust list items response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_list_item_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/locations: get: tags: - Zero Trust Gateway locations summary: List Zero Trust Gateway locations description: Fetches Zero Trust Gateway locations for an account. operationId: zero-trust-gateway-locations-list-zero-trust-gateway-locations parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: List Zero Trust Gateway locations response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_schemas-response_collection' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: List Zero Trust Gateway locations response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Zero Trust Gateway locations summary: Create a Zero Trust Gateway location description: Creates a new Zero Trust Gateway location. operationId: zero-trust-gateway-locations-create-zero-trust-gateway-location parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: schema: required: - name properties: client_default: $ref: '#/components/schemas/zero-trust-gateway_client-default' ecs_support: $ref: '#/components/schemas/zero-trust-gateway_ecs-support' name: $ref: '#/components/schemas/zero-trust-gateway_schemas-name' networks: $ref: '#/components/schemas/zero-trust-gateway_networks' responses: 4XX: description: Create a Zero Trust Gateway location response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Create a Zero Trust Gateway location response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/locations/{location_id}: delete: tags: - Zero Trust Gateway locations summary: Delete a Zero Trust Gateway location description: Deletes a configured Zero Trust Gateway location. operationId: zero-trust-gateway-locations-delete-zero-trust-gateway-location parameters: - name: location_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a Zero Trust Gateway location response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_empty_response' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Delete a Zero Trust Gateway location response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_empty_response' security: - api_email: [] api_key: [] get: tags: - Zero Trust Gateway locations summary: Get Zero Trust Gateway location details description: Fetches a single Zero Trust Gateway location. operationId: zero-trust-gateway-locations-zero-trust-gateway-location-details parameters: - name: location_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: Get Zero Trust Gateway location details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Get Zero Trust Gateway location details response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Zero Trust Gateway locations summary: Update a Zero Trust Gateway location description: Updates a configured Zero Trust Gateway location. operationId: zero-trust-gateway-locations-update-zero-trust-gateway-location parameters: - name: location_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: schema: required: - name properties: client_default: $ref: '#/components/schemas/zero-trust-gateway_client-default' ecs_support: $ref: '#/components/schemas/zero-trust-gateway_ecs-support' name: $ref: '#/components/schemas/zero-trust-gateway_schemas-name' networks: $ref: '#/components/schemas/zero-trust-gateway_networks' responses: 4XX: description: Update a Zero Trust Gateway location response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Update a Zero Trust Gateway location response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/logging: get: tags: - Zero Trust accounts summary: Get logging settings for the Zero Trust account description: Fetches the current logging settings for Zero Trust account. operationId: zero-trust-accounts-get-logging-settings-for-the-zero-trust-account parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: Get logging settings for the Zero Trust account response failure 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' "200": description: Get logging settings for the Zero Trust account response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response' security: - api_email: [] api_key: [] put: tags: - Zero Trust accounts summary: Update Zero Trust account logging settings description: Updates logging settings for the current Zero Trust account. operationId: zero-trust-accounts-update-logging-settings-for-the-zero-trust-account parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings' responses: 4XX: description: Update logging settings for the Zero Trust account response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Update logging settings for the Zero Trust account response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/proxy_endpoints: get: tags: - Zero Trust Gateway proxy endpoints summary: Get a proxy endpoint description: Fetches a single Zero Trust Gateway proxy endpoint. operationId: zero-trust-gateway-proxy-endpoints-list-proxy-endpoints parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: Get a proxy endpoint response failure 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' "200": description: Get a proxy endpoint response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Zero Trust Gateway proxy endpoints summary: Create a proxy endpoint description: Creates a new Zero Trust Gateway proxy endpoint. operationId: zero-trust-gateway-proxy-endpoints-create-proxy-endpoint parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: schema: required: - name - ips properties: ips: $ref: '#/components/schemas/zero-trust-gateway_ips' name: $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name' responses: 4XX: description: Create a proxy endpoint response failure 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' "200": description: Create a proxy endpoint response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}: delete: tags: - Zero Trust Gateway proxy endpoints summary: Delete a proxy endpoint description: Deletes a configured Zero Trust Gateway proxy endpoint. operationId: zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint parameters: - name: proxy_endpoint_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a proxy endpoint response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_empty_response' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Delete a proxy endpoint response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_empty_response' security: - api_email: [] api_key: [] get: tags: - Zero Trust Gateway proxy endpoints summary: List proxy endpoints description: Fetches all Zero Trust Gateway proxy endpoints for an account. operationId: zero-trust-gateway-proxy-endpoints-proxy-endpoint-details parameters: - name: proxy_endpoint_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: List proxy endpoints response failure 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' "200": description: List proxy endpoints response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response' security: - api_email: [] api_key: [] patch: tags: - Zero Trust Gateway proxy endpoints summary: Update a proxy endpoint description: Updates a configured Zero Trust Gateway proxy endpoint. operationId: zero-trust-gateway-proxy-endpoints-update-proxy-endpoint parameters: - name: proxy_endpoint_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true 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' responses: 4XX: description: Update a proxy endpoint response failure 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' "200": description: Update a proxy endpoint response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/rules: get: tags: - Zero Trust Gateway rules summary: List Zero Trust Gateway rules description: Fetches the Zero Trust Gateway rules for an account. operationId: zero-trust-gateway-rules-list-zero-trust-gateway-rules parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: List Zero Trust Gateway rules response failure 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' "200": description: List Zero Trust Gateway rules response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Zero Trust Gateway rules summary: Create a Zero Trust Gateway rule description: Creates a new Zero Trust Gateway rule. operationId: zero-trust-gateway-rules-create-zero-trust-gateway-rule parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: schema: required: - name - action 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' responses: 4XX: description: Create a Zero Trust Gateway rule response failure 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' "200": description: Create a Zero Trust Gateway rule response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/gateway/rules/{rule_id}: delete: tags: - Zero Trust Gateway rules summary: Delete a Zero Trust Gateway rule description: Deletes a Zero Trust Gateway rule. operationId: zero-trust-gateway-rules-delete-zero-trust-gateway-rule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a Zero Trust Gateway rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zero-trust-gateway_empty_response' - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure' "200": description: Delete a Zero Trust Gateway rule response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_empty_response' security: - api_email: [] api_key: [] get: tags: - Zero Trust Gateway rules summary: Get Zero Trust Gateway rule details description: Fetches a single Zero Trust Gateway rule. operationId: zero-trust-gateway-rules-zero-trust-gateway-rule-details parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' responses: 4XX: description: Get Zero Trust Gateway rule details response failure 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' "200": description: Get Zero Trust Gateway rule details response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Zero Trust Gateway rules summary: Update a Zero Trust Gateway rule description: Updates a configured Zero Trust Gateway rule. operationId: zero-trust-gateway-rules-update-zero-trust-gateway-rule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid' - name: account_id in: path required: true schema: $ref: '#/components/schemas/zero-trust-gateway_identifier' requestBody: required: true content: application/json: schema: required: - name - action 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' responses: 4XX: description: Update a Zero Trust Gateway rule response failure 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' "200": description: Update a Zero Trust Gateway rule response content: application/json: schema: $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/hyperdrive/configs: get: tags: - Hyperdrive summary: List Hyperdrives description: Returns a list of Hyperdrives operationId: list-hyperdrive parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/hyperdrive_identifier' responses: 4XX: description: List Hyperdrives Failure Response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/hyperdrive_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/hyperdrive_api-response-common-failure' "200": description: List Hyperdrives Response content: application/json: schema: allOf: - $ref: '#/components/schemas/hyperdrive_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Hyperdrive summary: Create Hyperdrive description: Creates and returns a new Hyperdrive configuration. operationId: create-hyperdrive parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/hyperdrive_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/hyperdrive_create-update-hyperdrive-config' responses: 4XX: description: Create Hyperdrive Failure Response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/hyperdrive_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/hyperdrive_api-response-common-failure' "200": description: Create Hyperdrive Response content: application/json: schema: allOf: - $ref: '#/components/schemas/hyperdrive_api-response-single' - properties: result: $ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}: delete: tags: - Hyperdrive summary: Delete Hyperdrive description: Deletes the specified Hyperdrive. operationId: delete-hyperdrive parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/hyperdrive_identifier' - name: hyperdrive_id in: path required: true schema: $ref: '#/components/schemas/hyperdrive_identifier' responses: 4XX: description: Delete Hyperdrive Failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/hyperdrive_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/hyperdrive_api-response-common-failure' "200": description: Delete Hyperdrive Response content: application/json: schema: allOf: - $ref: '#/components/schemas/hyperdrive_api-response-single' - properties: result: type: object nullable: true security: - api_token: [] - api_email: [] api_key: [] get: tags: - Hyperdrive summary: Get Hyperdrive description: Returns the specified Hyperdrive configuration. operationId: get-hyperdrive parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/hyperdrive_identifier' - name: hyperdrive_id in: path required: true schema: $ref: '#/components/schemas/hyperdrive_identifier' responses: 4XX: description: Get Hyperdrive Failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/hyperdrive_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/hyperdrive_api-response-common-failure' "200": description: Get Hyperdrive Response content: application/json: schema: allOf: - $ref: '#/components/schemas/hyperdrive_api-response-single' - properties: result: $ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Hyperdrive summary: Patch Hyperdrive 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/hyperdrive_identifier' - name: hyperdrive_id in: path required: true schema: $ref: '#/components/schemas/hyperdrive_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/hyperdrive_patch-hyperdrive-config' responses: 4XX: description: Patch Hyperdrive Failure Response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/hyperdrive_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/hyperdrive_api-response-common-failure' "200": description: Patch Hyperdrive Response content: application/json: schema: allOf: - $ref: '#/components/schemas/hyperdrive_api-response-single' - properties: result: $ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Hyperdrive summary: Update Hyperdrive description: Updates and returns the specified Hyperdrive configuration. operationId: update-hyperdrive parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/hyperdrive_identifier' - name: hyperdrive_id in: path required: true schema: $ref: '#/components/schemas/hyperdrive_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/hyperdrive_create-update-hyperdrive-config' responses: 4XX: description: Update Hyperdrive Failure Response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/hyperdrive_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/hyperdrive_api-response-common-failure' "200": description: Update Hyperdrive Response content: application/json: schema: allOf: - $ref: '#/components/schemas/hyperdrive_api-response-single' - properties: result: $ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/images/v1: get: tags: - Cloudflare Images summary: List images description: List up to 100 images with one request. Use the optional parameters below to get a specific range of images. operationId: cloudflare-images-list-images parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of items per page. default: 1000 minimum: 10 maximum: 10000 responses: 4XX: description: List images response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_images_list_response' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: List images response content: application/json: schema: $ref: '#/components/schemas/images_images_list_response' deprecated: true security: - api_token: [] - api_email: [] api_key: [] post: tags: - Cloudflare Images summary: Upload an image 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/images_image_basic_upload' responses: 4XX: description: Upload an image response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_image_response_single' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Upload an image response content: application/json: schema: $ref: '#/components/schemas/images_image_response_single' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/images/v1/{image_id}: delete: tags: - Cloudflare Images summary: Delete image description: Delete an image on Cloudflare Images. On success, all copies of the image are deleted and purged from cache. operationId: cloudflare-images-delete-image parameters: - name: image_id in: path required: true schema: $ref: '#/components/schemas/images_image_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete image response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_deleted_response' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Delete image response content: application/json: schema: $ref: '#/components/schemas/images_deleted_response' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Cloudflare Images summary: Image details description: Fetch details for a single image. operationId: cloudflare-images-image-details parameters: - name: image_id in: path required: true schema: $ref: '#/components/schemas/images_image_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' responses: 4XX: description: Image details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_image_response_single' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Image details response content: application/json: schema: $ref: '#/components/schemas/images_image_response_single' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Cloudflare Images summary: Update image description: Update image access control. On access control change, all copies of the image are purged from cache. operationId: cloudflare-images-update-image parameters: - name: image_id in: path required: true schema: $ref: '#/components/schemas/images_image_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/images_image_patch_request' responses: 4XX: description: Update image response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_image_response_single' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Update image response content: application/json: schema: $ref: '#/components/schemas/images_image_response_single' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/images/v1/{image_id}/blob: get: tags: - Cloudflare Images summary: Base image description: Fetch base image. For most images this will be the originally uploaded file. For larger images it can be a near-lossless version of the original. operationId: cloudflare-images-base-image parameters: - name: image_id in: path required: true schema: $ref: '#/components/schemas/images_image_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' responses: 4XX: description: Base image response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_image_response_blob' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Base image response. Returns uploaded image data. content: image/*: schema: type: string format: binary security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/images/v1/keys: get: tags: - Cloudflare Images Keys summary: List Signing Keys description: Lists your signing keys. These can be found on your Cloudflare Images dashboard. operationId: cloudflare-images-keys-list-signing-keys parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' responses: 4XX: description: List Signing Keys response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_image_key_response_collection' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: List Signing Keys response content: application/json: schema: $ref: '#/components/schemas/images_image_key_response_collection' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/images/v1/keys/{signing_key_name}: delete: tags: - Cloudflare Images Keys summary: Delete Signing Key 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: - name: signing_key_name in: path required: true schema: $ref: '#/components/schemas/images_signing_key_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' responses: 4XX: description: Delete Signing Key response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_image_key_response_collection' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Delete Signing Key response content: application/json: schema: $ref: '#/components/schemas/images_image_key_response_collection' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Cloudflare Images Keys summary: Create a new Signing Key description: Create a new signing key with specified name. Returns all keys available. operationId: cloudflare-images-keys-add-signing-key parameters: - name: signing_key_name in: path required: true schema: $ref: '#/components/schemas/images_signing_key_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' responses: 4XX: description: Add Signing Key response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_image_key_response_collection' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Add Signing Key response content: application/json: schema: $ref: '#/components/schemas/images_image_key_response_collection' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/images/v1/stats: get: tags: - Cloudflare Images summary: Images usage statistics description: Fetch usage statistics details for Cloudflare Images. operationId: cloudflare-images-images-usage-statistics parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' responses: 4XX: description: Images usage statistics response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_images_stats_response' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Images usage statistics response content: application/json: schema: $ref: '#/components/schemas/images_images_stats_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/images/v1/variants: get: tags: - Cloudflare Images Variants summary: List variants description: Lists existing variants. operationId: cloudflare-images-variants-list-variants parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' responses: 4XX: description: List variants response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_image_variant_list_response' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: List variants response content: application/json: schema: $ref: '#/components/schemas/images_image_variant_list_response' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Cloudflare Images Variants summary: Create a variant description: Specify variants that allow you to resize images for different use cases. operationId: cloudflare-images-variants-create-a-variant parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/images_image_variant_definition' responses: 4XX: description: Create a variant response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_image_variant_simple_response' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Create a variant response content: application/json: schema: $ref: '#/components/schemas/images_image_variant_simple_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/images/v1/variants/{variant_id}: delete: tags: - Cloudflare Images Variants summary: Delete a variant description: Deleting a variant purges the cache for all images associated with the variant. operationId: cloudflare-images-variants-delete-a-variant parameters: - name: variant_id in: path required: true schema: $ref: '#/components/schemas/images_image_variant_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a variant response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_deleted_response' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Delete a variant response content: application/json: schema: $ref: '#/components/schemas/images_deleted_response' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Cloudflare Images Variants summary: Variant details description: Fetch details for a single variant. operationId: cloudflare-images-variants-variant-details parameters: - name: variant_id in: path required: true schema: $ref: '#/components/schemas/images_image_variant_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' responses: 4XX: description: Variant details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_image_variant_simple_response' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Variant details response content: application/json: schema: $ref: '#/components/schemas/images_image_variant_simple_response' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Cloudflare Images Variants summary: Update a variant description: Updating a variant purges the cache for all images associated with the variant. operationId: cloudflare-images-variants-update-a-variant parameters: - name: variant_id in: path required: true schema: $ref: '#/components/schemas/images_image_variant_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/images_image_variant_patch_request' responses: 4XX: description: Update a variant response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_image_variant_simple_response' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Update a variant response content: application/json: schema: $ref: '#/components/schemas/images_image_variant_simple_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/images/v2: get: tags: - Cloudflare Images summary: List images V2 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' - name: continuation_token in: query schema: type: string description: Continuation token for a next page. List images V2 returns continuation_token nullable: true - name: per_page in: query schema: type: number description: Number of items per page. default: 1000 minimum: 10 maximum: 10000 - name: sort_order in: query schema: type: string description: Sorting order by upload time. enum: - asc - desc default: desc responses: 4XX: description: List images response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_images_list_response_v2' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: List images response content: application/json: schema: $ref: '#/components/schemas/images_images_list_response_v2' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/images/v2/direct_upload: post: tags: - Cloudflare Images summary: Create authenticated direct upload URL V2 description: 'Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images. This method creates a draft record for a future image. It returns an upload URL and an image identifier. To verify if the image itself has been uploaded, send an image details request (accounts/:account_identifier/images/v1/:identifier), and check that the `draft: true` property is not present.' operationId: cloudflare-images-create-authenticated-direct-upload-url-v-2 parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/images_account_identifier' requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/images_image_direct_upload_request_v2' responses: 4XX: description: Create authenticated direct upload URL V2 response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/images_image_direct_upload_response_v2' - $ref: '#/components/schemas/images_api-response-common-failure' "200": description: Create authenticated direct upload URL V2 response content: application/json: schema: $ref: '#/components/schemas/images_image_direct_upload_response_v2' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/intel/asn/{asn}: get: tags: - ASN Intelligence summary: Get ASN Overview operationId: asn-intelligence-get-asn-overview parameters: - name: asn in: path required: true schema: $ref: '#/components/schemas/intel_asn' - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel_identifier' responses: 4XX: description: Get ASN Overview response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/intel_asn_components-schemas-response' - $ref: '#/components/schemas/intel_api-response-common-failure' "200": description: Get ASN Overview response content: application/json: schema: $ref: '#/components/schemas/intel_asn_components-schemas-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/intel/asn/{asn}/subnets: get: tags: - ASN Intelligence summary: Get ASN Subnets operationId: asn-intelligence-get-asn-subnets parameters: - name: asn in: path required: true schema: $ref: '#/components/schemas/intel_asn' - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel_identifier' responses: 4XX: description: Get ASN Subnets response failure content: application/json: schema: allOf: - type: object 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: type: array example: - 192.0.2.0/24 - 2001:DB8::/32 items: type: string - $ref: '#/components/schemas/intel_api-response-common-failure' "200": description: Get ASN Subnets response content: application/json: schema: type: object 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: type: array example: - 192.0.2.0/24 - 2001:DB8::/32 items: type: string security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/intel/attack-surface-report/{issue_id}/dismiss: put: tags: - Security Center Insights summary: Archive Security Center Insight operationId: archive-security-center-insight parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/security-center_identifier' - name: issue_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: dismiss: type: boolean default: true responses: 4XX: description: Client Error content: application/json: schema: $ref: '#/components/schemas/security-center_api-response-common-failure' "200": description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/security-center_api-response-single' security: - api_email: [] api_key: [] - api_token: [] /accounts/{account_id}/intel/attack-surface-report/issue-types: get: tags: - Security Center Insights summary: Get Security Center Issues Types operationId: get-security-center-issue-types parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/security-center_identifier' responses: 4XX: description: Client Error content: application/json: schema: $ref: '#/components/schemas/security-center_api-response-common-failure' "200": description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/security-center_api-response-common' - properties: result: anyOf: - type: array items: type: string security: - api_email: [] api_key: [] - api_token: [] /accounts/{account_id}/intel/attack-surface-report/issues: get: tags: - Security Center Insights summary: Get Security Center Issues operationId: get-security-center-issues parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/security-center_identifier' - name: dismissed in: query schema: $ref: '#/components/schemas/security-center_dismissed' - name: issue_class in: query schema: $ref: '#/components/schemas/security-center_issueClasses' - name: issue_type in: query schema: $ref: '#/components/schemas/security-center_issueTypes' - name: product in: query schema: $ref: '#/components/schemas/security-center_products' - name: severity in: query schema: $ref: '#/components/schemas/security-center_severityQueryParam' - name: subject in: query schema: $ref: '#/components/schemas/security-center_subjects' - name: issue_class~neq in: query schema: $ref: '#/components/schemas/security-center_issueClasses' - name: issue_type~neq in: query schema: $ref: '#/components/schemas/security-center_issueTypes' - name: product~neq in: query schema: $ref: '#/components/schemas/security-center_products' - name: severity~neq in: query schema: $ref: '#/components/schemas/security-center_severityQueryParam' - name: subject~neq in: query schema: $ref: '#/components/schemas/security-center_subjects' - name: page in: query schema: allOf: - $ref: '#/components/schemas/security-center_page' default: 1 - name: per_page in: query schema: allOf: - $ref: '#/components/schemas/security-center_perPage' default: 25 responses: 4XX: description: Client Error content: application/json: schema: $ref: '#/components/schemas/security-center_api-response-common-failure' "200": description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/security-center_api-response-common' - properties: result: anyOf: - type: object properties: count: $ref: '#/components/schemas/security-center_count' issues: type: array items: $ref: '#/components/schemas/security-center_issue' page: $ref: '#/components/schemas/security-center_page' per_page: $ref: '#/components/schemas/security-center_perPage' security: - api_email: [] api_key: [] - api_token: [] /accounts/{account_id}/intel/attack-surface-report/issues/class: get: tags: - Security Center Insights summary: Get Security Center Issue Counts by Class operationId: get-security-center-issue-counts-by-class parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/security-center_identifier' - name: dismissed in: query schema: $ref: '#/components/schemas/security-center_dismissed' - name: issue_class in: query schema: $ref: '#/components/schemas/security-center_issueClasses' - name: issue_type in: query schema: $ref: '#/components/schemas/security-center_issueTypes' - name: product in: query schema: $ref: '#/components/schemas/security-center_products' - name: severity in: query schema: $ref: '#/components/schemas/security-center_severityQueryParam' - name: subject in: query schema: $ref: '#/components/schemas/security-center_subjects' - name: issue_class~neq in: query schema: $ref: '#/components/schemas/security-center_issueClasses' - name: issue_type~neq in: query schema: $ref: '#/components/schemas/security-center_issueTypes' - name: product~neq in: query schema: $ref: '#/components/schemas/security-center_products' - name: severity~neq in: query schema: $ref: '#/components/schemas/security-center_severityQueryParam' - name: subject~neq in: query schema: $ref: '#/components/schemas/security-center_subjects' responses: 4XX: description: Client Error content: application/json: schema: $ref: '#/components/schemas/security-center_api-response-common-failure' "200": description: OK content: application/json: schema: $ref: '#/components/schemas/security-center_valueCountsResponse' security: - api_email: [] api_key: [] - api_token: [] /accounts/{account_id}/intel/attack-surface-report/issues/severity: get: tags: - Security Center Insights summary: Get Security Center Issue Counts by Severity operationId: get-security-center-issue-counts-by-severity parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/security-center_identifier' - name: dismissed in: query schema: $ref: '#/components/schemas/security-center_dismissed' - name: issue_class in: query schema: $ref: '#/components/schemas/security-center_issueClasses' - name: issue_type in: query schema: $ref: '#/components/schemas/security-center_issueTypes' - name: product in: query schema: $ref: '#/components/schemas/security-center_products' - name: severity in: query schema: $ref: '#/components/schemas/security-center_severityQueryParam' - name: subject in: query schema: $ref: '#/components/schemas/security-center_subjects' - name: issue_class~neq in: query schema: $ref: '#/components/schemas/security-center_issueClasses' - name: issue_type~neq in: query schema: $ref: '#/components/schemas/security-center_issueTypes' - name: product~neq in: query schema: $ref: '#/components/schemas/security-center_products' - name: severity~neq in: query schema: $ref: '#/components/schemas/security-center_severityQueryParam' - name: subject~neq in: query schema: $ref: '#/components/schemas/security-center_subjects' responses: 4XX: description: Client Error content: application/json: schema: $ref: '#/components/schemas/security-center_api-response-common-failure' "200": description: OK content: application/json: schema: $ref: '#/components/schemas/security-center_valueCountsResponse' security: - api_email: [] api_key: [] - api_token: [] /accounts/{account_id}/intel/attack-surface-report/issues/type: get: tags: - Security Center Insights summary: Get Security Center Issue Counts by Type operationId: get-security-center-issue-counts-by-type parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/security-center_identifier' - name: dismissed in: query schema: $ref: '#/components/schemas/security-center_dismissed' - name: issue_class in: query schema: $ref: '#/components/schemas/security-center_issueClasses' - name: issue_type in: query schema: $ref: '#/components/schemas/security-center_issueTypes' - name: product in: query schema: $ref: '#/components/schemas/security-center_products' - name: severity in: query schema: $ref: '#/components/schemas/security-center_severityQueryParam' - name: subject in: query schema: $ref: '#/components/schemas/security-center_subjects' - name: issue_class~neq in: query schema: $ref: '#/components/schemas/security-center_issueClasses' - name: issue_type~neq in: query schema: $ref: '#/components/schemas/security-center_issueTypes' - name: product~neq in: query schema: $ref: '#/components/schemas/security-center_products' - name: severity~neq in: query schema: $ref: '#/components/schemas/security-center_severityQueryParam' - name: subject~neq in: query schema: $ref: '#/components/schemas/security-center_subjects' responses: 4XX: description: Client Error content: application/json: schema: $ref: '#/components/schemas/security-center_api-response-common-failure' "200": description: OK content: application/json: schema: $ref: '#/components/schemas/security-center_valueCountsResponse' security: - api_email: [] api_key: [] - api_token: [] /accounts/{account_id}/intel/dns: get: tags: - Passive DNS by IP summary: Get Passive DNS by IP operationId: passive-dns-by-ip-get-passive-dns-by-ip parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel_identifier' - name: start_end_params in: query schema: $ref: '#/components/schemas/intel_start_end_params' - name: ipv4 in: query schema: type: string - name: page in: query schema: type: number description: Requested page within paginated list of results. example: 1 - name: per_page in: query schema: type: number description: Maximum number of results requested. example: 20 responses: 4XX: description: Get Passive DNS by IP response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/intel_components-schemas-single_response' - $ref: '#/components/schemas/intel_api-response-common-failure' "200": description: Get Passive DNS by IP response content: application/json: schema: $ref: '#/components/schemas/intel_components-schemas-single_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/intel/domain: get: tags: - Domain Intelligence summary: Get Domain Details operationId: domain-intelligence-get-domain-details parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel_identifier' - name: domain in: query schema: type: string responses: 4XX: description: Get Domain Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/intel_single_response' - $ref: '#/components/schemas/intel_api-response-common-failure' "200": description: Get Domain Details response content: application/json: schema: $ref: '#/components/schemas/intel_single_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/intel/domain-history: get: tags: - Domain History summary: Get Domain History operationId: domain-history-get-domain-history parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel_identifier' - name: domain in: query schema: example: example.com responses: 4XX: description: Get Domain History response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/intel_response' - $ref: '#/components/schemas/intel_api-response-common-failure' "200": description: Get Domain History response content: application/json: schema: $ref: '#/components/schemas/intel_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/intel/domain/bulk: get: tags: - Domain Intelligence summary: Get Multiple Domain Details operationId: domain-intelligence-get-multiple-domain-details parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel_identifier' - name: domain in: query schema: description: Accepts multiple values, i.e. `?domain=cloudflare.com&domain=example.com`. responses: 4XX: description: Get Multiple Domain Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/intel_collection_response' - $ref: '#/components/schemas/intel_api-response-common-failure' "200": description: Get Multiple Domain Details response content: application/json: schema: $ref: '#/components/schemas/intel_collection_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/intel/indicator-feeds: get: tags: - Custom Indicator Feeds summary: Get indicator feeds owned by this account operationId: custom-indicator-feeds-get-indicator-feeds parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/custom-indicator-feeds_identifier' responses: 4XX: description: Get indicator feeds response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_response' - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common-failure' "200": description: Get indicator feeds response content: application/json: schema: $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_response' security: - api_email: [] api_key: [] post: tags: - Custom Indicator Feeds summary: Create new indicator feed operationId: custom-indicator-feeds-create-indicator-feeds parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/custom-indicator-feeds_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/custom-indicator-feeds_create_feed' responses: 4XX: description: Get indicator feeds failure response content: application/json: schema: allOf: - $ref: '#/components/schemas/custom-indicator-feeds_create_feed_response' - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common-failure' "200": description: Create indicator feed response content: application/json: schema: $ref: '#/components/schemas/custom-indicator-feeds_create_feed_response' security: - api_email: [] api_key: [] /accounts/{account_id}/intel/indicator-feeds/{feed_id}: get: tags: - Custom Indicator Feeds summary: Get indicator feed metadata operationId: custom-indicator-feeds-get-indicator-feed-metadata parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/custom-indicator-feeds_identifier' - name: feed_id in: path required: true schema: $ref: '#/components/schemas/custom-indicator-feeds_feed_id' responses: 4XX: description: Get indicator feeds response failure 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' "200": description: Get indicator feed metadata content: application/json: schema: $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_metadata_response' security: - api_email: [] api_key: [] /accounts/{account_id}/intel/indicator-feeds/{feed_id}/data: get: tags: - Custom Indicator Feeds summary: Get indicator feed data operationId: custom-indicator-feeds-get-indicator-feed-data parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/custom-indicator-feeds_identifier' - name: feed_id in: path required: true schema: $ref: '#/components/schemas/custom-indicator-feeds_feed_id' responses: 4XX: description: Get indicator feeds response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common-failure' "200": description: Get indicator feed metadata content: text/csv: schema: type: string security: - api_email: [] api_key: [] /accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot: put: tags: - Custom Indicator Feeds summary: Update indicator feed data operationId: custom-indicator-feeds-update-indicator-feed-data parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/custom-indicator-feeds_identifier' - name: feed_id in: path required: true schema: $ref: '#/components/schemas/custom-indicator-feeds_feed_id' requestBody: required: true content: multipart/form-data: schema: type: object properties: source: type: string description: The file to upload example: '@/Users/me/test.stix2' responses: 4XX: description: Get indicator feeds response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common-failure' "200": description: Get indicator feed metadata content: application/json: schema: $ref: '#/components/schemas/custom-indicator-feeds_update_feed_response' security: - api_email: [] api_key: [] /accounts/{account_id}/intel/indicator-feeds/permissions/add: put: tags: - Custom Indicator Feeds summary: Grant permission to indicator feed operationId: custom-indicator-feeds-add-permission parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/custom-indicator-feeds_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/custom-indicator-feeds_permissions-request' responses: 4XX: description: Get indicator feeds response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/custom-indicator-feeds_permissions_response' - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common-failure' "200": description: Get indicator feed metadata content: application/json: schema: $ref: '#/components/schemas/custom-indicator-feeds_permissions_response' security: - api_email: [] api_key: [] /accounts/{account_id}/intel/indicator-feeds/permissions/remove: put: tags: - Custom Indicator Feeds summary: Revoke permission to indicator feed operationId: custom-indicator-feeds-remove-permission parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/custom-indicator-feeds_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/custom-indicator-feeds_permissions-request' responses: 4XX: description: Get indicator feeds response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/custom-indicator-feeds_permissions_response' - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common-failure' "200": description: Get indicator feed metadata content: application/json: schema: $ref: '#/components/schemas/custom-indicator-feeds_permissions_response' security: - api_email: [] api_key: [] /accounts/{account_id}/intel/indicator-feeds/permissions/view: get: tags: - Custom Indicator Feeds summary: List indicator feed permissions operationId: custom-indicator-feeds-view-permissions parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/custom-indicator-feeds_identifier' responses: 4XX: description: Get indicator feeds response failure 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' "200": description: Get indicator feed metadata content: application/json: schema: $ref: '#/components/schemas/custom-indicator-feeds_permission_list_item_response' security: - api_email: [] api_key: [] /accounts/{account_id}/intel/ip: get: tags: - IP Intelligence summary: Get IP Overview operationId: ip-intelligence-get-ip-overview parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel_identifier' - name: ipv4 in: query schema: type: string - name: ipv6 in: query schema: type: string responses: 4XX: description: Get IP Overview response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/intel_schemas-response' - $ref: '#/components/schemas/intel_api-response-common-failure' "200": description: Get IP Overview response content: application/json: schema: $ref: '#/components/schemas/intel_schemas-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/intel/ip-list: get: tags: - IP List summary: Get IP Lists operationId: ip-list-get-ip-lists parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel_identifier' responses: 4XX: description: Get IP Lists response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/intel_components-schemas-response' - $ref: '#/components/schemas/intel_api-response-common-failure' "200": description: Get IP Lists response content: application/json: schema: $ref: '#/components/schemas/intel_components-schemas-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/intel/miscategorization: post: tags: - Miscategorization summary: Create Miscategorization operationId: miscategorization-create-miscategorization parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/intel_miscategorization' responses: 4XX: description: Create Miscategorization response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/intel_api-response-single' - $ref: '#/components/schemas/intel_api-response-common-failure' "200": description: Create Miscategorization response content: application/json: schema: $ref: '#/components/schemas/intel_api-response-single' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/intel/sinkholes: get: tags: - Sinkhole Config summary: List sinkholes owned by this account operationId: sinkhole-config-get-sinkholes parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel-sinkholes_identifier' responses: "200": description: Successful Response content: application/json: schema: $ref: '#/components/schemas/intel-sinkholes_get_sinkholes_response' security: - api_email: [] api_key: [] /accounts/{account_id}/intel/whois: get: tags: - WHOIS Record summary: Get WHOIS Record operationId: whois-record-get-whois-record parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/intel_identifier' - name: domain in: query schema: type: string responses: 4XX: description: Get WHOIS Record response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/intel_schemas-single_response' - $ref: '#/components/schemas/intel_api-response-common-failure' "200": description: Get WHOIS Record response content: application/json: schema: $ref: '#/components/schemas/intel_schemas-single_response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/load_balancers/monitors: get: tags: - Account Load Balancer Monitors summary: List Monitors description: List configured monitors for an account. operationId: account-load-balancer-monitors-list-monitors parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' responses: 4XX: description: List Monitors response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-response-collection' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: List Monitors response content: application/json: schema: $ref: '#/components/schemas/load-balancing_monitor-response-collection' security: - api_email: [] api_key: [] api_token: [] post: tags: - Account Load Balancer Monitors summary: Create Monitor description: Create a configured monitor. operationId: account-load-balancer-monitors-create-monitor parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-editable' - required: - expected_codes responses: 4XX: description: Create Monitor response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-response-single' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Create Monitor response content: application/json: schema: $ref: '#/components/schemas/load-balancing_monitor-response-single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/load_balancers/monitors/{monitor_id}: delete: tags: - Account Load Balancer Monitors summary: Delete Monitor description: Delete a configured monitor. operationId: account-load-balancer-monitors-delete-monitor parameters: - name: monitor_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Monitor response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_id_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Delete Monitor response content: application/json: schema: $ref: '#/components/schemas/load-balancing_id_response' security: - api_email: [] api_key: [] api_token: [] get: tags: - Account Load Balancer Monitors summary: Monitor Details description: List a single configured monitor for an account. operationId: account-load-balancer-monitors-monitor-details parameters: - name: monitor_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' responses: 4XX: description: Monitor Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-response-single' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Monitor Details response content: application/json: schema: $ref: '#/components/schemas/load-balancing_monitor-response-single' security: - api_email: [] api_key: [] api_token: [] patch: tags: - Account Load Balancer Monitors summary: Patch Monitor description: Apply changes to an existing monitor, overwriting the supplied properties. operationId: account-load-balancer-monitors-patch-monitor parameters: - name: monitor_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-editable' - required: - expected_codes responses: 4XX: description: Patch Monitor response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-response-single' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Patch Monitor response content: application/json: schema: $ref: '#/components/schemas/load-balancing_monitor-response-single' security: - api_email: [] api_key: [] api_token: [] put: tags: - Account Load Balancer Monitors summary: Update Monitor description: Modify a configured monitor. operationId: account-load-balancer-monitors-update-monitor parameters: - name: monitor_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-editable' - required: - expected_codes responses: 4XX: description: Update Monitor response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-response-single' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Update Monitor response content: application/json: schema: $ref: '#/components/schemas/load-balancing_monitor-response-single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/load_balancers/monitors/{monitor_id}/preview: post: tags: - Account Load Balancer Monitors summary: Preview Monitor description: Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results. operationId: account-load-balancer-monitors-preview-monitor parameters: - name: monitor_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-editable' - required: - expected_codes responses: 4XX: description: Preview Monitor response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_preview_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Preview Monitor response content: application/json: schema: $ref: '#/components/schemas/load-balancing_preview_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/load_balancers/monitors/{monitor_id}/references: get: tags: - Account Load Balancer Monitors summary: List Monitor References description: Get the list of resources that reference the provided monitor. operationId: account-load-balancer-monitors-list-monitor-references parameters: - name: monitor_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' responses: 4XX: description: List Monitor References response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_references_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: List Monitor References response content: application/json: schema: $ref: '#/components/schemas/load-balancing_references_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/load_balancers/pools: get: tags: - Account Load Balancer Pools summary: List Pools description: List configured pools. operationId: account-load-balancer-pools-list-pools parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' - name: monitor in: query schema: description: The ID of the Monitor to use for checking the health of origins within this pool. responses: 4XX: description: List Pools response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-response_collection' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: List Pools response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-response_collection' security: - api_email: [] api_key: [] api_token: [] patch: tags: - Account Load Balancer Pools summary: Patch Pools description: Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`. operationId: account-load-balancer-pools-patch-pools parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' requestBody: required: true content: application/json: schema: properties: notification_email: $ref: '#/components/schemas/load-balancing_patch_pools_notification_email' responses: 4XX: description: Patch Pools response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-response_collection' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Patch Pools response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-response_collection' security: - api_email: [] api_key: [] api_token: [] post: tags: - Account Load Balancer Pools summary: Create Pool description: Create a new pool. operationId: account-load-balancer-pools-create-pool parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' requestBody: required: true content: application/json: schema: required: - origins - name 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' responses: 4XX: description: Create Pool response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Create Pool response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-single_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/load_balancers/pools/{pool_id}: delete: tags: - Account Load Balancer Pools summary: Delete Pool description: Delete a configured pool. operationId: account-load-balancer-pools-delete-pool parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Pool response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-id_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Delete Pool response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-id_response' security: - api_email: [] api_key: [] api_token: [] get: tags: - Account Load Balancer Pools summary: Pool Details description: Fetch a single configured pool. operationId: account-load-balancer-pools-pool-details parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' responses: 4XX: description: Pool Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Pool Details response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-single_response' security: - api_email: [] api_key: [] api_token: [] patch: tags: - Account Load Balancer Pools summary: Patch Pool description: Apply changes to an existing pool, overwriting the supplied properties. operationId: account-load-balancer-pools-patch-pool parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' requestBody: required: true 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' responses: 4XX: description: Patch Pool response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Patch Pool response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-single_response' security: - api_email: [] api_key: [] api_token: [] put: tags: - Account Load Balancer Pools summary: Update Pool description: Modify a configured pool. operationId: account-load-balancer-pools-update-pool parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' requestBody: required: true content: application/json: schema: required: - origins - name 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' responses: 4XX: description: Update Pool response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Update Pool response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-single_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/load_balancers/pools/{pool_id}/health: get: tags: - Account Load Balancer Pools summary: Pool Health Details description: Fetch the latest pool health status for a single pool. operationId: account-load-balancer-pools-pool-health-details parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' responses: 4XX: description: Pool Health Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_health_details' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Pool Health Details response content: application/json: schema: $ref: '#/components/schemas/load-balancing_health_details' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/load_balancers/pools/{pool_id}/preview: post: tags: - Account Load Balancer Pools summary: Preview Pool description: Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results. operationId: account-load-balancer-pools-preview-pool parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-editable' - required: - expected_codes responses: 4XX: description: Preview Pool response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_preview_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Preview Pool response content: application/json: schema: $ref: '#/components/schemas/load-balancing_preview_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/load_balancers/pools/{pool_id}/references: get: tags: - Account Load Balancer Pools summary: List Pool References description: Get the list of resources that reference the provided pool. operationId: account-load-balancer-pools-list-pool-references parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' responses: 4XX: description: List Pool References response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-references_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: List Pool References response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-references_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/load_balancers/preview/{preview_id}: get: tags: - Account Load Balancer Monitors summary: Preview Result description: Get the result of a previous preview operation using the provided preview_id. operationId: account-load-balancer-monitors-preview-result parameters: - name: preview_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-preview_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' responses: 4XX: description: Preview Result response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_preview_result_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Preview Result response content: application/json: schema: $ref: '#/components/schemas/load-balancing_preview_result_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/load_balancers/regions: get: tags: - Load Balancer Regions summary: List Regions description: List all region mappings. operationId: load-balancer-regions-list-regions parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' - name: subdivision_code in: query schema: $ref: '#/components/schemas/load-balancing_subdivision_code_a2' - name: subdivision_code_a2 in: query schema: $ref: '#/components/schemas/load-balancing_subdivision_code_a2' - name: country_code_a2 in: query schema: type: string description: Two-letter alpha-2 country code followed in ISO 3166-1. example: US responses: 4XX: description: List Regions response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_region_components-schemas-response_collection' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: List Regions response content: application/json: schema: $ref: '#/components/schemas/load-balancing_region_components-schemas-response_collection' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/load_balancers/regions/{region_id}: get: tags: - Load Balancer Regions summary: Get Region description: Get a single region mapping. operationId: load-balancer-regions-get-region parameters: - name: region_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_region_code' - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' responses: 4XX: description: Get Region response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_components-schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Get Region response content: application/json: schema: $ref: '#/components/schemas/load-balancing_components-schemas-single_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/load_balancers/search: get: tags: - Account Load Balancer Search summary: Search Resources description: Search for Load Balancing resources. operationId: account-load-balancer-search-search-resources parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_components-schemas-identifier' - name: search_params in: query schema: $ref: '#/components/schemas/load-balancing_search_params' - name: page in: query schema: minimum: 1 - name: per_page in: query schema: default: 25 minimum: 1 maximum: 1000 responses: 4XX: description: Search Resources response failure 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' "200": description: Search Resources response content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_api-response-collection' - $ref: '#/components/schemas/load-balancing_search_result' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/logpush/datasets/{dataset_id}/fields: get: tags: - Logpush jobs for an account summary: List fields description: Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions. operationId: get-accounts-account_identifier-logpush-datasets-dataset-fields parameters: - name: dataset_id in: path required: true schema: $ref: '#/components/schemas/logpush_dataset' - name: account_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' responses: 4XX: description: List fields response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_logpush_field_response_collection' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: List fields response content: application/json: schema: $ref: '#/components/schemas/logpush_logpush_field_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/logpush/datasets/{dataset_id}/jobs: get: tags: - Logpush jobs for an account summary: List Logpush jobs for a dataset description: Lists Logpush jobs for an account for a dataset. operationId: get-accounts-account_identifier-logpush-datasets-dataset-jobs parameters: - name: dataset_id in: path required: true schema: $ref: '#/components/schemas/logpush_dataset' - name: account_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' responses: 4XX: description: List Logpush jobs for a dataset response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_logpush_job_response_collection' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: List Logpush jobs for a dataset response content: application/json: schema: $ref: '#/components/schemas/logpush_logpush_job_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/logpush/jobs: get: tags: - Logpush jobs for an account summary: List Logpush jobs description: Lists Logpush jobs for an account. operationId: get-accounts-account_identifier-logpush-jobs parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' responses: 4XX: description: List Logpush jobs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_logpush_job_response_collection' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: List Logpush jobs response content: application/json: schema: $ref: '#/components/schemas/logpush_logpush_job_response_collection' security: - api_email: [] api_key: [] post: tags: - Logpush jobs for an account summary: Create Logpush job description: Creates a new Logpush job for an account. operationId: post-accounts-account_identifier-logpush-jobs parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: required: - destination_conf properties: dataset: $ref: '#/components/schemas/logpush_dataset' destination_conf: $ref: '#/components/schemas/logpush_destination_conf' enabled: $ref: '#/components/schemas/logpush_enabled' frequency: $ref: '#/components/schemas/logpush_frequency' logpull_options: $ref: '#/components/schemas/logpush_logpull_options' name: $ref: '#/components/schemas/logpush_name' output_options: $ref: '#/components/schemas/logpush_output_options' ownership_challenge: $ref: '#/components/schemas/logpush_ownership_challenge' responses: 4XX: description: Create Logpush job response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_logpush_job_response_single' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Create Logpush job response content: application/json: schema: $ref: '#/components/schemas/logpush_logpush_job_response_single' security: - api_email: [] api_key: [] /accounts/{account_id}/logpush/jobs/{job_id}: delete: tags: - Logpush jobs for an account summary: Delete Logpush job description: Deletes a Logpush job. operationId: delete-accounts-account_identifier-logpush-jobs-job_identifier parameters: - name: job_id in: path required: true schema: $ref: '#/components/schemas/logpush_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Logpush job response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/logpush_api-response-common' - properties: result: type: object example: {} nullable: true - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Delete Logpush job response content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_api-response-common' - properties: result: type: object example: {} nullable: true security: - api_email: [] api_key: [] get: tags: - Logpush jobs for an account summary: Get Logpush job details description: Gets the details of a Logpush job. operationId: get-accounts-account_identifier-logpush-jobs-job_identifier parameters: - name: job_id in: path required: true schema: $ref: '#/components/schemas/logpush_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' responses: 4XX: description: Get Logpush job details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_logpush_job_response_single' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Get Logpush job details response content: application/json: schema: $ref: '#/components/schemas/logpush_logpush_job_response_single' security: - api_email: [] api_key: [] put: tags: - Logpush jobs for an account summary: Update Logpush job description: Updates a Logpush job. operationId: put-accounts-account_identifier-logpush-jobs-job_identifier parameters: - name: job_id in: path required: true schema: $ref: '#/components/schemas/logpush_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: properties: destination_conf: $ref: '#/components/schemas/logpush_destination_conf' enabled: $ref: '#/components/schemas/logpush_enabled' frequency: $ref: '#/components/schemas/logpush_frequency' logpull_options: $ref: '#/components/schemas/logpush_logpull_options' output_options: $ref: '#/components/schemas/logpush_output_options' ownership_challenge: $ref: '#/components/schemas/logpush_ownership_challenge' responses: 4XX: description: Update Logpush job response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_logpush_job_response_single' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Update Logpush job response content: application/json: schema: $ref: '#/components/schemas/logpush_logpush_job_response_single' security: - api_email: [] api_key: [] /accounts/{account_id}/logpush/ownership: post: tags: - Logpush jobs for an account summary: Get ownership challenge description: Gets a new ownership challenge sent to your destination. operationId: post-accounts-account_identifier-logpush-ownership parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: required: - destination_conf properties: destination_conf: $ref: '#/components/schemas/logpush_destination_conf' responses: 4XX: description: Get ownership challenge response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_get_ownership_response' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Get ownership challenge response content: application/json: schema: $ref: '#/components/schemas/logpush_get_ownership_response' security: - api_email: [] api_key: [] /accounts/{account_id}/logpush/ownership/validate: post: tags: - Logpush jobs for an account summary: Validate ownership challenge description: Validates ownership challenge of the destination. operationId: post-accounts-account_identifier-logpush-ownership-validate parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: required: - destination_conf - ownership_challenge properties: destination_conf: $ref: '#/components/schemas/logpush_destination_conf' ownership_challenge: $ref: '#/components/schemas/logpush_ownership_challenge' responses: 4XX: description: Validate ownership challenge response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_validate_ownership_response' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Validate ownership challenge response content: application/json: schema: $ref: '#/components/schemas/logpush_validate_ownership_response' security: - api_email: [] api_key: [] /accounts/{account_id}/logpush/validate/destination/exists: post: tags: - Logpush jobs for an account summary: Check destination exists description: Checks if there is an existing job with a destination. operationId: delete-accounts-account_identifier-logpush-validate-destination-exists parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: required: - destination_conf properties: destination_conf: $ref: '#/components/schemas/logpush_destination_conf' responses: 4XX: description: Check destination exists response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_destination_exists_response' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Check destination exists response content: application/json: schema: $ref: '#/components/schemas/logpush_destination_exists_response' security: - api_email: [] api_key: [] /accounts/{account_id}/logpush/validate/origin: post: tags: - Logpush jobs for an account summary: Validate origin description: Validates logpull origin with logpull_options. operationId: post-accounts-account_identifier-logpush-validate-origin parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: required: - logpull_options properties: logpull_options: $ref: '#/components/schemas/logpush_logpull_options' responses: 4XX: description: Validate origin response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_validate_response' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Validate origin response content: application/json: schema: $ref: '#/components/schemas/logpush_validate_response' security: - api_email: [] api_key: [] /accounts/{account_id}/logs/control/cmb/config: delete: tags: - Logcontrol CMB config for an account summary: Delete CMB config description: Deletes CMB config. operationId: delete-accounts-account_identifier-logs-control-cmb-config parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/logcontrol_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete CMB config response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/logcontrol_api-response-common' - properties: result: type: object example: {} nullable: true - $ref: '#/components/schemas/logcontrol_api-response-common-failure' "200": description: Delete CMB config response content: application/json: schema: allOf: - $ref: '#/components/schemas/logcontrol_api-response-common' - properties: result: type: object example: {} nullable: true security: - api_email: [] api_key: [] get: tags: - Logcontrol CMB config for an account summary: Get CMB config description: Gets CMB config. operationId: get-accounts-account_identifier-logs-control-cmb-config parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/logcontrol_identifier' responses: 4XX: description: Get CMB config response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logcontrol_api-response-common-failure' "200": description: Get CMB config response content: application/json: schema: $ref: '#/components/schemas/logcontrol_cmb_config_response_single' security: - api_email: [] api_key: [] post: tags: - Logcontrol CMB config for an account summary: Update CMB config description: Updates CMB config. operationId: put-accounts-account_identifier-logs-control-cmb-config parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/logcontrol_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/logcontrol_cmb_config' responses: 4XX: description: Update CMB config response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logcontrol_api-response-common-failure' "200": description: Update CMB config response content: application/json: schema: $ref: '#/components/schemas/logcontrol_cmb_config_response_single' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/cf_interconnects: get: tags: - Magic Interconnects summary: List interconnects description: Lists interconnects associated with an account. operationId: magic-interconnects-list-interconnects parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4xx: description: List interconnects response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_components-schemas-tunnels_collection_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: List interconnects response content: application/json: schema: $ref: '#/components/schemas/magic_components-schemas-tunnels_collection_response' security: - api_email: [] api_key: [] put: tags: - Magic Interconnects summary: Update multiple interconnects description: Updates multiple interconnects associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. operationId: magic-interconnects-update-multiple-interconnects parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: required: - id responses: 4xx: description: Update multiple interconnects response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_components-schemas-modified_tunnels_collection_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Update multiple interconnects response content: application/json: schema: $ref: '#/components/schemas/magic_components-schemas-modified_tunnels_collection_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/cf_interconnects/{tunnel_identifier}: get: tags: - Magic Interconnects summary: List interconnect Details description: Lists details for a specific interconnect. operationId: magic-interconnects-list-interconnect-details parameters: - name: tunnel_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4xx: description: List interconnect Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_components-schemas-tunnel_single_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: List interconnect Details response content: application/json: schema: $ref: '#/components/schemas/magic_components-schemas-tunnel_single_response' security: - api_email: [] api_key: [] put: tags: - Magic Interconnects summary: Update interconnect description: Updates a specific interconnect associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. operationId: magic-interconnects-update-interconnect parameters: - name: tunnel_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_components-schemas-tunnel_update_request' responses: 4xx: description: Update interconnect response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_components-schemas-tunnel_modified_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Update interconnect response content: application/json: schema: $ref: '#/components/schemas/magic_components-schemas-tunnel_modified_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/gre_tunnels: get: tags: - Magic GRE tunnels summary: List GRE tunnels description: Lists GRE tunnels associated with an account. operationId: magic-gre-tunnels-list-gre-tunnels parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: List GRE tunnels response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_tunnels_collection_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: List GRE tunnels response content: application/json: schema: $ref: '#/components/schemas/magic_tunnels_collection_response' security: - api_email: [] api_key: [] post: tags: - Magic GRE tunnels summary: Create GRE tunnels description: Creates new GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. operationId: magic-gre-tunnels-create-gre-tunnels parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: required: - name - customer_gre_endpoint - cloudflare_gre_endpoint - interface_address responses: 4XX: description: Create GRE tunnels response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_tunnels_collection_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Create GRE tunnels response content: application/json: schema: $ref: '#/components/schemas/magic_tunnels_collection_response' security: - api_email: [] api_key: [] put: tags: - Magic GRE tunnels summary: Update multiple GRE tunnels description: Updates multiple GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. operationId: magic-gre-tunnels-update-multiple-gre-tunnels parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: required: - id responses: 4XX: description: Update multiple GRE tunnels response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_modified_tunnels_collection_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Update multiple GRE tunnels response content: application/json: schema: $ref: '#/components/schemas/magic_modified_tunnels_collection_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/gre_tunnels/{tunnel_identifier}: delete: tags: - Magic GRE tunnels summary: Delete GRE Tunnel description: Disables and removes a specific static GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. operationId: magic-gre-tunnels-delete-gre-tunnel parameters: - name: tunnel_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete GRE Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_tunnel_deleted_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Delete GRE Tunnel response content: application/json: schema: $ref: '#/components/schemas/magic_tunnel_deleted_response' security: - api_email: [] api_key: [] get: tags: - Magic GRE tunnels summary: List GRE Tunnel Details description: Lists informtion for a specific GRE tunnel. operationId: magic-gre-tunnels-list-gre-tunnel-details parameters: - name: tunnel_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: List GRE Tunnel Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_tunnel_single_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: List GRE Tunnel Details response content: application/json: schema: $ref: '#/components/schemas/magic_tunnel_single_response' security: - api_email: [] api_key: [] put: tags: - Magic GRE tunnels summary: Update GRE Tunnel description: Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. operationId: magic-gre-tunnels-update-gre-tunnel parameters: - name: tunnel_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_tunnel_update_request' responses: 4XX: description: Update GRE Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_tunnel_modified_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Update GRE Tunnel response content: application/json: schema: $ref: '#/components/schemas/magic_tunnel_modified_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/ipsec_tunnels: get: tags: - Magic IPsec tunnels summary: List IPsec tunnels description: Lists IPsec tunnels associated with an account. operationId: magic-ipsec-tunnels-list-ipsec-tunnels parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: List IPsec tunnels response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_schemas-tunnels_collection_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: List IPsec tunnels response content: application/json: schema: $ref: '#/components/schemas/magic_schemas-tunnels_collection_response' security: - api_email: [] api_key: [] post: tags: - Magic IPsec tunnels summary: Create IPsec tunnels description: Creates new IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. operationId: magic-ipsec-tunnels-create-ipsec-tunnels parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_schemas-tunnel_add_request' responses: 4XX: description: Create IPsec tunnels response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_schemas-tunnels_collection_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Create IPsec tunnels response content: application/json: schema: $ref: '#/components/schemas/magic_schemas-tunnels_collection_response' security: - api_email: [] api_key: [] put: tags: - Magic IPsec tunnels summary: Update multiple IPsec tunnels description: Update multiple IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. operationId: magic-ipsec-tunnels-update-multiple-ipsec-tunnels parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: required: - id responses: 4XX: description: Update multiple IPsec tunnels response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_schemas-modified_tunnels_collection_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Update multiple IPsec tunnels response content: application/json: schema: $ref: '#/components/schemas/magic_schemas-modified_tunnels_collection_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/ipsec_tunnels/{tunnel_identifier}: delete: tags: - Magic IPsec tunnels summary: Delete IPsec Tunnel description: Disables and removes a specific static IPsec Tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. operationId: magic-ipsec-tunnels-delete-ipsec-tunnel parameters: - name: tunnel_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete IPsec Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_schemas-tunnel_deleted_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Delete IPsec Tunnel response content: application/json: schema: $ref: '#/components/schemas/magic_schemas-tunnel_deleted_response' security: - api_email: [] api_key: [] get: tags: - Magic IPsec tunnels summary: List IPsec tunnel details description: Lists details for a specific IPsec tunnel. operationId: magic-ipsec-tunnels-list-ipsec-tunnel-details parameters: - name: tunnel_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: List IPsec tunnel details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_schemas-tunnel_single_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: List IPsec tunnel details response content: application/json: schema: $ref: '#/components/schemas/magic_schemas-tunnel_single_response' security: - api_email: [] api_key: [] put: tags: - Magic IPsec tunnels summary: Update IPsec Tunnel description: Updates a specific IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. operationId: magic-ipsec-tunnels-update-ipsec-tunnel parameters: - name: tunnel_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_schemas-tunnel_update_request' responses: 4XX: description: Update IPsec Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_schemas-tunnel_modified_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Update IPsec Tunnel response content: application/json: schema: $ref: '#/components/schemas/magic_schemas-tunnel_modified_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/ipsec_tunnels/{tunnel_identifier}/psk_generate: post: tags: - Magic IPsec tunnels summary: Generate Pre Shared Key (PSK) for IPsec tunnels description: Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved later. Note the PSK in a safe place. operationId: magic-ipsec-tunnels-generate-pre-shared-key-(-psk)-for-ipsec-tunnels parameters: - name: tunnel_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: {} responses: 4xx: description: Generate Pre Shared Key (PSK) for IPsec tunnels response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_psk_generation_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Generate Pre Shared Key (PSK) for IPsec tunnels response content: application/json: schema: $ref: '#/components/schemas/magic_psk_generation_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/routes: delete: tags: - Magic Static Routes summary: Delete Many Routes description: Delete multiple Magic static routes. operationId: magic-static-routes-delete-many-routes parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_route_delete_many_request' responses: 4XX: description: Delete Many Routes response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_multiple_route_delete_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Delete Many Routes response content: application/json: schema: $ref: '#/components/schemas/magic_multiple_route_delete_response' security: - api_email: [] api_key: [] get: tags: - Magic Static Routes summary: List Routes description: List all Magic static routes. operationId: magic-static-routes-list-routes parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: List Routes response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_routes_collection_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: List Routes response content: application/json: schema: $ref: '#/components/schemas/magic_routes_collection_response' security: - api_email: [] api_key: [] post: tags: - Magic Static Routes summary: Create Routes description: Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. operationId: magic-static-routes-create-routes parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: required: - prefix - nexthop - priority responses: 4XX: description: Create Routes response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_routes_collection_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Create Routes response content: application/json: schema: $ref: '#/components/schemas/magic_routes_collection_response' security: - api_email: [] api_key: [] put: tags: - Magic Static Routes summary: Update Many Routes description: Update multiple Magic static routes. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided. operationId: magic-static-routes-update-many-routes parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_route_update_many_request' responses: 4XX: description: Update Many Routes response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_multiple_route_modified_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Update Many Routes response content: application/json: schema: $ref: '#/components/schemas/magic_multiple_route_modified_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/routes/{route_identifier}: delete: tags: - Magic Static Routes summary: Delete Route description: Disable and remove a specific Magic static route. operationId: magic-static-routes-delete-route parameters: - name: route_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Route response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_route_deleted_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Delete Route response content: application/json: schema: $ref: '#/components/schemas/magic_route_deleted_response' security: - api_email: [] api_key: [] get: tags: - Magic Static Routes summary: Route Details description: Get a specific Magic static route. operationId: magic-static-routes-route-details parameters: - name: route_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: Route Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_route_single_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Route Details response content: application/json: schema: $ref: '#/components/schemas/magic_route_single_response' security: - api_email: [] api_key: [] put: tags: - Magic Static Routes summary: Update Route description: Update a specific Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. operationId: magic-static-routes-update-route parameters: - name: route_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_route_update_request' responses: 4XX: description: Update Route response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic_route_modified_response' - $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Update Route response content: application/json: schema: $ref: '#/components/schemas/magic_route_modified_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/sites: get: tags: - Magic WAN Sites summary: List Sites 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-wan-sites-list-sites parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: connector_identifier in: query schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: List Sites response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: List Sites response content: application/json: schema: $ref: '#/components/schemas/magic_sites_collection_response' security: - api_email: [] api_key: [] post: tags: - Magic WAN Sites summary: Create a new Site description: Creates a new Site operationId: magic-sites-create-site parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_sites_add_single_request' responses: 4XX: description: Create Site response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Create Site response content: application/json: schema: $ref: '#/components/schemas/magic_site_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/sites/{site_id}: delete: tags: - Magic WAN Sites summary: Delete Site description: Remove a specific Site. operationId: magic-sites-delete-site parameters: - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Site response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Delete Site response content: application/json: schema: $ref: '#/components/schemas/magic_site_deleted_response' security: - api_email: [] api_key: [] get: tags: - Magic WAN Sites summary: Site Details description: Get a specific Site. operationId: magic-sites-site-details parameters: - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: Site Details response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Site Details response content: application/json: schema: $ref: '#/components/schemas/magic_site_single_response' security: - api_email: [] api_key: [] put: tags: - Magic WAN Sites summary: Update Site description: Update a specific Site. operationId: magic-sites-update-site parameters: - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_site_update_request' responses: 4XX: description: Update Site response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Update Site response content: application/json: schema: $ref: '#/components/schemas/magic_site_modified_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/sites/{site_id}/acls: get: tags: - Magic WAN Connector Site ACLs summary: List Site ACLs description: Lists Site ACLs associated with an account. operationId: magic-site-acls-list-acls parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: List Site ACLs response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: List Site ACLs response content: application/json: schema: $ref: '#/components/schemas/magic_acls_collection_response' security: - api_email: [] api_key: [] post: tags: - Magic WAN Connector Site ACLs summary: Create a new Site ACL description: Creates a new Site ACL. operationId: magic-site-acls-create-site-acl parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_acls_add_single_request' responses: 4XX: description: Create Site ACL response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Create Site ACL response content: application/json: schema: $ref: '#/components/schemas/magic_acls_collection_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/sites/{site_id}/acls/{acl_identifier}: delete: tags: - Magic WAN Connector Site ACLs summary: Delete Site ACL description: Remove a specific Site ACL. operationId: magic-site-acls-delete-acl parameters: - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: acl_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Site ACL response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Delete Site ACL response content: application/json: schema: $ref: '#/components/schemas/magic_acl_deleted_response' security: - api_email: [] api_key: [] get: tags: - Magic WAN Connector Site ACLs summary: Site ACL Details description: Get a specific Site ACL. operationId: magic-site-acls-acl-details parameters: - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: acl_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: Site ACL Details response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Site ACL Details response content: application/json: schema: $ref: '#/components/schemas/magic_acl_single_response' security: - api_email: [] api_key: [] put: tags: - Magic WAN Connector Site ACLs summary: Update Site ACL description: Update a specific Site ACL. operationId: magic-site-acls-update-acl parameters: - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: acl_identifier in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_acl_update_request' responses: 4XX: description: Update Site ACL response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Update Site ACL response content: application/json: schema: $ref: '#/components/schemas/magic_acl_modified_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/sites/{site_id}/lans: get: tags: - Magic WAN Connector LANs summary: List LANs description: Lists LANs associated with an account and site. operationId: magic-wan-connectors-lans-list-lans parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: List LANs response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: List LANs response content: application/json: schema: $ref: '#/components/schemas/magic_lans_collection_response' security: - api_email: [] api_key: [] post: tags: - Magic WAN Connector LANs summary: Create a new LAN description: Creates a new LAN. If the site is in high availability mode, static_addressing is required along with secondary and virtual address. operationId: magic-wan-connectors-lans-create-lan parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_lans_add_single_request' responses: 4XX: description: Create LAN response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Create LAN response content: application/json: schema: $ref: '#/components/schemas/magic_lans_collection_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}: delete: tags: - Magic WAN Connector LANs summary: Delete LAN description: Remove a specific LAN. operationId: magic-wan-connectors-lans-delete-lan parameters: - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: lan_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete LAN response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Delete LAN response content: application/json: schema: $ref: '#/components/schemas/magic_lan_deleted_response' security: - api_email: [] api_key: [] get: tags: - Magic WAN Connector LANs summary: LAN Details description: Get a specific LAN. operationId: magic-wan-connectors-lans-lan-details parameters: - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: lan_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: LAN Details response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: LAN Details response content: application/json: schema: $ref: '#/components/schemas/magic_lan_single_response' security: - api_email: [] api_key: [] put: tags: - Magic WAN Connector LANs summary: Update LAN description: Update a specific LAN. operationId: magic-wan-connectors-lans-update-lan parameters: - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: lan_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_lan_update_request' responses: 4XX: description: Update LAN response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Update LAN response content: application/json: schema: $ref: '#/components/schemas/magic_lan_modified_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/sites/{site_id}/wans: get: tags: - Magic WAN Connector WANs summary: List WANs description: Lists WANs associated with an account and site. operationId: magic-wan-connectors-list-wans parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: List WANs response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: List WANs response content: application/json: schema: $ref: '#/components/schemas/magic_wans_collection_response' security: - api_email: [] api_key: [] post: tags: - Magic WAN Connector WANs summary: Create a new WAN description: Creates a new WAN. operationId: magic-wan-connectors-create-wan parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_wans_add_single_request' responses: 4XX: description: Create WAN response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Create WAN response content: application/json: schema: $ref: '#/components/schemas/magic_wans_collection_response' security: - api_email: [] api_key: [] /accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}: delete: tags: - Magic WAN Connector WANs summary: Delete WAN description: Remove a specific WAN. operationId: magic-wan-connectors-delete-wan parameters: - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: wan_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete WAN response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Delete WAN response content: application/json: schema: $ref: '#/components/schemas/magic_wan_deleted_response' security: - api_email: [] api_key: [] get: tags: - Magic WAN Connector WANs summary: WAN Details description: Get a specific WAN. operationId: magic-wan-connectors-wan-details parameters: - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: wan_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' responses: 4XX: description: WAN Details response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: WAN Details response content: application/json: schema: $ref: '#/components/schemas/magic_wan_single_response' security: - api_email: [] api_key: [] put: tags: - Magic WAN Connector WANs summary: Update WAN description: Update a specific WAN. operationId: magic-wan-connectors-update-wan parameters: - name: site_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' - name: wan_id in: path required: true schema: $ref: '#/components/schemas/magic_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic_wan_update_request' responses: 4XX: description: Update WAN response failure content: application/json: schema: $ref: '#/components/schemas/magic_api-response-common-failure' "200": description: Update WAN response content: application/json: schema: $ref: '#/components/schemas/magic_wan_modified_response' security: - api_email: [] api_key: [] /accounts/{account_id}/members: get: tags: - Account Members summary: List Members description: List all members of an account. operationId: account-members-list-members parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/iam_account_identifier' - name: order in: query schema: description: Field to order results by. enum: - user.first_name - user.last_name - user.email - status example: status - name: status in: query schema: type: string description: A member's status in the account. enum: - accepted - pending - rejected example: accepted - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Maximum number of results per page. default: 20 minimum: 5 maximum: 50 - name: direction in: query schema: type: string description: Direction to order results. enum: - asc - desc example: desc responses: 4XX: description: List Members response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_collection' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: List Members response content: application/json: schema: $ref: '#/components/schemas/iam_collection_member_response' security: - api_email: [] api_key: [] post: tags: - Account Members summary: Add Member description: Add a user to the list of members for this account. operationId: account-members-add-member parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/iam_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/iam_create' responses: 4XX: description: Add Member response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_single' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Add Member response content: application/json: schema: $ref: '#/components/schemas/iam_single_member_response_with_code' security: - api_email: [] api_key: [] /accounts/{account_id}/members/{member_id}: delete: tags: - Account Members summary: Remove Member description: Remove a member from an account. operationId: account-members-remove-member parameters: - name: member_id in: path required: true schema: $ref: '#/components/schemas/iam_membership_components-schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/iam_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Remove Member response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_api-response-single-id' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Remove Member response content: application/json: schema: $ref: '#/components/schemas/iam_api-response-single-id' security: - api_email: [] api_key: [] get: tags: - Account Members summary: Member Details description: Get information about a specific member of an account. operationId: account-members-member-details parameters: - name: member_id in: path required: true schema: $ref: '#/components/schemas/iam_membership_components-schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/iam_account_identifier' responses: 4XX: description: Member Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_single' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Member Details response content: application/json: schema: $ref: '#/components/schemas/iam_single_member_response' security: - api_email: [] api_key: [] put: tags: - Account Members summary: Update Member description: Modify an account member. operationId: account-members-update-member parameters: - name: member_id in: path required: true schema: $ref: '#/components/schemas/iam_membership_components-schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/iam_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/iam_schemas-member' responses: 4XX: description: Update Member response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_single' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Update Member response content: application/json: schema: $ref: '#/components/schemas/iam_single_member_response' security: - api_email: [] api_key: [] /accounts/{account_id}/mnm/config: delete: tags: - Magic Network Monitoring Configuration summary: Delete account configuration description: Delete an existing network monitoring configuration. operationId: magic-network-monitoring-configuration-delete-account-configuration parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete account configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: Delete account configuration response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_config_single_response' security: - api_email: [] api_key: [] get: tags: - Magic Network Monitoring Configuration summary: List account configuration description: Lists default sampling and router IPs for account. operationId: magic-network-monitoring-configuration-list-account-configuration parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' responses: 4XX: description: List account configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: List account configuration response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_config_single_response' security: - api_email: [] api_key: [] patch: tags: - Magic Network Monitoring Configuration summary: Update account configuration fields description: Update fields in an existing network monitoring configuration. operationId: magic-network-monitoring-configuration-update-account-configuration-fields parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Update account configuration fields response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: Update account configuration fields response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_config_single_response' security: - api_email: [] api_key: [] post: tags: - Magic Network Monitoring Configuration summary: Create account configuration description: Create a new network monitoring configuration. operationId: magic-network-monitoring-configuration-create-account-configuration parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Create account configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: Create account configuration response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_config_single_response' security: - api_email: [] api_key: [] put: tags: - Magic Network Monitoring Configuration summary: Update an entire account configuration description: Update an existing network monitoring configuration, requires the entire configuration to be updated at once. operationId: magic-network-monitoring-configuration-update-an-entire-account-configuration parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Update an entire account configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: Update an entire account configuration response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_config_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/mnm/config/full: get: tags: - Magic Network Monitoring Configuration summary: List rules and account configuration description: Lists default sampling, router IPs, and rules for account. operationId: magic-network-monitoring-configuration-list-rules-and-account-configuration parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' responses: 4XX: description: List rules and account configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_config_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: List rules and account configuration response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_config_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/mnm/rules: get: tags: - Magic Network Monitoring Rules summary: List rules description: Lists network monitoring rules for account. operationId: magic-network-monitoring-rules-list-rules parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' responses: 4XX: description: List rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_rules_collection_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: List rules response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_rules_collection_response' security: - api_email: [] api_key: [] post: tags: - Magic Network Monitoring Rules summary: Create rules 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Create rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: Create rules response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response' security: - api_email: [] api_key: [] put: tags: - Magic Network Monitoring Rules summary: Update rules description: Update network monitoring rules for account. operationId: magic-network-monitoring-rules-update-rules parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Update rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: Update rules response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/mnm/rules/{rule_id}: delete: tags: - Magic Network Monitoring Rules summary: Delete rule description: Delete a network monitoring rule for account. operationId: magic-network-monitoring-rules-delete-rule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_rule_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: Delete rule response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response' security: - api_email: [] api_key: [] get: tags: - Magic Network Monitoring Rules summary: Get rule description: List a single network monitoring rule for account. operationId: magic-network-monitoring-rules-get-rule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_rule_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' responses: 4XX: description: Get rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: Get rule response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response' security: - api_email: [] api_key: [] patch: tags: - Magic Network Monitoring Rules summary: Update rule description: Update a network monitoring rule for account. operationId: magic-network-monitoring-rules-update-rule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_rule_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Update rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: Update rule response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/mnm/rules/{rule_id}/advertisement: patch: tags: - Magic Network Monitoring Rules summary: Update advertisement for rule description: Update advertisement for rule. operationId: magic-network-monitoring-rules-update-advertisement-for-rule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_rule_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Update advertisement for rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/magic-visibility_mnm_rule_advertisement_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' "200": description: Update advertisement for rule response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_mnm_rule_advertisement_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/mtls_certificates: get: tags: - mTLS Certificate Management summary: List mTLS certificates description: Lists all mTLS certificates. operationId: m-tls-certificate-management-list-m-tls-certificates parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: List mTLS certificates response failure 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' "200": description: List mTLS certificates response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection' security: - api_email: [] api_key: [] post: tags: - mTLS Certificate Management summary: Upload mTLS certificate description: Upload a certificate that you want to use with mTLS-enabled Cloudflare services. operationId: m-tls-certificate-management-upload-m-tls-certificate parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object required: - certificates - ca 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' responses: 4XX: description: Upload mTLS certificate response failure 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' "200": description: Upload mTLS certificate response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single_post' security: - api_email: [] api_key: [] /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}: delete: tags: - mTLS Certificate Management summary: Delete mTLS certificate 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: - name: mtls_certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete mTLS certificate response failure 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' "200": description: Delete mTLS certificate response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single' security: - api_email: [] api_key: [] get: tags: - mTLS Certificate Management summary: Get mTLS certificate description: Fetches a single mTLS certificate. operationId: m-tls-certificate-management-get-m-tls-certificate parameters: - name: mtls_certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Get mTLS certificate response failure 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' "200": description: Get mTLS certificate response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single' security: - api_email: [] api_key: [] /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}/associations: get: tags: - mTLS Certificate Management summary: List mTLS certificate associations description: Lists all active associations between the certificate and Cloudflare services. operationId: m-tls-certificate-management-list-m-tls-certificate-associations parameters: - name: mtls_certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: List mTLS certificate associations response failure 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' "200": description: List mTLS certificate associations response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_association_response_collection' security: - api_email: [] api_key: [] /accounts/{account_id}/pages/projects: get: tags: - Pages Project summary: Get projects description: Fetch a list of all user projects. operationId: pages-project-get-projects parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' responses: 4XX: description: Get projects response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_projects-response' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Get projects response. content: application/json: schema: $ref: '#/components/schemas/pages_projects-response' security: - api_email: [] api_key: [] post: tags: - Pages Project summary: Create project description: Create a new project. operationId: pages-project-create-project parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/pages_projects' responses: 4XX: description: Create project response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_new-project-response' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Create project response. content: application/json: schema: $ref: '#/components/schemas/pages_new-project-response' security: - api_email: [] api_key: [] /accounts/{account_id}/pages/projects/{project_name}: delete: tags: - Pages Project summary: Delete project description: Delete a project by name. operationId: pages-project-delete-project parameters: - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete project response failure. content: application/json: schema: allOf: - example: errors: [] messages: [] result: null success: true - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Delete project response. content: application/json: schema: example: errors: [] messages: [] result: null success: true security: - api_email: [] api_key: [] get: tags: - Pages Project summary: Get project description: Fetch a project by name. operationId: pages-project-get-project parameters: - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' responses: 4XX: description: Get project response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_project-response' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Get project response. content: application/json: schema: $ref: '#/components/schemas/pages_project-response' security: - api_email: [] api_key: [] patch: tags: - Pages Project summary: Update project description: Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null. operationId: pages-project-update-project parameters: - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/pages_project-patch' responses: 4XX: description: Update project response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_new-project-response' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Update project response. content: application/json: schema: $ref: '#/components/schemas/pages_new-project-response' security: - api_email: [] api_key: [] /accounts/{account_id}/pages/projects/{project_name}/deployments: get: tags: - Pages Deployment summary: Get deployments description: Fetch a list of project deployments. operationId: pages-deployment-get-deployments parameters: - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' - name: env in: query schema: type: string description: What type of deployments to fetch. enum: - production - preview example: preview responses: 4XX: description: Get deployments response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_deployment-list-response' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Get deployments response. content: application/json: schema: $ref: '#/components/schemas/pages_deployment-list-response' security: - api_email: [] api_key: [] post: tags: - Pages Deployment summary: Create deployment 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: - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' requestBody: required: true content: multipart/form-data: schema: type: object properties: branch: type: string 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 responses: 4XX: description: Create deployment response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_deployment-new-deployment' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Create deployment response. content: application/json: schema: $ref: '#/components/schemas/pages_deployment-new-deployment' security: - api_email: [] api_key: [] /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}: delete: tags: - Pages Deployment summary: Delete deployment description: Delete a deployment. operationId: pages-deployment-delete-deployment parameters: - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete deployment response failure. content: application/json: schema: allOf: - example: errors: [] messages: [] result: null success: true - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Delete deployment response. content: application/json: schema: example: errors: [] messages: [] result: null success: true security: - api_email: [] api_key: [] get: tags: - Pages Deployment summary: Get deployment info description: Fetch information about a deployment. operationId: pages-deployment-get-deployment-info parameters: - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' responses: 4XX: description: Get deployment info response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_deployment-response-details' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Get deployment info response. content: application/json: schema: $ref: '#/components/schemas/pages_deployment-response-details' security: - api_email: [] api_key: [] /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/history/logs: get: tags: - Pages Deployment summary: Get deployment logs description: Fetch deployment logs for a project. operationId: pages-deployment-get-deployment-logs parameters: - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' responses: 4XX: description: Get deployment logs response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_deployment-response-logs' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Get deployment logs response. content: application/json: schema: $ref: '#/components/schemas/pages_deployment-response-logs' security: - api_email: [] api_key: [] /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/retry: post: tags: - Pages Deployment summary: Retry deployment description: Retry a previous deployment. operationId: pages-deployment-retry-deployment parameters: - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Retry deployment response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_deployment-new-deployment' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Retry deployment response. content: application/json: schema: $ref: '#/components/schemas/pages_deployment-new-deployment' security: - api_email: [] api_key: [] /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/rollback: post: tags: - Pages Deployment summary: Rollback deployment description: Rollback the production deployment to a previous deployment. You can only rollback to succesful builds on production. operationId: pages-deployment-rollback-deployment parameters: - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Rollback deployment response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_deployment-response-details' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Rollback deployment response. content: application/json: schema: $ref: '#/components/schemas/pages_deployment-response-details' security: - api_email: [] api_key: [] /accounts/{account_id}/pages/projects/{project_name}/domains: get: tags: - Pages Domains summary: Get domains description: Fetch a list of all domains associated with a Pages project. operationId: pages-domains-get-domains parameters: - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' responses: 4XX: description: Get domains response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_domain-response-collection' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Get domains response. content: application/json: schema: $ref: '#/components/schemas/pages_domain-response-collection' security: - api_email: [] api_key: [] post: tags: - Pages Domains summary: Add domain description: Add a new domain for the Pages project. operationId: pages-domains-add-domain parameters: - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/pages_domains-post' responses: 4XX: description: Add domain response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_domain-response-single' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Add domain response. content: application/json: schema: $ref: '#/components/schemas/pages_domain-response-single' security: - api_email: [] api_key: [] /accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}: delete: tags: - Pages Domains summary: Delete domain description: Delete a Pages project's domain. operationId: pages-domains-delete-domain parameters: - name: domain_name in: path required: true schema: $ref: '#/components/schemas/pages_domain_name' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' requestBody: required: true content: application/json: {} responses: 4xx: description: Delete domain response failure. content: application/json: schema: allOf: - example: errors: [] messages: [] result: null success: true - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Delete domain response. content: application/json: schema: example: errors: [] messages: [] result: null success: true security: - api_email: [] api_key: [] get: tags: - Pages Domains summary: Get domain description: Fetch a single domain. operationId: pages-domains-get-domain parameters: - name: domain_name in: path required: true schema: $ref: '#/components/schemas/pages_domain_name' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' responses: 4XX: description: Get domain response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_domain-response-single' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Get domain response. content: application/json: schema: $ref: '#/components/schemas/pages_domain-response-single' security: - api_email: [] api_key: [] patch: tags: - Pages Domains summary: Patch domain description: Retry the validation status of a single domain. operationId: pages-domains-patch-domain parameters: - name: domain_name in: path required: true schema: $ref: '#/components/schemas/pages_domain_name' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Patch domain response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_domain-response-single' - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Patch domain response. content: application/json: schema: $ref: '#/components/schemas/pages_domain-response-single' security: - api_email: [] api_key: [] /accounts/{account_id}/pages/projects/{project_name}/purge_build_cache: post: tags: - Pages Build Cache summary: Purge build cache description: Purge all cached build artifacts for a Pages project operationId: pages-purge-build-cache parameters: - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' responses: 4XX: description: Purge build cache failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_api-response-common-failure' "200": description: Purge build cache response. content: application/json: schema: example: errors: [] messages: [] result: null success: true security: - api_email: [] api_key: [] /accounts/{account_id}/pcaps: get: tags: - Magic PCAP collection summary: List packet capture requests description: Lists all packet capture requests for an account. operationId: magic-pcap-collection-list-packet-capture-requests parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_identifier' responses: "200": description: List packet capture requests response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_pcaps_collection_response' default: description: List packet capture requests response failure content: application/json: schema: oneOf: - $ref: '#/components/schemas/magic-visibility_pcaps_collection_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' security: - api_email: [] api_key: [] post: tags: - Magic PCAP collection summary: Create PCAP request description: Create new PCAP request for account. operationId: magic-pcap-collection-create-pcap-request parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic-visibility_pcaps_request_pcap' responses: "200": description: Create PCAP request response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_pcaps_single_response' default: description: Create PCAP request response failure content: application/json: schema: oneOf: - $ref: '#/components/schemas/magic-visibility_pcaps_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' security: - api_email: [] api_key: [] /accounts/{account_id}/pcaps/{pcap_id}: get: tags: - Magic PCAP collection summary: Get PCAP request description: Get information for a PCAP request by id. operationId: magic-pcap-collection-get-pcap-request parameters: - name: pcap_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_identifier' responses: "200": description: Get PCAP request response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_pcaps_single_response' default: description: Get PCAP request response failure content: application/json: schema: oneOf: - $ref: '#/components/schemas/magic-visibility_pcaps_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' security: - api_email: [] api_key: [] /accounts/{account_id}/pcaps/{pcap_id}/download: get: tags: - Magic PCAP collection summary: Download Simple PCAP description: Download PCAP information into a file. Response is a binary PCAP file. operationId: magic-pcap-collection-download-simple-pcap parameters: - name: pcap_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_identifier' responses: "200": description: Download Simple PCAP response content: application/vnd.tcpdump.pcap: {} default: description: Download Simple PCAP response failure content: application/json: {} security: - api_email: [] api_key: [] /accounts/{account_id}/pcaps/ownership: get: tags: - Magic PCAP collection summary: List PCAPs Bucket Ownership description: List all buckets configured for use with PCAPs API. operationId: magic-pcap-collection-list-pca-ps-bucket-ownership parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_identifier' responses: "200": description: List PCAPs Bucket Ownership response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_pcaps_ownership_collection' default: description: List PCAPs Bucket Ownership response failure content: application/json: schema: oneOf: - $ref: '#/components/schemas/magic-visibility_pcaps_ownership_collection' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' security: - api_email: [] api_key: [] post: tags: - Magic PCAP collection summary: Add buckets for full packet captures description: Adds an AWS or GCP bucket to use with full packet captures. operationId: magic-pcap-collection-add-buckets-for-full-packet-captures parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic-visibility_pcaps_ownership_request' responses: "200": description: Add buckets for full packet captures response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_pcaps_ownership_single_response' default: description: Add buckets for full packet captures response failure content: application/json: schema: oneOf: - $ref: '#/components/schemas/magic-visibility_pcaps_ownership_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' security: - api_email: [] api_key: [] /accounts/{account_id}/pcaps/ownership/{ownership_id}: delete: tags: - Magic PCAP collection summary: Delete buckets for full packet captures description: Deletes buckets added to the packet captures API. operationId: magic-pcap-collection-delete-buckets-for-full-packet-captures parameters: - name: ownership_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_identifier' responses: "204": description: Delete buckets for full packet captures response default: description: Delete buckets for full packet captures response failure content: application/json: {} security: - api_email: [] api_key: [] /accounts/{account_id}/pcaps/ownership/validate: post: tags: - Magic PCAP collection summary: Validate buckets for full packet captures description: Validates buckets added to the packet captures API. operationId: magic-pcap-collection-validate-buckets-for-full-packet-captures parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/magic-visibility_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/magic-visibility_pcaps_ownership_validate_request' responses: "200": description: Validate buckets for full packet captures response content: application/json: schema: $ref: '#/components/schemas/magic-visibility_pcaps_ownership_single_response' default: description: Validate buckets for full packet captures response failure content: application/json: schema: oneOf: - $ref: '#/components/schemas/magic-visibility_pcaps_ownership_single_response' - $ref: '#/components/schemas/magic-visibility_api-response-common-failure' security: - api_email: [] api_key: [] /accounts/{account_id}/queues: get: tags: - Queue summary: List Queues description: Returns the queues owned by an account. operationId: queue-v2-list-queues parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' responses: 4XX: description: List Queues response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/mq_api-response-collection' - properties: errors: {} - properties: messages: {} - properties: result_info: type: object properties: count: example: 1 page: example: 1 per_page: example: 100 total_count: example: 1 total_pages: example: 1 - type: object required: - queue_id - queue_name - created_on - modified_on - producers_total_count - producers - consumers_total_count - consumers properties: result: type: array items: $ref: '#/components/schemas/mq_queue' - $ref: '#/components/schemas/mq_api-response-common-failure' "200": description: List Queues response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-collection' - properties: errors: {} - properties: messages: {} - properties: result_info: type: object properties: count: example: 1 page: example: 1 per_page: example: 100 total_count: example: 1 total_pages: example: 1 - type: object required: - queue_id - queue_name - created_on - modified_on - producers_total_count - producers - consumers_total_count - consumers properties: result: type: array items: $ref: '#/components/schemas/mq_queue' security: - api_email: [] api_key: [] api_token: [] post: tags: - Queue summary: Create Queue description: Creates a new queue. operationId: queue-v2-create-queue parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' requestBody: required: true content: application/json: schema: example: queue_name: example-queue responses: 4XX: description: Create Queue response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/mq_api-response-collection' - type: object required: - queue_id - queue_name - created_on - modified_on properties: result: allOf: - $ref: '#/components/schemas/mq_queue_created' type: object - $ref: '#/components/schemas/mq_api-response-common-failure' "200": description: Create Queue response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-collection' - type: object required: - queue_id - queue_name - created_on - modified_on properties: result: allOf: - $ref: '#/components/schemas/mq_queue_created' type: object security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/queues/{queue_id}: delete: tags: - Queue summary: Delete Queue description: Deletes a queue. operationId: queue-v2-delete-queue parameters: - name: queue_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Queue response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/mq_api-response-collection' - properties: result: {} - $ref: '#/components/schemas/mq_api-response-common-failure' "200": description: Delete Queue response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-collection' - properties: result: {} security: - api_email: [] api_key: [] api_token: [] get: tags: - Queue summary: Queue Details description: Get information about a specific queue. operationId: queue-v2-queue-details parameters: - name: queue_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' responses: 4XX: description: Queue Details response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/mq_api-response-collection' - type: object required: - queue_id - queue_name - created_on - modified_on properties: result: allOf: - $ref: '#/components/schemas/mq_queue' type: object - $ref: '#/components/schemas/mq_api-response-common-failure' "200": description: Queue Details response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-collection' - type: object required: - queue_id - queue_name - created_on - modified_on properties: result: allOf: - $ref: '#/components/schemas/mq_queue' type: object security: - api_email: [] api_key: [] api_token: [] put: tags: - Queue summary: Update Queue description: Updates a queue. operationId: queue-v2-update-queue parameters: - name: queue_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' requestBody: required: true content: application/json: schema: example: queue_name: renamed-example-queue responses: 4XX: description: Update Queue response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/mq_api-response-collection' - type: object required: - queue_id - queue_name - created_on - modified_on properties: result: allOf: - $ref: '#/components/schemas/mq_queue_updated' type: object - $ref: '#/components/schemas/mq_api-response-common-failure' "200": description: Update Queue response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-collection' - type: object required: - queue_id - queue_name - created_on - modified_on properties: result: allOf: - $ref: '#/components/schemas/mq_queue_updated' type: object security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/queues/{queue_id}/consumers: get: tags: - Queue summary: List Queue Consumers description: Returns the consumers for a queue. operationId: queue-v2-list-queue-consumers parameters: - name: queue_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' responses: 4XX: description: List Queue Consumers response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/mq_api-response-collection' - properties: errors: {} - properties: messages: {} - properties: result_info: type: object properties: count: example: 1 page: example: 1 per_page: example: 100 total_count: example: 1 total_pages: example: 1 - type: object required: - queue_name - created_on - settings properties: result: type: array items: $ref: '#/components/schemas/mq_consumer' - $ref: '#/components/schemas/mq_api-response-common-failure' "200": description: List Queue Consumers response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-collection' - properties: errors: {} - properties: messages: {} - properties: result_info: type: object properties: count: example: 1 page: example: 1 per_page: example: 100 total_count: example: 1 total_pages: example: 1 - type: object required: - queue_name - created_on - settings properties: result: type: array items: $ref: '#/components/schemas/mq_consumer' security: - api_email: [] api_key: [] api_token: [] post: tags: - Queue summary: Create Queue Consumer description: Creates a new consumer for a queue. operationId: queue-v2-create-queue-consumer parameters: - name: queue_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' requestBody: required: true content: application/json: schema: example: dead_letter_queue: example-dlq environment: production script_name: example-consumer settings: batch_size: 10 max_retries: 3 max_wait_time_ms: 5000 responses: 4XX: description: Create Queue Consumer response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/mq_api-response-collection' - type: object required: - queue_name - script_name - settings - dead_letter_queue - created_on properties: result: allOf: - $ref: '#/components/schemas/mq_consumer_created' type: object - $ref: '#/components/schemas/mq_api-response-common-failure' "200": description: Create Queue Consumer response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-collection' - type: object required: - queue_name - script_name - settings - dead_letter_queue - created_on properties: result: allOf: - $ref: '#/components/schemas/mq_consumer_created' type: object security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}: delete: tags: - Queue summary: Delete Queue Consumer description: Deletes the consumer for a queue. operationId: queue-v2-delete-queue-consumer parameters: - name: consumer_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: queue_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Queue Consumer response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/mq_api-response-collection' - properties: result: {} - $ref: '#/components/schemas/mq_api-response-common-failure' "200": description: Delete Queue Consumer response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-collection' - properties: result: {} security: - api_email: [] api_key: [] api_token: [] put: tags: - Queue summary: Update Queue Consumer description: Updates the consumer for a queue, or creates one if it does not exist. operationId: queue-v2-update-queue-consumer parameters: - name: consumer_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: queue_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' requestBody: required: true content: application/json: schema: example: dead_letter_queue: updated-example-dlq environment: production script_name: example-consumer settings: batch_size: 100 responses: 4XX: description: Update Queue Consumer response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/mq_api-response-collection' - type: object required: - queue_name - script_name - settings - dead_letter_queue - created_on properties: result: allOf: - $ref: '#/components/schemas/mq_consumer_updated' type: object - $ref: '#/components/schemas/mq_api-response-common-failure' "200": description: Update Queue Consumer response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-collection' - type: object required: - queue_name - script_name - settings - dead_letter_queue - created_on properties: result: allOf: - $ref: '#/components/schemas/mq_consumer_updated' type: object security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/queues/{queue_id}/messages/ack: post: tags: - Queue summary: Acknowledge + Retry Queue Messages description: Acknowledge + Retry messages from a Queue. operationId: queue-v2-messages-ack parameters: - name: queue_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' requestBody: required: true content: application/json: schema: type: object properties: acks: type: array items: type: object properties: lease_id: type: string description: Lease ID for a message to acknowledge. example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0 retries: type: array items: type: object properties: delay_seconds: type: number description: The number of seconds to delay before making the message available for another attempt. example: 10 lease_id: type: string description: Lease ID for a message to retry. example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0 responses: 4XX: description: Acknoweldge Queue Messages response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/mq_api-response-collection' - properties: result: {} - $ref: '#/components/schemas/mq_api-response-common-failure' "200": description: Acknoweldge Queue Messages response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-collection' - properties: result: type: object properties: ackCount: type: number description: The number of messages that were succesfully acknowledged example: 5 retryCount: type: number description: The number of messages that were succesfully retried example: 5 warnings: type: array items: type: string security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/queues/{queue_id}/messages/pull: post: tags: - Queue summary: Pull Queue Messages description: Pull a batch of messages from a Queue. operationId: queue-v2-messages-pull parameters: - name: queue_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/mq_identifier' requestBody: required: true content: application/json: schema: type: object properties: batch_size: $ref: '#/components/schemas/mq_batch_size' visibility_timeout_ms: $ref: '#/components/schemas/mq_visibility_timeout_ms' responses: 4XX: description: Pull Queue Messages response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/mq_api-response-collection' - properties: result: {} - $ref: '#/components/schemas/mq_api-response-common-failure' "200": description: Pull Queue Messages response content: application/json: schema: allOf: - $ref: '#/components/schemas/mq_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/mq_queue_message' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/r2/buckets: get: tags: - R2 Bucket summary: List Buckets description: Lists all R2 buckets on your account operationId: r2-list-buckets parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/r2_account_identifier' - name: name_contains in: query schema: type: string description: Bucket names to filter by. Only buckets with this phrase in their name will be returned. example: my-bucket - name: start_after in: query schema: type: string description: Bucket name to start searching after. Buckets are ordered lexicographically. example: my-bucket - name: per_page in: query schema: type: number description: Maximum number of buckets to return in a single call default: 20 minimum: 1 maximum: 1000 - name: order in: query schema: type: string description: Field to order buckets by enum: - name - name: direction in: query schema: type: string description: Direction to order buckets enum: - asc - desc example: desc - name: cursor in: query schema: type: string description: Pagination cursor received during the last List Buckets call. R2 buckets are paginated using cursors instead of page numbers. responses: 4XX: description: List Buckets response failure content: application/json: schema: $ref: '#/components/schemas/r2_v4_response_failure' "200": description: List Buckets response content: application/json: schema: allOf: - $ref: '#/components/schemas/r2_v4_response_list' - type: object properties: result: type: array items: $ref: '#/components/schemas/r2_bucket' security: - api_token: [] post: tags: - R2 Bucket summary: Create Bucket description: Creates a new R2 bucket. operationId: r2-create-bucket parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/r2_account_identifier' requestBody: required: true content: application/json: schema: type: object example: '{"name": "example-bucket"}' required: - name properties: locationHint: $ref: '#/components/schemas/r2_bucket_location' name: $ref: '#/components/schemas/r2_bucket_name' responses: 4XX: description: Create Bucket response failure content: application/json: schema: $ref: '#/components/schemas/r2_v4_response_failure' "200": description: Create Bucket response content: application/json: schema: allOf: - $ref: '#/components/schemas/r2_v4_response' - type: object properties: result: $ref: '#/components/schemas/r2_bucket' security: - api_token: [] /accounts/{account_id}/r2/buckets/{bucket_name}: delete: tags: - R2 Bucket summary: Delete Bucket description: Deletes an existing R2 bucket. operationId: r2-delete-bucket parameters: - name: bucket_name in: path required: true schema: $ref: '#/components/schemas/r2_bucket_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/r2_account_identifier' responses: 4XX: description: Delete Bucket response failure content: application/json: schema: $ref: '#/components/schemas/r2_v4_response_failure' "200": description: Delete Bucket response content: application/json: schema: $ref: '#/components/schemas/r2_v4_response' security: - api_token: [] get: tags: - R2 Bucket summary: Get Bucket description: Gets metadata for an existing R2 bucket. operationId: r2-get-bucket parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/r2_account_identifier' - name: bucket_name in: path required: true schema: $ref: '#/components/schemas/r2_bucket_name' responses: 4XX: description: Get Bucket response failure content: application/json: schema: $ref: '#/components/schemas/r2_v4_response_failure' "200": description: Get Bucket response content: application/json: schema: allOf: - $ref: '#/components/schemas/r2_v4_response' - type: object properties: result: $ref: '#/components/schemas/r2_bucket' security: - api_token: [] /accounts/{account_id}/r2/buckets/{bucket_name}/sippy: delete: tags: - R2 Bucket summary: Disable Sippy description: Disables Sippy on this bucket operationId: r2-delete-bucket-sippy-config parameters: - name: bucket_name in: path required: true schema: $ref: '#/components/schemas/r2_bucket_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/r2_account_identifier' responses: 4XX: description: Delete Sippy Configuration response failure content: application/json: schema: $ref: '#/components/schemas/r2_v4_response_failure' "200": description: Delete Sippy Configuration response content: application/json: schema: allOf: - $ref: '#/components/schemas/r2_v4_response' - type: object properties: result: type: object properties: enabled: type: boolean enum: - false security: - api_token: [] get: tags: - R2 Bucket summary: Get Sippy Configuration description: Gets configuration for Sippy for an existing R2 bucket. operationId: r2-get-bucket-sippy-config parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/r2_account_identifier' - name: bucket_name in: path required: true schema: $ref: '#/components/schemas/r2_bucket_name' responses: 4XX: description: Get Sippy Configuration response failure content: application/json: schema: $ref: '#/components/schemas/r2_v4_response_failure' "200": description: Get Sippy Configuration response content: application/json: schema: allOf: - $ref: '#/components/schemas/r2_v4_response' - type: object properties: result: $ref: '#/components/schemas/r2_sippy' security: - api_token: [] put: tags: - R2 Bucket summary: Enable Sippy description: Sets configuration for Sippy for an existing R2 bucket. operationId: r2-put-bucket-sippy-config parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/r2_account_identifier' - name: bucket_name in: path required: true schema: $ref: '#/components/schemas/r2_bucket_name' requestBody: required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/r2_enable_sippy_aws' - $ref: '#/components/schemas/r2_enable_sippy_gcs' responses: 4XX: description: Get Sippy Configuration response failure content: application/json: schema: $ref: '#/components/schemas/r2_v4_response_failure' "200": description: Set Sippy Configuration response content: application/json: schema: allOf: - $ref: '#/components/schemas/r2_v4_response' - type: object properties: result: $ref: '#/components/schemas/r2_sippy' security: - api_token: [] /accounts/{account_id}/registrar/domains: get: tags: - Registrar Domains summary: List domains description: List domains handled by Registrar. operationId: registrar-domains-list-domains parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/registrar-api_identifier' responses: 4XX: description: List domains response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/registrar-api_domain_response_collection' - $ref: '#/components/schemas/registrar-api_api-response-common-failure' "200": description: List domains response content: application/json: schema: $ref: '#/components/schemas/registrar-api_domain_response_collection' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/registrar/domains/{domain_name}: get: tags: - Registrar Domains summary: Get domain description: Show individual domain. operationId: registrar-domains-get-domain parameters: - name: domain_name in: path required: true schema: $ref: '#/components/schemas/registrar-api_domain_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/registrar-api_identifier' responses: 4XX: description: Get domain response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/registrar-api_domain_response_single' - $ref: '#/components/schemas/registrar-api_api-response-common-failure' "200": description: Get domain response content: application/json: schema: $ref: '#/components/schemas/registrar-api_domain_response_single' security: - api_email: [] api_key: [] api_token: [] put: tags: - Registrar Domains summary: Update domain description: Update individual domain. operationId: registrar-domains-update-domain parameters: - name: domain_name in: path required: true schema: $ref: '#/components/schemas/registrar-api_domain_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/registrar-api_identifier' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/registrar-api_domain_update_properties' responses: 4XX: description: Update domain response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/registrar-api_domain_response_single' - $ref: '#/components/schemas/registrar-api_api-response-common-failure' "200": description: Update domain response content: application/json: schema: $ref: '#/components/schemas/registrar-api_domain_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/request-tracer/trace: post: tags: - Account Request Tracer summary: Request Trace operationId: account-request-tracer-request-trace parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/request-tracer_identifier' requestBody: required: true content: application/json: schema: type: object required: - url - method properties: body: type: object properties: base64: type: string description: Base64 encoded request body example: c29tZV9yZXF1ZXN0X2JvZHk= json: type: object description: Arbitrary json as request body plain_text: type: string description: Request body as plain text context: type: object description: Additional request parameters properties: bot_score: type: integer description: Bot score used for evaluating tracing request processing geoloc: type: object description: Geodata for tracing request properties: city: type: string example: London 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 skip_challenge: type: boolean description: 'Whether to skip any challenges for tracing request (e.g.: captcha)' example: true threat_score: type: integer description: Threat score used for evaluating tracing request processing cookies: type: object description: Cookies added to tracing request example: cookie_name_1: cookie_value_1 cookie_name_2: cookie_value_2 headers: type: object description: Headers added to tracing request example: header_name_1: header_value_1 header_name_2: header_value_2 method: type: string description: HTTP Method of tracing request example: PUT protocol: type: string description: HTTP Protocol of tracing request example: HTTP/1.1 skip_response: type: boolean description: Skip sending the request to the Origin server after all rules evaluation url: type: string description: URL to which perform tracing request example: https://some.zone/some_path 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 responses: 4XX: description: Request Trace response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/request-tracer_api-response-common-failure' "200": description: Request Trace response content: application/json: schema: allOf: - $ref: '#/components/schemas/request-tracer_api-response-common' - type: object properties: result: type: object description: Trace result with an origin status code properties: status_code: type: integer description: HTTP Status code of zone response trace: $ref: '#/components/schemas/request-tracer_trace' type: object security: - api_email: [] api_key: [] /accounts/{account_id}/roles: get: tags: - Account Roles summary: List Roles description: Get all available roles for an account. operationId: account-roles-list-roles parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/iam_account_identifier' responses: 4XX: description: List Roles response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_collection' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: List Roles response content: application/json: schema: $ref: '#/components/schemas/iam_collection_role_response' security: - api_email: [] api_key: [] /accounts/{account_id}/roles/{role_id}: get: tags: - Account Roles summary: Role Details description: Get information about a specific role for an account. operationId: account-roles-role-details parameters: - name: role_id in: path required: true schema: $ref: '#/components/schemas/iam_schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/iam_account_identifier' responses: 4XX: description: Role Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_single' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Role Details response content: application/json: schema: $ref: '#/components/schemas/iam_single_role_response' security: - api_email: [] api_key: [] /accounts/{account_id}/rules/lists: get: tags: - Lists summary: Get lists description: Fetches all lists in the account. operationId: lists-get-lists parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/lists_identifier' responses: 4XX: description: Get lists response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_lists-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' "200": description: Get lists response content: application/json: schema: $ref: '#/components/schemas/lists_lists-response-collection' security: - api_email: [] api_key: [] post: tags: - Lists summary: Create a list description: Creates a new list of the specified type. operationId: lists-create-a-list parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/lists_identifier' requestBody: required: true content: application/json: schema: type: object required: - name - kind properties: description: $ref: '#/components/schemas/lists_description' kind: $ref: '#/components/schemas/lists_kind' name: $ref: '#/components/schemas/lists_name' responses: 4XX: description: Create a list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_list-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' "200": description: Create a list response content: application/json: schema: $ref: '#/components/schemas/lists_list-response-collection' security: - api_email: [] api_key: [] /accounts/{account_id}/rules/lists/{list_id}: delete: tags: - Lists summary: Delete a list description: Deletes a specific list and all its items. operationId: lists-delete-a-list parameters: - name: list_id in: path required: true schema: $ref: '#/components/schemas/lists_list_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/lists_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_list-delete-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' "200": description: Delete a list response content: application/json: schema: $ref: '#/components/schemas/lists_list-delete-response-collection' security: - api_email: [] api_key: [] get: tags: - Lists summary: Get a list description: Fetches the details of a list. operationId: lists-get-a-list parameters: - name: list_id in: path required: true schema: $ref: '#/components/schemas/lists_list_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/lists_identifier' responses: 4XX: description: Get a list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_list-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' "200": description: Get a list response content: application/json: schema: $ref: '#/components/schemas/lists_list-response-collection' security: - api_email: [] api_key: [] put: tags: - Lists summary: Update a list description: Updates the description of a list. operationId: lists-update-a-list parameters: - name: list_id in: path required: true schema: $ref: '#/components/schemas/lists_list_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/lists_identifier' requestBody: required: true content: application/json: schema: type: object properties: description: $ref: '#/components/schemas/lists_description' responses: 4XX: description: Update a list response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_list-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' "200": description: Update a list response content: application/json: schema: $ref: '#/components/schemas/lists_list-response-collection' security: - api_email: [] api_key: [] /accounts/{account_id}/rules/lists/{list_id}/items: delete: tags: - Lists summary: Delete list items description: |- Removes one or more items from a list. This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`. operationId: lists-delete-list-items parameters: - name: list_id in: path required: true schema: $ref: '#/components/schemas/lists_list_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/lists_identifier' requestBody: required: true content: application/json: schema: type: object properties: items: type: array minItems: 1 items: properties: id: $ref: '#/components/schemas/lists_item_id' responses: 4XX: description: Delete list items response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_lists-async-response' - $ref: '#/components/schemas/lists_api-response-common-failure' "200": description: Delete list items response content: application/json: schema: $ref: '#/components/schemas/lists_lists-async-response' security: - api_email: [] api_key: [] get: tags: - Lists summary: Get list items description: Fetches all the items in the list. operationId: lists-get-list-items parameters: - name: list_id in: path required: true schema: $ref: '#/components/schemas/lists_list_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/lists_identifier' - name: cursor in: query schema: type: string 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 - name: per_page in: query schema: type: integer description: Amount of results to include in each paginated response. A non-negative 32 bit integer. minimum: 1 maximum: 500 - name: search in: query schema: type: string 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. responses: 4XX: description: Get list items response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_items-list-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' "200": description: Get list items response content: application/json: schema: $ref: '#/components/schemas/lists_items-list-response-collection' security: - api_email: [] api_key: [] post: tags: - Lists summary: Create list items description: |- Appends new items to the list. This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`. operationId: lists-create-list-items parameters: - name: list_id in: path required: true schema: $ref: '#/components/schemas/lists_list_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/lists_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/lists_items-update-request-collection' responses: 4XX: description: Create list items response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_lists-async-response' - $ref: '#/components/schemas/lists_api-response-common-failure' "200": description: Create list items response content: application/json: schema: $ref: '#/components/schemas/lists_lists-async-response' security: - api_email: [] api_key: [] put: tags: - Lists summary: Update all list items description: |- Removes all existing items from the list and adds the provided items to the list. This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`. operationId: lists-update-all-list-items parameters: - name: list_id in: path required: true schema: $ref: '#/components/schemas/lists_list_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/lists_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/lists_items-update-request-collection' responses: 4XX: description: Update all list items response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_lists-async-response' - $ref: '#/components/schemas/lists_api-response-common-failure' "200": description: Update all list items response content: application/json: schema: $ref: '#/components/schemas/lists_lists-async-response' security: - api_email: [] api_key: [] /accounts/{account_id}/rulesets: get: tags: - Account Rulesets summary: List account rulesets description: Fetches all rulesets at the account level. operationId: listAccountRulesets parameters: - name: account_id in: path 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: [] post: tags: - Account Rulesets summary: Create an account ruleset description: Creates a ruleset at the account level. operationId: createAccountRuleset parameters: - name: account_id in: path 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: [] /accounts/{account_id}/rulesets/{ruleset_id}: delete: tags: - Account Rulesets summary: Delete an account ruleset description: Deletes all versions of an existing account ruleset. operationId: deleteAccountRuleset parameters: - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: account_id in: path 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: [] get: tags: - Account Rulesets summary: Get an account ruleset description: Fetches the latest version of an account ruleset. operationId: getAccountRuleset parameters: - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: account_id in: path 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: [] put: tags: - Account Rulesets summary: Update an account ruleset description: Updates an account ruleset, creating a new version. operationId: updateAccountRuleset parameters: - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: account_id in: path 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: [] /accounts/{account_id}/rulesets/{ruleset_id}/rules: post: tags: - Account Rulesets summary: Create an account ruleset rule description: Adds a new rule to an account ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default. operationId: createAccountRulesetRule parameters: - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: account_id in: path 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: [] /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}: delete: tags: - Account Rulesets summary: Delete an account ruleset rule description: Deletes an existing rule from an account ruleset. operationId: deleteAccountRulesetRule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RuleId' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: account_id in: path 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: [] patch: tags: - Account Rulesets summary: Update an account ruleset rule description: Updates an existing rule in an account ruleset. operationId: updateAccountRulesetRule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RuleId' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: account_id in: path 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: [] /accounts/{account_id}/rulesets/{ruleset_id}/versions: get: tags: - Account Rulesets summary: List an account ruleset's versions description: Fetches the versions of an account ruleset. operationId: listAccountRulesetVersions parameters: - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: account_id in: path 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: [] /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}: delete: tags: - Account Rulesets summary: Delete an account ruleset version description: Deletes an existing version of an account ruleset. operationId: deleteAccountRulesetVersion parameters: - name: ruleset_version in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetVersion' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: account_id in: path 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: [] get: tags: - Account Rulesets summary: Get an account ruleset version description: Fetches a specific version of an account ruleset. operationId: getAccountRulesetVersion parameters: - name: ruleset_version in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetVersion' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: account_id in: path 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: [] /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}: get: tags: - Account Rulesets summary: List an account ruleset version's rules by tag description: Fetches the rules of a managed account ruleset version for a given tag. operationId: listAccountRulesetVersionRulesByTag parameters: - name: rule_tag in: path required: true schema: $ref: '#/components/schemas/rulesets_RuleCategory' - name: ruleset_version in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetVersion' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: account_id in: path 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: [] /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint: get: tags: - Account Rulesets summary: Get an account entry point ruleset description: Fetches the latest version of the account entry point ruleset for a given phase. operationId: getAccountEntrypointRuleset parameters: - name: ruleset_phase in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetPhase' - name: account_id in: path 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: [] put: tags: - Account Rulesets summary: Update an account entry point ruleset description: Updates an account entry point ruleset, creating a new version. operationId: updateAccountEntrypointRuleset parameters: - name: ruleset_phase in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetPhase' - name: account_id in: path 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: [] /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions: get: tags: - Account Rulesets summary: List an account entry point ruleset's versions description: Fetches the versions of an account entry point ruleset. operationId: listAccountEntrypointRulesetVersions parameters: - name: ruleset_phase in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetPhase' - name: account_id in: path 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: [] /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}: get: tags: - Account Rulesets summary: Get an account entry point ruleset version description: Fetches a specific version of an account entry point ruleset. operationId: getAccountEntrypointRulesetVersion parameters: - name: ruleset_version in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetVersion' - name: ruleset_phase in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetPhase' - name: account_id in: path 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: [] /accounts/{account_id}/rum/site_info: post: tags: - Web Analytics summary: Create a Web Analytics site description: Creates a new Web Analytics site. operationId: web-analytics-create-site parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/rum_create-site-request' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/rum_api-response-common-failure' "200": description: Created Web Analytics site content: application/json: schema: $ref: '#/components/schemas/rum_site-response-single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/rum/site_info/{site_id}: delete: tags: - Web Analytics summary: Delete a Web Analytics site description: Deletes an existing Web Analytics site. operationId: web-analytics-delete-site parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' - name: site_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/rum_api-response-common-failure' "200": description: Deleted Web Analytics site identifier content: application/json: schema: $ref: '#/components/schemas/rum_site-tag-response-single' security: - api_email: [] api_key: [] api_token: [] get: tags: - Web Analytics summary: Get a Web Analytics site description: Retrieves a Web Analytics site. operationId: web-analytics-get-site parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' - name: site_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/rum_api-response-common-failure' "200": description: Web Analytics site content: application/json: schema: $ref: '#/components/schemas/rum_site-response-single' security: - api_email: [] api_key: [] api_token: [] put: tags: - Web Analytics summary: Update a Web Analytics site description: Updates an existing Web Analytics site. operationId: web-analytics-update-site parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' - name: site_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/rum_create-site-request' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/rum_api-response-common-failure' "200": description: Updated Web Analytics site content: application/json: schema: $ref: '#/components/schemas/rum_site-response-single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/rum/site_info/list: get: tags: - Web Analytics summary: List Web Analytics sites description: Lists all Web Analytics sites of an account. operationId: web-analytics-list-sites parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' - name: per_page in: query schema: $ref: '#/components/schemas/rum_per_page' - name: page in: query schema: $ref: '#/components/schemas/rum_page' - name: order_by in: query schema: $ref: '#/components/schemas/rum_order_by' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/rum_api-response-common-failure' "200": description: List of Web Analytics sites content: application/json: schema: $ref: '#/components/schemas/rum_sites-response-collection' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/rum/v2/{ruleset_id}/rule: post: tags: - Web Analytics summary: Create a Web Analytics rule description: Creates a new rule in a Web Analytics ruleset. operationId: web-analytics-create-rule parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rum_ruleset_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/rum_create-rule-request' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/rum_api-response-common-failure' "200": description: Created Web Analytics rule content: application/json: schema: $ref: '#/components/schemas/rum_rule-response-single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}: delete: tags: - Web Analytics summary: Delete a Web Analytics rule description: Deletes an existing rule from a Web Analytics ruleset. operationId: web-analytics-delete-rule parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rum_ruleset_identifier' - name: rule_id in: path required: true schema: $ref: '#/components/schemas/rum_rule_identifier' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/rum_api-response-common-failure' "200": description: Deleted Web Analytics rule identifier content: application/json: schema: $ref: '#/components/schemas/rum_rule-id-response-single' security: - api_email: [] api_key: [] api_token: [] put: tags: - Web Analytics summary: Update a Web Analytics rule description: Updates a rule in a Web Analytics ruleset. operationId: web-analytics-update-rule parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rum_ruleset_identifier' - name: rule_id in: path required: true schema: $ref: '#/components/schemas/rum_rule_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/rum_create-rule-request' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/rum_api-response-common-failure' "200": description: Updated Web Analytics rule content: application/json: schema: $ref: '#/components/schemas/rum_rule-response-single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/rum/v2/{ruleset_id}/rules: get: tags: - Web Analytics summary: List rules in Web Analytics ruleset description: Lists all the rules in a Web Analytics ruleset. operationId: web-analytics-list-rules parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rum_ruleset_identifier' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/rum_api-response-common-failure' "200": description: List of Web Analytics rules in the ruleset content: application/json: schema: $ref: '#/components/schemas/rum_rules-response-collection' security: - api_email: [] api_key: [] api_token: [] post: tags: - Web Analytics summary: Update Web Analytics rules description: Modifies one or more rules in a Web Analytics ruleset with a single request. operationId: web-analytics-modify-rules parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/rum_identifier' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rum_ruleset_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/rum_modify-rules-request' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/rum_api-response-common-failure' "200": description: List of modified Web Analytics rules content: application/json: schema: $ref: '#/components/schemas/rum_rules-response-collection' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/secondary_dns/acls: get: tags: - Secondary DNS (ACL) summary: List ACLs description: List ACLs. operationId: secondary-dns-(-acl)-list-ac-ls parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' responses: 4XX: description: List ACLs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_components-schemas-response_collection' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: List ACLs response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Secondary DNS (ACL) summary: Create ACL description: Create ACL. operationId: secondary-dns-(-acl)-create-acl parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' requestBody: required: true content: application/json: schema: required: - name - ip_range responses: 4XX: description: Create ACL response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_components-schemas-single_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Create ACL response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/secondary_dns/acls/{acl_id}: delete: tags: - Secondary DNS (ACL) summary: Delete ACL description: Delete ACL. operationId: secondary-dns-(-acl)-delete-acl parameters: - name: acl_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_components-schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete ACL response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_components-schemas-id_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Delete ACL response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_components-schemas-id_response' security: - api_email: [] api_key: [] get: tags: - Secondary DNS (ACL) summary: ACL Details description: Get ACL. operationId: secondary-dns-(-acl)-acl-details parameters: - name: acl_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_components-schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' responses: 4XX: description: ACL Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_components-schemas-single_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: ACL Details response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Secondary DNS (ACL) summary: Update ACL description: Modify ACL. operationId: secondary-dns-(-acl)-update-acl parameters: - name: acl_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_components-schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/secondary-dns_acl' responses: 4XX: description: Update ACL response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_components-schemas-single_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Update ACL response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/secondary_dns/peers: get: tags: - Secondary DNS (Peer) summary: List Peers description: List Peers. operationId: secondary-dns-(-peer)-list-peers parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' responses: 4XX: description: List Peers response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_schemas-response_collection' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: List Peers response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Secondary DNS (Peer) summary: Create Peer description: Create Peer. operationId: secondary-dns-(-peer)-create-peer parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' requestBody: required: true content: application/json: schema: required: - name responses: 4XX: description: Create Peer response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_schemas-single_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Create Peer response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/secondary_dns/peers/{peer_id}: delete: tags: - Secondary DNS (Peer) summary: Delete Peer description: Delete Peer. operationId: secondary-dns-(-peer)-delete-peer parameters: - name: peer_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_components-schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Peer response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_components-schemas-id_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Delete Peer response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_components-schemas-id_response' security: - api_email: [] api_key: [] get: tags: - Secondary DNS (Peer) summary: Peer Details description: Get Peer. operationId: secondary-dns-(-peer)-peer-details parameters: - name: peer_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_components-schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' responses: 4XX: description: Peer Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_schemas-single_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Peer Details response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Secondary DNS (Peer) summary: Update Peer description: Modify Peer. operationId: secondary-dns-(-peer)-update-peer parameters: - name: peer_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_components-schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/secondary-dns_peer' responses: 4XX: description: Update Peer response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_schemas-single_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Update Peer response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_schemas-single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/secondary_dns/tsigs: get: tags: - Secondary DNS (TSIG) summary: List TSIGs description: List TSIGs. operationId: secondary-dns-(-tsig)-list-tsi-gs parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' responses: 4XX: description: List TSIGs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_response_collection' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: List TSIGs response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_response_collection' security: - api_email: [] api_key: [] post: tags: - Secondary DNS (TSIG) summary: Create TSIG description: Create TSIG. operationId: secondary-dns-(-tsig)-create-tsig parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/secondary-dns_tsig' responses: 4XX: description: Create TSIG response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_single_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Create TSIG response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/secondary_dns/tsigs/{tsig_id}: delete: tags: - Secondary DNS (TSIG) summary: Delete TSIG description: Delete TSIG. operationId: secondary-dns-(-tsig)-delete-tsig parameters: - name: tsig_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete TSIG response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_schemas-id_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Delete TSIG response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_schemas-id_response' security: - api_email: [] api_key: [] get: tags: - Secondary DNS (TSIG) summary: TSIG Details description: Get TSIG. operationId: secondary-dns-(-tsig)-tsig-details parameters: - name: tsig_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' responses: 4XX: description: TSIG Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_single_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: TSIG Details response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_single_response' security: - api_email: [] api_key: [] put: tags: - Secondary DNS (TSIG) summary: Update TSIG description: Modify TSIG. operationId: secondary-dns-(-tsig)-update-tsig parameters: - name: tsig_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/secondary-dns_tsig' responses: 4XX: description: Update TSIG response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_single_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Update TSIG response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_single_response' security: - api_email: [] api_key: [] /accounts/{account_id}/storage/analytics: get: tags: - Workers KV Request Analytics summary: Query Request Analytics description: Retrieves Workers KV request metrics for the given account. operationId: workers-kv-request-analytics-query-request-analytics parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' - name: query in: 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: description: Query Request Analytics response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - type: object properties: result: $ref: '#/components/schemas/workers-kv_result' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: Query Request Analytics response content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - type: object properties: result: $ref: '#/components/schemas/workers-kv_schemas-result' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/storage/analytics/stored: get: tags: - Workers KV Stored Data Analytics summary: Query Stored Data Analytics description: Retrieves Workers KV stored data metrics for the given account. operationId: workers-kv-stored-data-analytics-query-stored-data-analytics parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' - name: query in: 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: description: Query Stored Data Analytics response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - type: object properties: result: $ref: '#/components/schemas/workers-kv_result' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: Query Stored Data Analytics response content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - type: object properties: result: $ref: '#/components/schemas/workers-kv_components-schemas-result' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/storage/kv/namespaces: get: tags: - Workers KV Namespace summary: List Namespaces description: Returns the namespaces owned by an account. operationId: workers-kv-namespace-list-namespaces parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Maximum number of results per page. default: 20 minimum: 5 maximum: 100 - name: order in: query schema: description: Field to order results by. enum: - id - title example: id - name: direction in: query schema: description: Direction to order namespaces. enum: - asc - desc example: asc responses: 4XX: description: List Namespaces response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/workers-kv_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/workers-kv_namespace' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: List Namespaces response content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/workers-kv_namespace' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Workers KV Namespace summary: Create a Namespace description: Creates a namespace under the given title. A `400` is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced. operationId: workers-kv-namespace-create-a-namespace parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers-kv_create_rename_namespace_body' responses: 4XX: description: Create a Namespace response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - type: object properties: result: $ref: '#/components/schemas/workers-kv_namespace' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: Create a Namespace response content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - type: object properties: result: $ref: '#/components/schemas/workers-kv_namespace' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/storage/kv/namespaces/{namespace_id}: delete: tags: - Workers KV Namespace summary: Remove a Namespace description: Deletes the namespace corresponding to the given ID. operationId: workers-kv-namespace-remove-a-namespace parameters: - name: namespace_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Remove a Namespace response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: Remove a Namespace response content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-single' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Workers KV Namespace summary: Rename a Namespace description: Modifies a namespace's title. operationId: workers-kv-namespace-rename-a-namespace parameters: - name: namespace_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers-kv_create_rename_namespace_body' responses: 4XX: description: Rename a Namespace response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: Rename a Namespace response content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-single' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk: delete: tags: - Workers KV Namespace summary: Delete multiple key-value pairs description: Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed. operationId: workers-kv-namespace-delete-multiple-key-value-pairs parameters: - name: namespace_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers-kv_bulk_delete' responses: 4XX: description: Delete multiple key-value pairs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: Delete multiple key-value pairs response content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-single' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Workers KV Namespace summary: Write multiple key-value pairs description: Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. The entire request size must be 100 megabytes or less. operationId: workers-kv-namespace-write-multiple-key-value-pairs parameters: - name: namespace_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers-kv_bulk_write' responses: 4XX: description: Write multiple key-value pairs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: Write multiple key-value pairs response content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-single' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/keys: get: tags: - Workers KV Namespace summary: List a Namespace's Keys description: Lists a namespace's keys. operationId: workers-kv-namespace-list-a-namespace'-s-keys parameters: - name: namespace_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' - name: limit in: query schema: type: number 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. default: 1000 minimum: 10 maximum: 1000 - name: prefix in: query schema: type: string 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 - name: cursor in: query schema: type: string description: Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the `cursors` object in the `result_info` structure. example: 6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw responses: 4XX: description: List a Namespace's Keys response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/workers-kv_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/workers-kv_key' result_info: properties: count: type: number description: Total results returned based on your list parameters. example: 1 cursor: $ref: '#/components/schemas/workers-kv_cursor' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: List a Namespace's Keys response content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/workers-kv_key' result_info: properties: count: type: number description: Total results returned based on your list parameters. example: 1 cursor: $ref: '#/components/schemas/workers-kv_cursor' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/metadata/{key_name}: get: tags: - Workers KV Namespace summary: Read the metadata for a key description: Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. operationId: workers-kv-namespace-read-the-metadata-for-a-key parameters: - name: key_name in: path required: true schema: $ref: '#/components/schemas/workers-kv_key_name' - name: namespace_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' responses: 4XX: description: Read the metadata for a key response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - properties: result: $ref: '#/components/schemas/workers-kv_list_metadata' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: Read the metadata for a key response content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - properties: result: $ref: '#/components/schemas/workers-kv_list_metadata' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}: delete: tags: - Workers KV Namespace summary: Delete key-value pair description: Remove a KV pair from the namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. operationId: workers-kv-namespace-delete-key-value-pair parameters: - name: key_name in: path required: true schema: $ref: '#/components/schemas/workers-kv_key_name' - name: namespace_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete key-value pair response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: Delete key-value pair response content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-single' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Workers KV Namespace summary: Read key-value pair description: Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (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: - name: key_name in: path required: true schema: $ref: '#/components/schemas/workers-kv_key_name' - name: namespace_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' responses: 4XX: description: Read key-value pair response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_value' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: Read key-value pair response content: application/json: schema: $ref: '#/components/schemas/workers-kv_value' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Workers KV Namespace summary: Write key-value pair with metadata description: Write a value identified by a key. Use URL-encoding to use special characters (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: - name: key_name in: path required: true schema: $ref: '#/components/schemas/workers-kv_key_name' - name: namespace_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_namespace_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers-kv_identifier' requestBody: required: true content: multipart/form-data: schema: type: object required: - value - metadata properties: metadata: $ref: '#/components/schemas/workers-kv_metadata' value: $ref: '#/components/schemas/workers-kv_value' responses: 4XX: description: Write key-value pair with metadata response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers-kv_api-response-single' - $ref: '#/components/schemas/workers-kv_api-response-common-failure' "200": description: Write key-value pair with metadata response content: application/json: schema: $ref: '#/components/schemas/workers-kv_api-response-single' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/stream: get: tags: - Stream Videos summary: List videos description: Lists up to 1000 videos from a single request. For a specific range, refer to the optional parameters. operationId: stream-videos-list-videos parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' - name: status in: query schema: $ref: '#/components/schemas/stream_media_state' - name: creator in: query schema: $ref: '#/components/schemas/stream_creator' - name: type in: query schema: $ref: '#/components/schemas/stream_type' - name: asc in: query schema: $ref: '#/components/schemas/stream_asc' - name: search in: query schema: $ref: '#/components/schemas/stream_search' - name: start in: query schema: $ref: '#/components/schemas/stream_start' - name: end in: query schema: $ref: '#/components/schemas/stream_end' - name: include_counts in: query schema: $ref: '#/components/schemas/stream_include_counts' responses: 4XX: description: List videos response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: List videos response content: application/json: schema: $ref: '#/components/schemas/stream_video_response_collection' security: - api_email: [] api_key: [] api_token: [] post: tags: - Stream Videos summary: Initiate video uploads using TUS description: Initiates a video upload using the TUS protocol. On success, the server responds with a status code 201 (created) and includes a `location` header to indicate where the content should be uploaded. Refer to https://tus.io for protocol details. operationId: stream-videos-initiate-video-uploads-using-tus parameters: - name: Tus-Resumable in: header required: true schema: $ref: '#/components/schemas/stream_tus_resumable' - name: Upload-Creator in: header schema: $ref: '#/components/schemas/stream_creator' - name: Upload-Length in: header required: true schema: $ref: '#/components/schemas/stream_upload_length' - name: Upload-Metadata in: header schema: $ref: '#/components/schemas/stream_upload_metadata' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Initiate video uploads using TUS response failure content: application/json: {} "200": description: Initiate video uploads using TUS response content: application/json: {} security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/{identifier}: delete: tags: - Stream Videos summary: Delete video description: Deletes a video and its copies from Cloudflare Stream. operationId: stream-videos-delete-video parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete video response failure content: application/json: {} "200": description: Delete video response content: application/json: {} security: - api_email: [] api_key: [] api_token: [] get: tags: - Stream Videos summary: Retrieve video details description: Fetches details for a single video. operationId: stream-videos-retrieve-video-details parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' responses: 4XX: description: Retrieve video details response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Retrieve video details response content: application/json: schema: $ref: '#/components/schemas/stream_video_response_single' security: - api_email: [] api_key: [] api_token: [] post: tags: - Stream Videos summary: Edit video details description: Edit details for a single video. operationId: stream-videos-update-video-details parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/stream_video_update' responses: 4XX: description: Edit video details response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Edit video details response content: application/json: schema: $ref: '#/components/schemas/stream_video_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/{identifier}/audio: get: tags: - Stream Audio Tracks summary: List additional audio tracks on a video 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' responses: 4XX: description: Lists additional audio tracks on a video response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Lists additional audio tracks on a video content: application/json: schema: $ref: '#/components/schemas/stream_listAudioTrackResponse' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/{identifier}/audio/{audio_identifier}: delete: tags: - Stream Audio Tracks summary: Delete additional audio tracks on a video 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: audio_identifier in: path required: true schema: $ref: '#/components/schemas/stream_audio_identifier' responses: 4XX: description: Deletes additional audio tracks on a video response failure content: application/json: schema: $ref: '#/components/schemas/stream_deleted_response' "200": description: Deletes additional audio tracks on a video content: application/json: schema: $ref: '#/components/schemas/stream_deleted_response' security: - api_email: [] api_key: [] api_token: [] patch: tags: - Stream Audio Tracks summary: Edit additional audio tracks on a video 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: audio_identifier in: path required: true schema: $ref: '#/components/schemas/stream_audio_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/stream_editAudioTrack' responses: 4XX: description: Edits additional audio tracks on a video response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Edits additional audio tracks on a video content: application/json: schema: $ref: '#/components/schemas/stream_addAudioTrackResponse' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/{identifier}/audio/copy: post: tags: - Stream Audio Tracks summary: Add audio tracks to a video description: Adds an additional audio track to a video using the provided audio track URL. operationId: add-audio-track parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/stream_copyAudioTrack' responses: 4XX: description: Add audio tracks to a video response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Add audio tracks to a video content: application/json: schema: $ref: '#/components/schemas/stream_addAudioTrackResponse' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/{identifier}/captions: get: tags: - Stream Subtitles/Captions summary: List captions or subtitles description: Lists the available captions or subtitles for a specific video. operationId: stream-subtitles/-captions-list-captions-or-subtitles parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' responses: 4XX: description: List captions or subtitles response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: List captions or subtitles response content: application/json: schema: $ref: '#/components/schemas/stream_language_response_collection' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/{identifier}/captions/{language}: delete: tags: - Stream Subtitles/Captions summary: Delete captions or subtitles description: Removes the captions or subtitles from a video. operationId: stream-subtitles/-captions-delete-captions-or-subtitles parameters: - name: language in: path required: true schema: $ref: '#/components/schemas/stream_language' - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete captions or subtitles response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Delete captions or subtitles response content: application/json: schema: allOf: - $ref: '#/components/schemas/stream_api-response-common' - properties: result: type: string example: "" security: - api_email: [] api_key: [] api_token: [] get: tags: - Stream Subtitles/Captions summary: List captions or subtitles for a provided language description: Lists the captions or subtitles for provided language. operationId: stream-subtitles/-captions-get-caption-or-subtitle-for-language parameters: - name: language in: path required: true schema: $ref: '#/components/schemas/stream_language' - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' responses: 4XX: description: List captions or subtitles response for a provided language content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: List captions or subtitles response for a provided language content: application/json: schema: $ref: '#/components/schemas/stream_language_response_single' security: - api_email: [] api_key: [] api_token: [] put: tags: - Stream Subtitles/Captions summary: Upload captions or subtitles description: Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed. operationId: stream-subtitles/-captions-upload-captions-or-subtitles parameters: - name: language in: path required: true schema: $ref: '#/components/schemas/stream_language' - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/stream_caption_basic_upload' responses: 4XX: description: Upload captions or subtitles response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Upload captions or subtitles response content: application/json: schema: $ref: '#/components/schemas/stream_language_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/{identifier}/captions/{language}/vtt: get: tags: - Stream Subtitles/Captions summary: Return WebVTT captions for a provided language description: Return WebVTT captions for a provided language. operationId: stream-subtitles/-captions-get-vtt-caption-or-subtitle parameters: - name: language in: path required: true schema: $ref: '#/components/schemas/stream_language' - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Return WebVTT caption or subtitle response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Return WebVTT caption or subtitle response content: text/vtt: schema: type: string example: | 'WEBVTT 00:00:00.000 --> 00:00:02.480 This is example response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/{identifier}/downloads: delete: tags: - Stream MP4 Downloads summary: Delete downloads description: Delete the downloads for a video. operationId: stream-m-p-4-downloads-delete-downloads parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' responses: 4XX: description: Delete downloads response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Delete downloads response content: application/json: schema: $ref: '#/components/schemas/stream_deleted_response' security: - api_email: [] api_key: [] api_token: [] get: tags: - Stream MP4 Downloads summary: List downloads description: Lists the downloads created for a video. operationId: stream-m-p-4-downloads-list-downloads parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' responses: 4XX: description: List downloads response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: List downloads response content: application/json: schema: $ref: '#/components/schemas/stream_downloads_response' security: - api_email: [] api_key: [] api_token: [] post: tags: - Stream MP4 Downloads summary: Create downloads description: Creates a download for a video when a video is ready to view. operationId: stream-m-p-4-downloads-create-downloads parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Create downloads response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Create downloads response content: application/json: schema: $ref: '#/components/schemas/stream_downloads_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/{identifier}/embed: get: tags: - Stream Videos summary: Retrieve embed Code HTML description: Fetches an HTML code snippet to embed a video in a web page delivered through Cloudflare. On success, returns an HTML fragment for use on web pages to display a video. On failure, returns a JSON response body. operationId: stream-videos-retreieve-embed-code-html parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' responses: 4XX: description: Retreieve embed Code HTML response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Retreieve embed Code HTML response content: application/json: schema: example: security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/{identifier}/token: post: tags: - Stream Videos summary: Create signed URL tokens for videos 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: - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/stream_signed_token_request' responses: 4XX: description: Create signed URL tokens for videos response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Create signed URL tokens for videos response content: application/json: schema: $ref: '#/components/schemas/stream_signed_token_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/clip: post: tags: - Stream Video Clipping summary: Clip videos given a start and end time description: Clips a video based on the specified start and end times provided in seconds. operationId: stream-video-clipping-clip-videos-given-a-start-and-end-time parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/stream_videoClipStandard' responses: 4XX: description: Clip videos given a start and end time response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Clip videos given a start and end time response content: application/json: schema: $ref: '#/components/schemas/stream_clipResponseSingle' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/copy: post: tags: - Stream Videos summary: Upload videos from a URL description: Uploads a video to Stream from a provided URL. operationId: stream-videos-upload-videos-from-a-url parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' - name: Upload-Creator in: header schema: $ref: '#/components/schemas/stream_creator' - name: Upload-Metadata in: header schema: $ref: '#/components/schemas/stream_upload_metadata' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/stream_video_copy_request' responses: 4XX: description: Upload videos from a URL response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Upload videos from a URL response content: application/json: schema: $ref: '#/components/schemas/stream_video_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/direct_upload: post: tags: - Stream Videos summary: Upload videos via direct upload URLs description: Creates a direct upload that allows video uploads without an API key. operationId: stream-videos-upload-videos-via-direct-upload-ur-ls parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' - name: Upload-Creator in: header schema: $ref: '#/components/schemas/stream_creator' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/stream_direct_upload_request' responses: 4XX: description: Upload videos via direct upload URLs response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Upload videos via direct upload URLs response content: application/json: schema: $ref: '#/components/schemas/stream_direct_upload_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/keys: get: tags: - Stream Signing Keys summary: List signing keys description: Lists the video ID and creation date and time when a signing key was created. operationId: stream-signing-keys-list-signing-keys parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' responses: 4XX: description: List signing keys response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: List signing keys response content: application/json: schema: $ref: '#/components/schemas/stream_key_response_collection' security: - api_email: [] api_key: [] api_token: [] post: tags: - Stream Signing Keys summary: Create signing keys description: Creates an RSA private key in PEM and JWK formats. Key files are only displayed once after creation. Keys are created, used, and deleted independently of videos, and every key can sign any video. operationId: stream-signing-keys-create-signing-keys parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Create signing keys response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Create signing keys response content: application/json: schema: $ref: '#/components/schemas/stream_key_generation_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/keys/{identifier}: delete: tags: - Stream Signing Keys summary: Delete signing keys description: Deletes signing keys and revokes all signed URLs generated with the key. operationId: stream-signing-keys-delete-signing-keys parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete signing keys response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Delete signing keys response content: application/json: schema: $ref: '#/components/schemas/stream_deleted_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/live_inputs: get: tags: - Stream Live Inputs summary: List live inputs description: Lists the live inputs created for an account. To get the credentials needed to stream to a specific live input, request a single live input. operationId: stream-live-inputs-list-live-inputs parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' - name: include_counts in: query schema: $ref: '#/components/schemas/stream_include_counts' responses: 4XX: description: List live inputs response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: List live inputs response content: application/json: schema: $ref: '#/components/schemas/stream_live_input_response_collection' security: - api_email: [] api_key: [] api_token: [] post: tags: - Stream Live Inputs summary: Create a live input description: Creates a live input, and returns credentials that you or your users can use to stream live video to Cloudflare Stream. operationId: stream-live-inputs-create-a-live-input parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/stream_create_input_request' responses: 4XX: description: Create a live input response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Create a live input response content: application/json: schema: $ref: '#/components/schemas/stream_live_input_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/live_inputs/{live_input_identifier}: delete: tags: - Stream Live Inputs summary: Delete a live input description: Prevents a live input from being streamed to and makes the live input inaccessible to any future API calls. operationId: stream-live-inputs-delete-a-live-input parameters: - name: live_input_identifier in: path required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a live input response failure content: application/json: {} "200": description: Delete a live input response content: application/json: {} security: - api_email: [] api_key: [] api_token: [] get: tags: - Stream Live Inputs summary: Retrieve a live input description: Retrieves details of an existing live input. operationId: stream-live-inputs-retrieve-a-live-input parameters: - name: live_input_identifier in: path required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' responses: 4XX: description: Retrieve a live input response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Retrieve a live input response content: application/json: schema: $ref: '#/components/schemas/stream_live_input_response_single' security: - api_email: [] api_key: [] api_token: [] put: tags: - Stream Live Inputs summary: Update a live input description: Updates a specified live input. operationId: stream-live-inputs-update-a-live-input parameters: - name: live_input_identifier in: path required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/stream_update_input_request' responses: 4XX: description: Update a live input response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Update a live input response content: application/json: schema: $ref: '#/components/schemas/stream_live_input_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs: get: tags: - Stream Live Inputs summary: List all outputs associated with a specified live input description: Retrieves all outputs associated with a specified live input. operationId: stream-live-inputs-list-all-outputs-associated-with-a-specified-live-input parameters: - name: live_input_identifier in: path required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' responses: 4XX: description: List all outputs associated with a specified live input response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: List all outputs associated with a specified live input response content: application/json: schema: $ref: '#/components/schemas/stream_output_response_collection' security: - api_email: [] api_key: [] api_token: [] post: tags: - Stream Live Inputs summary: Create a new output, connected to a live input description: Creates a new output that can be used to simulcast or restream live video to other RTMP or SRT destinations. Outputs are always linked to a specific live input — one live input can have many outputs. operationId: stream-live-inputs-create-a-new-output,-connected-to-a-live-input parameters: - name: live_input_identifier in: path required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/stream_create_output_request' responses: 4XX: description: Create a new output, connected to a live input response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Create a new output, connected to a live input response content: application/json: schema: $ref: '#/components/schemas/stream_output_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}: delete: tags: - Stream Live Inputs summary: Delete an output description: Deletes an output and removes it from the associated live input. operationId: stream-live-inputs-delete-an-output parameters: - name: output_identifier in: path required: true schema: $ref: '#/components/schemas/stream_output_identifier' - name: live_input_identifier in: path required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete an output response failure content: application/json: {} "200": description: Delete an output response content: application/json: {} security: - api_email: [] api_key: [] api_token: [] put: tags: - Stream Live Inputs summary: Update an output description: Updates the state of an output. operationId: stream-live-inputs-update-an-output parameters: - name: output_identifier in: path required: true schema: $ref: '#/components/schemas/stream_output_identifier' - name: live_input_identifier in: path required: true schema: $ref: '#/components/schemas/stream_live_input_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_schemas-identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/stream_update_output_request' responses: 4XX: description: Update an output response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Update an output response content: application/json: schema: $ref: '#/components/schemas/stream_output_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/storage-usage: get: tags: - Stream Videos summary: Storage use description: Returns information about an account's storage use. operationId: stream-videos-storage-usage parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' - name: creator in: query schema: $ref: '#/components/schemas/stream_creator' responses: 4XX: description: Returns information about an account's storage use response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Returns information about an account's storage use response content: application/json: schema: $ref: '#/components/schemas/stream_storage_use_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/watermarks: get: tags: - Stream Watermark Profile summary: List watermark profiles description: Lists all watermark profiles for an account. operationId: stream-watermark-profile-list-watermark-profiles parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' responses: 4XX: description: List watermark profiles response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: List watermark profiles response content: application/json: schema: $ref: '#/components/schemas/stream_watermark_response_collection' security: - api_email: [] api_key: [] api_token: [] post: tags: - Stream Watermark Profile summary: Create watermark profiles via basic upload description: Creates watermark profiles using a single `HTTP POST multipart/form-data` request. operationId: stream-watermark-profile-create-watermark-profiles-via-basic-upload parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/stream_watermark_basic_upload' responses: 4XX: description: Create watermark profiles via basic upload response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Create watermark profiles via basic upload response content: application/json: schema: $ref: '#/components/schemas/stream_watermark_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/watermarks/{identifier}: delete: tags: - Stream Watermark Profile summary: Delete watermark profiles description: Deletes a watermark profile. operationId: stream-watermark-profile-delete-watermark-profiles parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_watermark_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete watermark profiles response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Delete watermark profiles response content: application/json: schema: allOf: - $ref: '#/components/schemas/stream_api-response-single' - properties: result: type: string example: "" security: - api_email: [] api_key: [] api_token: [] get: tags: - Stream Watermark Profile summary: Watermark profile details description: Retrieves details for a single watermark profile. operationId: stream-watermark-profile-watermark-profile-details parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/stream_watermark_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' responses: 4XX: description: Watermark profile details response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Watermark profile details response content: application/json: schema: $ref: '#/components/schemas/stream_watermark_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/stream/webhook: delete: tags: - Stream Webhook summary: Delete webhooks description: Deletes a webhook. operationId: stream-webhook-delete-webhooks parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete webhooks response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Delete webhooks response content: application/json: schema: $ref: '#/components/schemas/stream_deleted_response' security: - api_email: [] api_key: [] api_token: [] get: tags: - Stream Webhook summary: View webhooks description: Retrieves a list of webhooks. operationId: stream-webhook-view-webhooks parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' responses: 4XX: description: View webhooks response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: View webhooks response content: application/json: schema: $ref: '#/components/schemas/stream_webhook_response_single' security: - api_email: [] api_key: [] api_token: [] put: tags: - Stream Webhook summary: Create webhooks description: Creates a webhook notification. operationId: stream-webhook-create-webhooks parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/stream_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/stream_webhook_request' responses: 4XX: description: Create webhooks response failure content: application/json: schema: $ref: '#/components/schemas/stream_api-response-common-failure' "200": description: Create webhooks response content: application/json: schema: $ref: '#/components/schemas/stream_webhook_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_id}/teamnet/routes: get: tags: - Tunnel route summary: List tunnel routes description: Lists and filters private network routes in an account. operationId: tunnel-route-list-tunnel-routes parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' - name: comment in: query schema: $ref: '#/components/schemas/tunnel_comment' - name: is_deleted in: query schema: description: If `true`, only include deleted routes. If `false`, exclude deleted routes. If empty, all routes will be included. - name: network_subset in: query schema: description: If set, only list routes that are contained within this IP range. - name: network_superset in: query schema: description: If set, only list routes that contain this IP range. - name: existed_at in: query schema: description: If provided, include only routes that were created (and not deleted) before this time. - name: tunnel_id in: query schema: description: UUID of the Cloudflare Tunnel serving the route. - name: route_id in: query schema: $ref: '#/components/schemas/tunnel_route_id' - name: tun_types in: query schema: $ref: '#/components/schemas/tunnel_tunnel_types' - name: virtual_network_id in: query schema: description: UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account. - name: per_page in: query schema: $ref: '#/components/schemas/tunnel_per_page' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 responses: 4XX: description: List tunnel routes response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_teamnet_response_collection' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: List tunnel routes response content: application/json: schema: $ref: '#/components/schemas/tunnel_teamnet_response_collection' security: - api_email: [] api_key: [] post: tags: - Tunnel route summary: Create a tunnel route description: Routes a private network through a Cloudflare Tunnel. operationId: tunnel-route-create-a-tunnel-route parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object required: - ip_network - tunnel_id properties: comment: $ref: '#/components/schemas/tunnel_comment' ip_network: $ref: '#/components/schemas/tunnel_ip_network' tunnel_id: $ref: '#/components/schemas/tunnel_tunnel_id' virtual_network_id: $ref: '#/components/schemas/tunnel_route_virtual_network_id' responses: 4XX: description: Create a tunnel route response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_route_response_single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Create a tunnel route response content: application/json: schema: $ref: '#/components/schemas/tunnel_route_response_single' security: - api_email: [] api_key: [] /accounts/{account_id}/teamnet/routes/{route_id}: delete: tags: - Tunnel route summary: Delete a tunnel route description: | Deletes a private network route from an account. operationId: tunnel-route-delete-a-tunnel-route parameters: - name: route_id in: path required: true schema: $ref: '#/components/schemas/tunnel_route_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' responses: 4XX: description: Delete a tunnel route response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_route_response_single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Delete a tunnel route response content: application/json: schema: $ref: '#/components/schemas/tunnel_route_response_single' security: - api_email: [] api_key: [] patch: tags: - Tunnel route summary: Update a tunnel route 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: - name: route_id in: path required: true schema: $ref: '#/components/schemas/tunnel_route_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object properties: comment: $ref: '#/components/schemas/tunnel_comment' network: $ref: '#/components/schemas/tunnel_ip_network' tun_type: $ref: '#/components/schemas/tunnel_tunnel_type' tunnel_id: $ref: '#/components/schemas/tunnel_route_tunnel_id' virtual_network_id: $ref: '#/components/schemas/tunnel_route_virtual_network_id' responses: 4XX: description: Update a tunnel route response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_route_response_single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Update a tunnel route response content: application/json: schema: $ref: '#/components/schemas/tunnel_route_response_single' security: - api_email: [] api_key: [] /accounts/{account_id}/teamnet/routes/ip/{ip}: get: tags: - Tunnel route summary: Get tunnel route by IP description: Fetches routes that contain the given IP address. operationId: tunnel-route-get-tunnel-route-by-ip parameters: - name: ip in: path required: true schema: $ref: '#/components/schemas/tunnel_ip' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' - name: virtual_network_id in: query schema: $ref: '#/components/schemas/tunnel_route_virtual_network_id' responses: 4XX: description: Get tunnel route by IP response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_teamnet_response_single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Get tunnel route by IP response content: application/json: schema: $ref: '#/components/schemas/tunnel_teamnet_response_single' security: - api_email: [] api_key: [] /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}: delete: tags: - Tunnel route summary: Delete a tunnel route (CIDR Endpoint) 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: - name: ip_network_encoded in: path required: true schema: $ref: '#/components/schemas/tunnel_ip_network_encoded' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' - name: virtual_network_id in: query schema: $ref: '#/components/schemas/tunnel_vnet_id' - name: tun_type in: query schema: $ref: '#/components/schemas/tunnel_tunnel_type' - name: tunnel_id in: query schema: $ref: '#/components/schemas/tunnel_tunnel_id' responses: 4XX: description: Delete a tunnel route response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_route_response_single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Delete a tunnel route response content: application/json: schema: $ref: '#/components/schemas/tunnel_route_response_single' deprecated: true security: - api_email: [] api_key: [] patch: tags: - Tunnel route summary: Update a tunnel route (CIDR Endpoint) 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: - name: ip_network_encoded in: path required: true schema: $ref: '#/components/schemas/tunnel_ip_network_encoded' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' responses: 4XX: description: Update a tunnel route response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_route_response_single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Update a tunnel route response content: application/json: schema: $ref: '#/components/schemas/tunnel_route_response_single' deprecated: true security: - api_email: [] api_key: [] post: tags: - Tunnel route summary: Create a tunnel route (CIDR Endpoint) 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: - name: ip_network_encoded in: path required: true schema: $ref: '#/components/schemas/tunnel_ip_network_encoded' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object required: - tunnel_id properties: comment: $ref: '#/components/schemas/tunnel_comment' tunnel_id: $ref: '#/components/schemas/tunnel_tunnel_id' virtual_network_id: $ref: '#/components/schemas/tunnel_route_virtual_network_id' responses: 4XX: description: Create a tunnel route response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_route_response_single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Create a tunnel route response content: application/json: schema: $ref: '#/components/schemas/tunnel_route_response_single' deprecated: true security: - api_email: [] api_key: [] /accounts/{account_id}/teamnet/virtual_networks: get: tags: - Tunnel Virtual Network summary: List virtual networks description: Lists and filters virtual networks in an account. operationId: tunnel-virtual-network-list-virtual-networks parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' - name: name in: query schema: $ref: '#/components/schemas/tunnel_vnet_name' - name: is_default in: query 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. - name: is_deleted in: query schema: description: If `true`, only include deleted virtual networks. If `false`, exclude deleted virtual networks. If empty, all virtual networks will be included. - name: vnet_name in: query schema: $ref: '#/components/schemas/tunnel_vnet_name' - name: vnet_id in: query schema: type: string description: UUID of the virtual network. example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415 readOnly: true maxLength: 36 responses: 4XX: description: List virtual networks response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_vnet_response_collection' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: List virtual networks response content: application/json: schema: $ref: '#/components/schemas/tunnel_vnet_response_collection' security: - api_email: [] api_key: [] post: tags: - Tunnel Virtual Network summary: Create a virtual network description: Adds a new virtual network to an account. operationId: tunnel-virtual-network-create-a-virtual-network parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object required: - name properties: comment: $ref: '#/components/schemas/tunnel_schemas-comment' is_default: $ref: '#/components/schemas/tunnel_is_default_network' name: $ref: '#/components/schemas/tunnel_vnet_name' responses: 4XX: description: Create a virtual network response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_vnet_response_single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Create a virtual network response content: application/json: schema: $ref: '#/components/schemas/tunnel_vnet_response_single' security: - api_email: [] api_key: [] /accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}: delete: tags: - Tunnel Virtual Network summary: Delete a virtual network description: Deletes an existing virtual network. operationId: tunnel-virtual-network-delete-a-virtual-network parameters: - name: virtual_network_id in: path required: true schema: $ref: '#/components/schemas/tunnel_vnet_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a virtual network response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_vnet_response_single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Delete a virtual network response content: application/json: schema: $ref: '#/components/schemas/tunnel_vnet_response_single' security: - api_email: [] api_key: [] patch: tags: - Tunnel Virtual Network summary: Update a virtual network description: Updates an existing virtual network. operationId: tunnel-virtual-network-update-a-virtual-network parameters: - name: virtual_network_id in: path required: true schema: $ref: '#/components/schemas/tunnel_vnet_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object properties: comment: $ref: '#/components/schemas/tunnel_schemas-comment' is_default_network: $ref: '#/components/schemas/tunnel_is_default_network' name: $ref: '#/components/schemas/tunnel_vnet_name' responses: 4XX: description: Update a virtual network response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_vnet_response_single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Update a virtual network response content: application/json: schema: $ref: '#/components/schemas/tunnel_vnet_response_single' security: - api_email: [] api_key: [] /accounts/{account_id}/tunnels: get: tags: - Cloudflare Tunnel summary: List All Tunnels description: Lists and filters all types of Tunnels in an account. operationId: cloudflare-tunnel-list-all-tunnels parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' - name: name in: query schema: type: string description: A user-friendly name for the tunnel. example: blog - name: is_deleted in: query schema: type: boolean description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included. example: true - name: existed_at in: query schema: $ref: '#/components/schemas/tunnel_existed_at' - name: uuid in: query schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: was_active_at in: query schema: type: string format: date-time example: "2009-11-10T23:00:00Z" - name: was_inactive_at in: query schema: type: string format: date-time example: "2009-11-10T23:00:00Z" - name: include_prefix in: query schema: type: string example: vpc1- - name: exclude_prefix in: query schema: type: string example: vpc1- - name: tun_types in: query schema: $ref: '#/components/schemas/tunnel_tunnel_types' - name: per_page in: query schema: $ref: '#/components/schemas/tunnel_per_page' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 responses: 4XX: description: List Tunnels response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel-response-collection' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: List Tunnels response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel-response-collection' security: - api_email: [] api_key: [] post: tags: - Argo Tunnel summary: Create an Argo Tunnel description: Creates a new Argo Tunnel in an account. operationId: argo-tunnel-create-an-argo-tunnel parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object required: - name - tunnel_secret properties: name: $ref: '#/components/schemas/tunnel_tunnel_name' tunnel_secret: description: Sets the password required to run the tunnel. Must be at least 32 bytes and encoded as a base64 string. responses: 4XX: description: Create an Argo Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_legacy-tunnel-response-single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Create an Argo Tunnel response content: application/json: schema: $ref: '#/components/schemas/tunnel_legacy-tunnel-response-single' deprecated: true security: - api_email: [] api_key: [] /accounts/{account_id}/tunnels/{tunnel_id}: delete: tags: - Argo Tunnel summary: Delete an Argo Tunnel description: Deletes an Argo Tunnel from an account. operationId: argo-tunnel-delete-an-argo-tunnel parameters: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object responses: 4XX: description: Delete an Argo Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_legacy-tunnel-response-single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Delete an Argo Tunnel response content: application/json: schema: $ref: '#/components/schemas/tunnel_legacy-tunnel-response-single' deprecated: true security: - api_email: [] api_key: [] get: tags: - Argo Tunnel summary: Get an Argo Tunnel description: Fetches a single Argo Tunnel. operationId: argo-tunnel-get-an-argo-tunnel parameters: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' responses: 4XX: description: Get an Argo Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_legacy-tunnel-response-single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Get an Argo Tunnel response content: application/json: schema: $ref: '#/components/schemas/tunnel_legacy-tunnel-response-single' deprecated: true security: - api_email: [] api_key: [] /accounts/{account_id}/tunnels/{tunnel_id}/connections: delete: tags: - Argo Tunnel summary: Clean up Argo Tunnel connections description: Removes connections that are in a disconnected or pending reconnect state. We recommend running this command after shutting down a tunnel. operationId: argo-tunnel-clean-up-argo-tunnel-connections parameters: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object responses: 4XX: description: Clean up Argo Tunnel connections response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_empty_response' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Clean up Argo Tunnel connections response content: application/json: schema: $ref: '#/components/schemas/tunnel_empty_response' deprecated: true security: - api_email: [] api_key: [] /accounts/{account_id}/vectorize/indexes: get: tags: - VectorizeIndex summary: List Vectorize Indexes description: Returns a list of Vectorize Indexes operationId: vectorize-list-vectorize-indexes parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/vectorize_identifier' responses: 4XX: description: List Vectorize Index Failure Response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/vectorize_api-response-common-failure' "200": description: List Vectorize Index Response content: application/json: schema: allOf: - $ref: '#/components/schemas/vectorize_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/vectorize_create-index-response' security: - api_token: [] - api_email: [] api_key: [] post: tags: - VectorizeIndex summary: Create Vectorize Index description: Creates and returns a new Vectorize Index. operationId: vectorize-create-vectorize-index parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/vectorize_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/vectorize_create-index-request' responses: 4XX: description: Create Vectorize Index Failure Response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/vectorize_api-response-common-failure' "200": description: Create Vectorize Index Response content: application/json: schema: allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - properties: result: $ref: '#/components/schemas/vectorize_create-index-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/vectorize/indexes/{index_name}: delete: tags: - VectorizeIndex summary: Delete Vectorize Index description: Deletes the specified Vectorize Index. operationId: vectorize-delete-vectorize-index parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/vectorize_identifier' - name: index_name in: path required: true schema: $ref: '#/components/schemas/vectorize_index-name' responses: 4XX: description: Delete Vectorize Index Failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/vectorize_api-response-common-failure' "200": description: Delete Vectorize Index Response content: application/json: schema: allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - properties: result: type: object nullable: true security: - api_token: [] - api_email: [] api_key: [] get: tags: - VectorizeIndex summary: Get Vectorize Index description: Returns the specified Vectorize Index. operationId: vectorize-get-vectorize-index parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/vectorize_identifier' - name: index_name in: path required: true schema: $ref: '#/components/schemas/vectorize_index-name' responses: 4XX: description: Get Vectorize Index Failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/vectorize_api-response-common-failure' "200": description: Get Vectorize Index Response content: application/json: schema: allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - properties: result: $ref: '#/components/schemas/vectorize_create-index-response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - VectorizeIndex summary: Update Vectorize Index description: Updates and returns the specified Vectorize Index. operationId: vectorize-update-vectorize-index parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/vectorize_identifier' - name: index_name in: path required: true schema: $ref: '#/components/schemas/vectorize_index-name' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/vectorize_update-index-request' responses: 4XX: description: Update Vectorize Index Failure Response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/vectorize_api-response-common-failure' "200": description: Update Vectorize Index Response content: application/json: schema: allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - properties: result: $ref: '#/components/schemas/vectorize_create-index-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/vectorize/indexes/{index_name}/delete-by-ids: post: tags: - VectorizeIndex summary: Delete Vectors By Identifier description: Delete a set of vectors from an index by their vector identifiers. operationId: vectorize-delete-vectors-by-id parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/vectorize_identifier' - name: index_name in: path required: true schema: $ref: '#/components/schemas/vectorize_index-name' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/vectorize_index-delete-vectors-by-id-request' responses: 4XX: description: Delete Vector Identifiers Failure Response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/vectorize_api-response-common-failure' "200": description: Delete Vector Identifiers Response content: application/json: schema: allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - properties: result: $ref: '#/components/schemas/vectorize_index-delete-vectors-by-id-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/vectorize/indexes/{index_name}/get-by-ids: post: tags: - VectorizeIndex summary: Get Vectors By Identifier description: Get a set of vectors from an index by their vector identifiers. operationId: vectorize-get-vectors-by-id parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/vectorize_identifier' - name: index_name in: path required: true schema: $ref: '#/components/schemas/vectorize_index-name' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/vectorize_index-get-vectors-by-id-request' responses: 4XX: description: Get Vectors By Identifier Failure Response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/vectorize_api-response-common-failure' "200": description: Get Vectors By Identifier Response content: application/json: schema: allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - properties: result: $ref: '#/components/schemas/vectorize_index-get-vectors-by-id-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/vectorize/indexes/{index_name}/insert: post: tags: - VectorizeIndex summary: Insert Vectors description: Inserts vectors into the specified index and returns the count of the vectors successfully inserted. operationId: vectorize-insert-vector parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/vectorize_identifier' - name: index_name in: path required: true schema: $ref: '#/components/schemas/vectorize_index-name' requestBody: required: true content: application/x-ndjson: schema: type: string format: binary description: ndjson file containing vectors to insert. example: '@/path/to/vectors.ndjson' responses: 4XX: description: Insert Vectors Failure Response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/vectorize_api-response-common-failure' "200": description: Insert Vectors Response content: application/json: schema: allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - properties: result: $ref: '#/components/schemas/vectorize_index-insert-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/vectorize/indexes/{index_name}/query: post: tags: - VectorizeIndex summary: Query Vectors description: Finds vectors closest to a given vector in an index. operationId: vectorize-query-vector parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/vectorize_identifier' - name: index_name in: path required: true schema: $ref: '#/components/schemas/vectorize_index-name' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/vectorize_index-query-request' responses: 4XX: description: Query Vectors Failure Response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/vectorize_api-response-common-failure' "200": description: Query Vectors Response content: application/json: schema: allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - properties: result: $ref: '#/components/schemas/vectorize_index-query-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/vectorize/indexes/{index_name}/upsert: post: tags: - VectorizeIndex summary: Upsert Vectors 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-upsert-vector parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/vectorize_identifier' - name: index_name in: path required: true schema: $ref: '#/components/schemas/vectorize_index-name' requestBody: required: true content: application/x-ndjson: schema: type: string format: binary description: ndjson file containing vectors to upsert. example: '@/path/to/vectors.ndjson' responses: 4XX: description: Insert Vectors Failure Response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/vectorize_api-response-common-failure' "200": description: Insert Vectors Response content: application/json: schema: allOf: - $ref: '#/components/schemas/vectorize_api-response-single' - properties: result: $ref: '#/components/schemas/vectorize_index-upsert-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/warp_connector: get: tags: - Cloudflare Tunnel summary: List Warp Connector Tunnels description: Lists and filters Warp Connector Tunnels in an account. operationId: cloudflare-tunnel-list-warp-connector-tunnels parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' - name: name in: query schema: type: string description: A user-friendly name for the tunnel. example: blog - name: is_deleted in: query schema: type: boolean description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included. example: true - name: existed_at in: query schema: $ref: '#/components/schemas/tunnel_existed_at' - name: uuid in: query schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: was_active_at in: query schema: type: string format: date-time example: "2009-11-10T23:00:00Z" - name: was_inactive_at in: query schema: type: string format: date-time example: "2009-11-10T23:00:00Z" - name: include_prefix in: query schema: type: string example: vpc1- - name: exclude_prefix in: query schema: type: string example: vpc1- - name: per_page in: query schema: $ref: '#/components/schemas/tunnel_per_page' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 responses: 4XX: description: List Warp Connector Tunnels response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel-response-collection' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: List Warp Connector Tunnels response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel-response-collection' security: - api_email: [] api_key: [] post: tags: - Cloudflare Tunnel summary: Create a Warp Connector Tunnel description: Creates a new Warp Connector Tunnel in an account. operationId: cloudflare-tunnel-create-a-warp-connector-tunnel parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object required: - name properties: name: $ref: '#/components/schemas/tunnel_tunnel_name' responses: 4XX: description: Create a Warp Connector Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel-response-single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Create a Warp Connector Tunnel response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel-response-single' security: - api_email: [] api_key: [] /accounts/{account_id}/warp_connector/{tunnel_id}: delete: tags: - Cloudflare Tunnel summary: Delete a Warp Connector Tunnel description: Deletes a Warp Connector Tunnel from an account. operationId: cloudflare-tunnel-delete-a-warp-connector-tunnel parameters: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object responses: 4XX: description: Delete a Warp Connector Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel-response-single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Delete a Warp Connector Tunnel response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel-response-single' security: - api_email: [] api_key: [] get: tags: - Cloudflare Tunnel summary: Get a Warp Connector Tunnel description: Fetches a single Warp Connector Tunnel. operationId: cloudflare-tunnel-get-a-warp-connector-tunnel parameters: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' responses: 4XX: description: Get a Warp Connector Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel-response-single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Get a Warp Connector Tunnel response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel-response-single' security: - api_email: [] api_key: [] patch: tags: - Cloudflare Tunnel summary: Update a Warp Connector Tunnel description: Updates an existing Warp Connector Tunnel. operationId: cloudflare-tunnel-update-a-warp-connector-tunnel parameters: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object properties: name: $ref: '#/components/schemas/tunnel_tunnel_name' tunnel_secret: $ref: '#/components/schemas/tunnel_tunnel_secret' responses: 4XX: description: Update a Warp Connector Tunnel response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel-response-single' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Update a Warp Connector Tunnel response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel-response-single' security: - api_email: [] api_key: [] /accounts/{account_id}/warp_connector/{tunnel_id}/token: get: tags: - Cloudflare Tunnel summary: Get a Warp Connector Tunnel token 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: - name: tunnel_id in: path required: true schema: $ref: '#/components/schemas/tunnel_tunnel_id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' responses: 4XX: description: Get a Warp Connector Tunnel token response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel_tunnel_response_token' - $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Get a Warp Connector Tunnel token response content: application/json: schema: $ref: '#/components/schemas/tunnel_tunnel_response_token' security: - api_email: [] api_key: [] /accounts/{account_id}/workers/account-settings: get: tags: - Worker Account Settings summary: Fetch Worker Account Settings description: Fetches Worker account settings for an account. operationId: worker-account-settings-fetch-worker-account-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: Fetch Worker Account Settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_account-settings-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Fetch Worker Account Settings response content: application/json: schema: $ref: '#/components/schemas/workers_account-settings-response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Worker Account Settings summary: Create Worker Account Settings description: Creates Worker account settings for an account. operationId: worker-account-settings-create-worker-account-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: schema: example: '{''default_usage_model'': ''unbound''}' responses: 4XX: description: Create Worker Account Settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_account-settings-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Create Worker Account Settings response content: application/json: schema: $ref: '#/components/schemas/workers_account-settings-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/deployments/by-script/{script_id}: get: tags: - Worker Deployments (Deprecated) summary: List Deployments operationId: worker-deployments-(-deprecated)-list-deployments parameters: - name: script_id in: path required: true schema: $ref: '#/components/schemas/workers_script_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: List Deployments response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_deployments-list-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: List Deployments response content: application/json: schema: $ref: '#/components/schemas/workers_deployments-list-response' deprecated: true security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/deployments/by-script/{script_id}/detail/{deployment_id}: get: tags: - Worker Deployments (Deprecated) summary: Get Deployment Detail operationId: worker-deployments-(-deprecated)-get-deployment-detail parameters: - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/workers_deployment_identifier' - name: script_id in: path required: true schema: $ref: '#/components/schemas/workers_script_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: Get Deployment Detail response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_deployments-single-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Get Deployment Detail response content: application/json: schema: $ref: '#/components/schemas/workers_deployments-single-response' deprecated: true security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/dispatch/namespaces: get: tags: - Workers for Platforms summary: List dispatch namespaces description: Fetch a list of Workers for Platforms namespaces. operationId: namespace-worker-list parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: Failure to get list of Workers for Platforms namespaces. content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Fetch a list of Workers for Platforms namespaces. content: application/json: schema: $ref: '#/components/schemas/workers_namespace-list-response' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Workers for Platforms summary: Create dispatch namespace description: Create a new Workers for Platforms namespace. operationId: namespace-worker-create parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the dispatch namespace example: my-dispatch-namespace responses: 4XX: description: Failure to get list of Workers for Platforms namespaces. content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Fetch a list of Workers for Platforms namespaces. content: application/json: schema: $ref: '#/components/schemas/workers_namespace-single-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}: delete: tags: - Workers for Platforms summary: Delete dispatch namespace description: Delete a Workers for Platforms namespace. operationId: namespace-worker-delete-namespace parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' responses: 4XX: description: Failure to delete Workers for Platforms namespace. content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Delete a Workers for Platforms namespace. content: application/json: schema: $ref: '#/components/schemas/workers_namespace-delete-response' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Workers for Platforms summary: Get dispatch namespace description: Get a Workers for Platforms namespace. operationId: namespace-worker-get-namespace parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' responses: 4XX: description: Failure to get Workers for Platforms namespace. content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Get a Workers for Platforms namespace. content: application/json: schema: $ref: '#/components/schemas/workers_namespace-single-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}: delete: tags: - Workers for Platforms summary: Delete Worker 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: force in: query 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. schema: type: boolean requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Worker response failure content: application/json: {} "200": description: Delete Worker response content: application/json: {} security: - api_token: [] - api_email: [] api_key: [] get: tags: - Workers for Platforms summary: Worker Details description: Fetch information about a script uploaded to a Workers for Platforms namespace. operationId: namespace-worker-script-worker-details parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' responses: 4XX: description: Worker Details Failure (Workers for Platforms) content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Worker Details Response (Workers for Platforms) content: application/json: schema: $ref: '#/components/schemas/workers_namespace-script-response-single' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Workers for Platforms summary: Upload Worker Module description: 'Upload a worker module to a Workers for Platforms namespace. You can find an example of the metadata on our docs: https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/reference/metadata/' operationId: namespace-worker-script-upload-worker-module parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path 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: [] /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/bindings: get: tags: - Workers for Platforms summary: Get Script Bindings description: Fetch script bindings from a script uploaded to a Workers for Platforms namespace. operationId: namespace-worker-get-script-bindings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' responses: 4XX: description: Fetch script bindings failure (Workers for Platforms) content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Fetch script bindings (Workers for Platforms) content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: $ref: '#/components/schemas/workers_bindings' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content: get: tags: - Workers for Platforms summary: Get Script Content description: Fetch script content from a script uploaded to a Workers for Platforms namespace. operationId: namespace-worker-get-script-content parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' responses: 4XX: description: Get script content failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Get script content content: string: schema: example: | export default { fetch(req) { return new Response("Hello, World!") } } security: - api_token: [] - api_email: [] api_key: [] put: tags: - Workers for Platforms summary: Put Script Content description: Put script content for a script uploaded to a Workers for Platforms namespace. operationId: namespace-worker-put-script-content parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: CF-WORKER-BODY-PART in: header description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part. schema: type: string - name: CF-WORKER-MAIN-MODULE-PART in: header description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part. schema: type: string requestBody: required: true content: multipart/form-data: schema: type: object properties: : type: array 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: type: string format: binary metadata: type: object description: JSON encoded metadata about the uploaded parts and Worker configuration. properties: body_part: type: string 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 main_module: type: string 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 encoding: : contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream, application/source-map responses: 4XX: description: Put script content failure (Workers for Platforms) content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Put script content (Workers for Platforms) content: application/json: schema: $ref: '#/components/schemas/workers_script-response-single' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets: get: tags: - Workers for Platforms summary: Get Script Secrets description: Fetch secrets from a script uploaded to a Workers for Platforms namespace. operationId: namespace-worker-get-script-secrets parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' responses: 4XX: description: Fetch script secrets failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Fetch script secrets content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/workers_secret-response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Workers for Platforms summary: Put Script Secrets description: Put secrets to a script uploaded to a Workers for Platforms namespace. operationId: namespace-worker-put-script-secrets parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers_secret' responses: 4XX: description: Fetch script bindings failure (Workers for Platforms) content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Fetch script bindings (Workers for Platforms) content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: $ref: '#/components/schemas/workers_secret-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings: get: tags: - Workers for Platforms summary: Get Script Settings description: Get script settings from a script uploaded to a Workers for Platforms namespace. operationId: namespace-worker-get-script-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' responses: 4XX: description: Fetch script settings failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Fetch script settings content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: $ref: '#/components/schemas/workers_script-and-version-settings-item' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Workers for Platforms summary: Patch Script Settings description: Patch script metadata, such as bindings operationId: namespace-worker-patch-script-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' requestBody: required: true content: multipart/form-data: schema: type: object properties: settings: $ref: '#/components/schemas/workers_script-and-version-settings-item' responses: 4XX: description: Patch script settings failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Patch script settings content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: $ref: '#/components/schemas/workers_script-and-version-settings-item' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags: get: tags: - Workers for Platforms summary: Get Script Tags description: Fetch tags from a script uploaded to a Workers for Platforms namespace. operationId: namespace-worker-get-script-tags parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' responses: 4XX: description: Fetch script tags failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Fetch script tags content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: array example: - free - customer items: $ref: '#/components/schemas/workers_tag' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Workers for Platforms summary: Put Script Tags description: Put script tags for a script uploaded to a Workers for Platforms namespace. operationId: namespace-worker-put-script-tags parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers_tags' responses: 4XX: description: Fetch script tags failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Fetch script tags content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: array example: - my-tag items: $ref: '#/components/schemas/workers_tag' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags/{tag}: delete: tags: - Workers for Platforms summary: Delete Script Tag description: Delete script tag for a script uploaded to a Workers for Platforms namespace. operationId: namespace-worker-delete-script-tag parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: tag in: path required: true schema: $ref: '#/components/schemas/workers_tag' responses: 4XX: description: Delete script tag failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Delete script tag content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: object enum: - null nullable: true security: - api_token: [] - api_email: [] api_key: [] put: tags: - Workers for Platforms summary: Put Script Tag description: Put a single tag on a script uploaded to a Workers for Platforms namespace. operationId: namespace-worker-put-script-tag parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: dispatch_namespace in: path required: true schema: $ref: '#/components/schemas/workers_dispatch_namespace_name' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: tag in: path required: true schema: $ref: '#/components/schemas/workers_tag' responses: 4XX: description: Put script tag failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Put script tag content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: type: object enum: - null nullable: true security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/domains: get: tags: - Worker Domain summary: List Domains description: Lists all Worker Domains for an account. operationId: worker-domain-list-domains parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_account_identifier' - name: zone_name in: query schema: $ref: '#/components/schemas/workers_zone_name' - name: service in: query schema: $ref: '#/components/schemas/workers_schemas-service' - name: zone_id in: query schema: $ref: '#/components/schemas/workers_zone_identifier' - name: hostname in: query schema: type: string description: Hostname of the Worker Domain. example: foo.example.com - name: environment in: query schema: type: string description: Worker environment associated with the zone and hostname. example: production responses: 4XX: description: List Domains response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_domain-response-collection' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: List Domains response content: application/json: schema: $ref: '#/components/schemas/workers_domain-response-collection' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Worker Domain summary: Attach to Domain description: Attaches a Worker to a zone and hostname. operationId: worker-domain-attach-to-domain parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_account_identifier' requestBody: required: true content: application/json: schema: type: object required: - zone_id - hostname - service - environment 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' responses: 4XX: description: Attach to Domain response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_domain-response-single' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Attach to Domain response content: application/json: schema: $ref: '#/components/schemas/workers_domain-response-single' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/domains/{domain_id}: delete: tags: - Worker Domain summary: Detach from Domain description: Detaches a Worker from a zone and hostname. operationId: worker-domain-detach-from-domain parameters: - name: domain_id in: path required: true schema: $ref: '#/components/schemas/workers_domain_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Detach from Domain response failure content: application/json: {} "200": description: Detach from Domain response content: application/json: {} security: - api_token: [] - api_email: [] api_key: [] get: tags: - Worker Domain summary: Get a Domain description: Gets a Worker domain. operationId: worker-domain-get-a-domain parameters: - name: domain_id in: path required: true schema: $ref: '#/components/schemas/workers_domain_identifier' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_account_identifier' responses: 4XX: description: Get a Domain response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_domain-response-single' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Get a Domain response content: application/json: schema: $ref: '#/components/schemas/workers_domain-response-single' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/durable_objects/namespaces: get: tags: - Durable Objects Namespace summary: List Namespaces description: Returns the Durable Object namespaces owned by an account. operationId: durable-objects-namespace-list-namespaces parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: List Namespaces response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/workers_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/workers_namespace' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: List Namespaces response content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/workers_namespace' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/durable_objects/namespaces/{id}/objects: get: tags: - Durable Objects Namespace summary: List Objects description: Returns the Durable Objects in a given namespace. operationId: durable-objects-namespace-list-objects parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/workers_schemas-id' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: limit in: query schema: type: number 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. default: 1000 minimum: 10 maximum: 10000 - name: cursor in: query schema: type: string description: Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure. example: AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc responses: 4XX: description: List Objects response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/workers_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/workers_object' result_info: properties: count: type: number description: Total results returned based on your list parameters. example: 1 cursor: $ref: '#/components/schemas/workers_cursor' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: List Objects response content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-collection' - type: object properties: result: type: array items: $ref: '#/components/schemas/workers_object' result_info: properties: count: type: number description: Total results returned based on your list parameters. example: 1 cursor: $ref: '#/components/schemas/workers_cursor' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts: get: tags: - Worker Script summary: List Workers description: Fetch a list of uploaded workers. operationId: worker-script-list-workers parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: List Workers response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_script-response-collection' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: List Workers response content: application/json: schema: $ref: '#/components/schemas/workers_script-response-collection' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts/{script_name}: delete: tags: - Worker Script summary: Delete Worker description: Delete your worker. This call has no response body on a successful delete. operationId: worker-script-delete-worker parameters: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: force in: query 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. schema: type: boolean requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Worker response failure content: application/json: {} "200": description: Delete Worker response content: application/json: {} security: - api_token: [] - api_email: [] api_key: [] get: tags: - Worker Script summary: Download Worker description: Fetch raw script content for your worker. Note this is the original script content, not JSON encoded. operationId: worker-script-download-worker parameters: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: Download Worker response failure content: undefined: schema: example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) }) "200": description: Download Worker response content: undefined: schema: example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) }) security: - api_token: [] - api_email: [] api_key: [] put: tags: - Worker Script summary: Upload Worker Module description: Upload a worker module. operationId: worker-script-upload-worker-module parameters: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: rollback_to in: query 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/). schema: $ref: '#/components/schemas/workers_uuid' requestBody: $ref: '#/components/requestBodies/workers_script_upload' responses: 4XX: description: Upload Worker Module response failure content: application/json: schema: allOf: - example: errors: [] messages: [] result: created_on: "2022-05-05T05:15:11.602148Z" etag: 777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1 handlers: - fetch id: this-is_my_script-01 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' "200": description: Upload Worker Module response content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_script-response-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 tail_consumers: - environment: production service: my-log-consumer usage_model: bundled success: true security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts/{script_name}/content: put: tags: - Worker Script summary: Put script content description: Put script content without touching config or metadata operationId: worker-script-put-content parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: CF-WORKER-BODY-PART in: header description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part. schema: type: string - name: CF-WORKER-MAIN-MODULE-PART in: header description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part. schema: type: string requestBody: required: true content: multipart/form-data: schema: type: object properties: : type: array 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: type: string format: binary metadata: type: object description: JSON encoded metadata about the uploaded parts and Worker configuration. properties: body_part: type: string 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 main_module: type: string 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 encoding: : contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream, application/source-map responses: 4XX: description: Put script content failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Put script content content: application/json: schema: $ref: '#/components/schemas/workers_script-response-single' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts/{script_name}/content/v2: get: tags: - Worker Script summary: Get script content description: Fetch script content only operationId: worker-script-get-content parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' responses: 4XX: description: Fetch script content failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Fetch script content content: string: schema: example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) }) security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts/{script_name}/deployments: get: tags: - Worker Deployments summary: List Deployments description: List of Worker Deployments. The first deployment in the list is the latest deployment actively serving traffic. operationId: worker-deployments-list-deployments parameters: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_schemas-script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: List Deployments response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_schemas-deployments-list-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: List Deployments response content: application/json: schema: $ref: '#/components/schemas/workers_schemas-deployments-list-response' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Worker Deployments summary: Create Deployment 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: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_schemas-script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers_deployments-create-body' responses: 4XX: description: Create Deployment response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_schemas-deployments-single-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Create Deployment response content: application/json: schema: $ref: '#/components/schemas/workers_schemas-deployments-single-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts/{script_name}/schedules: get: tags: - Worker Cron Trigger summary: Get Cron Triggers description: Fetches Cron Triggers for a Worker. operationId: worker-cron-trigger-get-cron-triggers parameters: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: Get Cron Triggers response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_cron-trigger-response-collection' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Get Cron Triggers response content: application/json: schema: $ref: '#/components/schemas/workers_cron-trigger-response-collection' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Worker Cron Trigger summary: Update Cron Triggers description: Updates Cron Triggers for a Worker. operationId: worker-cron-trigger-update-cron-triggers parameters: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: schema: example: '[{''cron'': ''*/30 * * * *''}]' responses: 4XX: description: Update Cron Triggers response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_cron-trigger-response-collection' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Update Cron Triggers response content: application/json: schema: $ref: '#/components/schemas/workers_cron-trigger-response-collection' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts/{script_name}/script-settings: get: tags: - Worker Script summary: Get Script Settings 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' responses: 4XX: description: Fetch script settings failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Fetch script settings content: application/json: schema: $ref: '#/components/schemas/workers_script-settings-response' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Worker Script summary: Patch Script Settings 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: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers_script-settings-item' responses: 4XX: description: Patch script settings failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Patch script settings content: application/json: schema: $ref: '#/components/schemas/workers_script-settings-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts/{script_name}/settings: get: tags: - Worker Script summary: Get Settings description: Get metadata and config, such as bindings or usage model operationId: worker-script-get-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' responses: 4XX: description: Fetch settings failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Fetch settings content: application/json: schema: $ref: '#/components/schemas/workers_script-and-version-settings-response' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Worker Script summary: Patch Settings description: Patch metadata or config, such as bindings or usage model operationId: worker-script-patch-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' requestBody: required: true content: multipart/form-data: schema: type: object properties: settings: $ref: '#/components/schemas/workers_script-and-version-settings-item' responses: 4XX: description: Patch settings failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Patch settings content: application/json: schema: $ref: '#/components/schemas/workers_script-and-version-settings-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts/{script_name}/tails: get: tags: - Worker Tail Logs summary: List Tails description: Get list of tails currently deployed on a Worker. operationId: worker-tail-logs-list-tails parameters: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: List Tails response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_tail-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: List Tails response content: application/json: schema: $ref: '#/components/schemas/workers_tail-response' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Worker Tail Logs summary: Start Tail description: Starts a tail that receives logs and exception from a Worker. operationId: worker-tail-logs-start-tail parameters: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Start Tail response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_tail-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Start Tail response content: application/json: schema: $ref: '#/components/schemas/workers_tail-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts/{script_name}/tails/{id}: delete: tags: - Worker Tail Logs summary: Delete Tail description: Deletes a tail from a Worker. operationId: worker-tail-logs-delete-tail parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/workers_id' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Tail response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-common' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Delete Tail response content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts/{script_name}/usage-model: get: tags: - Worker Script summary: Fetch Usage Model description: Fetches the Usage Model for a given Worker. operationId: worker-script-fetch-usage-model parameters: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: Fetch Usage Model response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_usage-model-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Fetch Usage Model response content: application/json: schema: $ref: '#/components/schemas/workers_usage-model-response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Worker Script summary: Update Usage Model description: Updates the Usage Model for a given Worker. Requires a Workers Paid subscription. operationId: worker-script-update-usage-model parameters: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: schema: example: '{''usage_model'': ''unbound''}' responses: 4XX: description: Update Usage Model response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_usage-model-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Update Usage Model response content: application/json: schema: $ref: '#/components/schemas/workers_usage-model-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts/{script_name}/versions: get: tags: - Worker Versions summary: List Versions description: List of Worker Versions. The first version in the list is the latest version. operationId: worker-versions-list-versions parameters: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_schemas-script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: List Versions response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_versions-list-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: List Versions response content: application/json: schema: $ref: '#/components/schemas/workers_versions-list-response' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Worker Versions summary: Upload Version description: Upload a Worker Version without deploying to Cloudflare's network. operationId: worker-versions-upload-version parameters: - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_schemas-script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: $ref: '#/components/requestBodies/workers_version-post' responses: 4XX: description: Upload Version response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_versions-single-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Upload Version response content: application/json: schema: $ref: '#/components/schemas/workers_versions-single-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/scripts/{script_name}/versions/{version_id}: get: tags: - Worker Versions summary: Get Version Detail operationId: worker-versions-get-version-detail parameters: - name: version_id in: path required: true schema: $ref: '#/components/schemas/workers_version_identifier' - name: script_name in: path required: true schema: $ref: '#/components/schemas/workers_schemas-script_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: Get Version Detail response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_versions-single-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Get Version Detail response content: application/json: schema: $ref: '#/components/schemas/workers_versions-single-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/content: get: tags: - Worker Environment summary: Get script content description: Get script content from a worker with an environment operationId: worker-environment-get-script-content parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: service_name in: path required: true schema: $ref: '#/components/schemas/workers_service' - name: environment_name in: path required: true schema: $ref: '#/components/schemas/workers_environment' responses: 4XX: description: Get script content failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Get script content content: string: schema: example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) }) security: - api_token: [] - api_email: [] api_key: [] put: tags: - Worker Environment summary: Put script content description: Put script content from a worker with an environment operationId: worker-environment-put-script-content parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: service_name in: path required: true schema: $ref: '#/components/schemas/workers_service' - name: environment_name in: path required: true schema: $ref: '#/components/schemas/workers_environment' - name: CF-WORKER-BODY-PART in: header description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part. schema: type: string - name: CF-WORKER-MAIN-MODULE-PART in: header description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part. schema: type: string requestBody: required: true content: multipart/form-data: schema: type: object properties: : type: array 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: type: string format: binary metadata: type: object description: JSON encoded metadata about the uploaded parts and Worker configuration. properties: body_part: type: string 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 main_module: type: string 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 encoding: : contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream, application/source-map responses: 4XX: description: Put script content failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Put script content content: application/json: schema: $ref: '#/components/schemas/workers_script-response-single' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings: get: tags: - Worker Environment summary: Get Script Settings description: Get script settings from a worker with an environment operationId: worker-script-environment-get-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: service_name in: path required: true schema: $ref: '#/components/schemas/workers_service' - name: environment_name in: path required: true schema: $ref: '#/components/schemas/workers_environment' responses: 4XX: description: Fetch script settings failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Fetch script settings content: application/json: schema: $ref: '#/components/schemas/workers_script-settings-response' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Worker Environment summary: Patch Script Settings description: Patch script metadata, such as bindings operationId: worker-script-environment-patch-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: service_name in: path required: true schema: $ref: '#/components/schemas/workers_service' - name: environment_name in: path required: true schema: $ref: '#/components/schemas/workers_environment' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers_script-settings-response' responses: 4XX: description: Patch script settings failure content: application/json: schema: $ref: '#/components/schemas/workers_api-response-common' "200": description: Patch script settings content: application/json: schema: $ref: '#/components/schemas/workers_script-settings-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/workers/subdomain: get: tags: - Worker Subdomain summary: Get Subdomain description: Returns a Workers subdomain for an account. operationId: worker-subdomain-get-subdomain parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: Get Subdomain response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_subdomain-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Get Subdomain response content: application/json: schema: $ref: '#/components/schemas/workers_subdomain-response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Worker Subdomain summary: Create Subdomain description: Creates a Workers subdomain for an account. operationId: worker-subdomain-create-subdomain parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: schema: example: '{''subdomain'': ''example-subdomain''}' responses: 4XX: description: Create Subdomain response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_subdomain-response' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Create Subdomain response content: application/json: schema: $ref: '#/components/schemas/workers_subdomain-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_id}/zerotrust/connectivity_settings: get: tags: - Zero Trust Connectivity Settings summary: Get Zero Trust Connectivity Settings description: Gets the Zero Trust Connectivity Settings for the given account. operationId: zero-trust-accounts-get-connectivity-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' responses: 4XX: description: Get Zero Trust Connectivity Settings response failure content: application/json: schema: $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Get Zero Trust Connectivity Settings response content: application/json: schema: $ref: '#/components/schemas/tunnel_zero_trust_connectivity_settings_response' security: - api_email: [] api_key: [] patch: tags: - Zero Trust Connectivity Settings summary: Updates the Zero Trust Connectivity Settings description: Updates the Zero Trust Connectivity Settings for the given account. operationId: zero-trust-accounts-patch-connectivity-settings parameters: - name: account_id in: path required: true schema: $ref: '#/components/schemas/tunnel_cf_account_id' requestBody: required: true content: application/json: schema: type: object properties: icmp_proxy_enabled: $ref: '#/components/schemas/tunnel_icmp_proxy_enabled' offramp_warp_enabled: $ref: '#/components/schemas/tunnel_offramp_warp_enabled' responses: 4XX: description: Update Zero Trust Connectivity Settings response failure content: application/json: schema: $ref: '#/components/schemas/tunnel_api-response-common-failure' "200": description: Update Zero Trust Connectivity Settings response content: application/json: schema: $ref: '#/components/schemas/tunnel_zero_trust_connectivity_settings_response' security: - api_email: [] api_key: [] /accounts/{account_identifier}/billing/profile: get: tags: - Account Billing Profile summary: Billing Profile Details description: Gets the current billing profile for the account. operationId: account-billing-profile-(-deprecated)-billing-profile-details parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_account_identifier' responses: 4XX: description: Billing Profile Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/bill-subs-api_billing_response_single' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' "200": description: Billing Profile Details response content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_billing_response_single' deprecated: true security: - api_email: [] api_key: [] api_token: [] /accounts/{account_identifier}/cloudforce-one/requests: post: tags: - Request for Information (RFI) summary: List Requests operationId: cloudforce-one-request-list parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_request-list' responses: 4XX: description: Create response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: List requests response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/cloudforce-one_request-list-item' security: - api_email: [] api_key: [] /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}: delete: tags: - Request for Information (RFI) summary: Delete a Request operationId: cloudforce-one-request-delete parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' - name: request_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_uuid' responses: 4XX: description: Create response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Delete a request response content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common' security: - api_email: [] api_key: [] get: tags: - Request for Information (RFI) summary: Get a Request operationId: cloudforce-one-request-get parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' - name: request_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_uuid' responses: 4XX: description: Get a request response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Get a request response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: $ref: '#/components/schemas/cloudforce-one_request-item' security: - api_email: [] api_key: [] put: tags: - Request for Information (RFI) summary: Update a Request 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: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' - name: request_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_uuid' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_request-edit' responses: 4XX: description: Update request response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Update a request response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: $ref: '#/components/schemas/cloudforce-one_request-item' security: - api_email: [] api_key: [] /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message: post: tags: - Request for Information (RFI) summary: List Request Messages operationId: cloudforce-one-request-message-list parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' - name: request_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_uuid' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_request-message-list' responses: 4XX: description: List requests message response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: List request messages response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/cloudforce-one_request-message-item' security: - api_email: [] api_key: [] /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/{message_identifer}: delete: tags: - Request for Information (RFI) summary: Delete a Request Message operationId: cloudforce-one-request-message-delete parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' - name: request_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_uuid' - name: message_identifer in: path required: true schema: type: integer responses: 4XX: description: Delete request message response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Delete a request message response content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common' security: - api_email: [] api_key: [] put: tags: - Request for Information (RFI) summary: Update a Request Message operationId: cloudforce-one-request-message-update parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' - name: request_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_uuid' - name: message_identifer in: path required: true schema: type: integer requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_request-edit' responses: 4XX: description: Update request message response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Update a request messeage response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: $ref: '#/components/schemas/cloudforce-one_request-message-item' security: - api_email: [] api_key: [] /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/new: post: tags: - Request for Information (RFI) summary: Create a New Request Message 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-message-new parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' - name: request_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_uuid' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_request-message-edit' responses: 4XX: description: Create response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Create request response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: $ref: '#/components/schemas/cloudforce-one_request-message-item' security: - api_email: [] api_key: [] /accounts/{account_identifier}/cloudforce-one/requests/constants: get: tags: - Request for Information (RFI) summary: Get Request Priority, Status, and TLP constants operationId: cloudforce-one-request-constants parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' responses: 4XX: description: Get request constants response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Get request constants response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: $ref: '#/components/schemas/cloudforce-one_request-constants' security: - api_email: [] api_key: [] /accounts/{account_identifier}/cloudforce-one/requests/new: post: tags: - Request for Information (RFI) summary: Create a New Request 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: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_request-edit' responses: 4XX: description: Create response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Create request response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: $ref: '#/components/schemas/cloudforce-one_request-item' security: - api_email: [] api_key: [] /accounts/{account_identifier}/cloudforce-one/requests/priority: post: tags: - Priority Intelligence Requirements (PIR) summary: List Priority Intelligence Requirements operationId: cloudforce-one-priority-list parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_priority-list' responses: 4XX: description: List priorities response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: List priorities response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/cloudforce-one_priority-item' security: - api_email: [] api_key: [] /accounts/{account_identifier}/cloudforce-one/requests/priority/{priority_identifer}: delete: tags: - Priority Intelligence Requirements (PIR) summary: Delete a Priority Intelligence Report operationId: cloudforce-one-priority-delete parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' - name: priority_identifer in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_uuid' responses: 4XX: description: Delete a priority response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Delete a priority response content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common' security: - api_email: [] api_key: [] get: tags: - Priority Intelligence Requirements (PIR) summary: Get a Priority Intelligence Requirement operationId: cloudforce-one-priority-get parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' - name: priority_identifer in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_uuid' responses: 4XX: description: Get a priority response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Get a priority response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: $ref: '#/components/schemas/cloudforce-one_request-item' security: - api_email: [] api_key: [] put: tags: - Priority Intelligence Requirements (PIR) summary: Update a Priority Intelligence Requirement operationId: cloudforce-one-priority-update parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' - name: priority_identifer in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_uuid' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_priority-edit' responses: 4XX: description: Update a priority response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Update a priority response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: $ref: '#/components/schemas/cloudforce-one_request-item' security: - api_email: [] api_key: [] /accounts/{account_identifier}/cloudforce-one/requests/priority/new: post: tags: - Priority Intelligence Requirements (PIR) summary: Create a New Priority Requirement operationId: cloudforce-one-priority-new parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_priority-edit' responses: 4XX: description: Create priority response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Create priority response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: $ref: '#/components/schemas/cloudforce-one_priority-item' security: - api_email: [] api_key: [] /accounts/{account_identifier}/cloudforce-one/requests/priority/quota: get: tags: - Priority Intelligence Requirements (PIR) summary: Get Priority Intelligence Requirement Quota operationId: cloudforce-one-priority-quota parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' responses: 4XX: description: Get priority quota response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Get priority quota response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: $ref: '#/components/schemas/cloudforce-one_quota' security: - api_email: [] api_key: [] /accounts/{account_identifier}/cloudforce-one/requests/quota: get: tags: - Request for Information (RFI) summary: Get Request Quota operationId: cloudforce-one-request-quota parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' responses: 4XX: description: Get request quota response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Get request quota response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: $ref: '#/components/schemas/cloudforce-one_quota' security: - api_email: [] api_key: [] /accounts/{account_identifier}/cloudforce-one/requests/types: get: tags: - Request for Information (RFI) summary: Get Request Types operationId: cloudforce-one-request-types parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/cloudforce-one_identifier' responses: 4XX: description: Get request types response failure content: application/json: schema: $ref: '#/components/schemas/cloudforce-one_api-response-common-failure' "200": description: Get request types response content: application/json: schema: allOf: - $ref: '#/components/schemas/cloudforce-one_api-response-common' - properties: result: $ref: '#/components/schemas/cloudforce-one_request-types' security: - api_email: [] api_key: [] /accounts/{account_identifier}/custom_pages: get: tags: - Custom pages for an account summary: List custom pages description: Fetches all the custom pages at the account level. operationId: custom-pages-for-an-account-list-custom-pages parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/custom-pages_identifier' responses: 4xx: description: List custom pages response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/custom-pages_custom_pages_response_collection' - $ref: '#/components/schemas/custom-pages_api-response-common-failure' "200": description: List custom pages response content: application/json: schema: $ref: '#/components/schemas/custom-pages_custom_pages_response_collection' security: - api_email: [] api_key: [] - api_token: [] /accounts/{account_identifier}/custom_pages/{identifier}: get: tags: - Custom pages for an account summary: Get a custom page description: Fetches the details of a custom page. operationId: custom-pages-for-an-account-get-a-custom-page parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/custom-pages_identifier' - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/custom-pages_identifier' responses: 4xx: description: Get a custom page response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/custom-pages_custom_pages_response_single' - $ref: '#/components/schemas/custom-pages_api-response-common-failure' "200": description: Get a custom page response content: application/json: schema: $ref: '#/components/schemas/custom-pages_custom_pages_response_single' security: - api_email: [] api_key: [] - api_token: [] put: tags: - Custom pages for an account summary: Update a custom page description: Updates the configuration of an existing custom page. operationId: custom-pages-for-an-account-update-a-custom-page parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/custom-pages_identifier' - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/custom-pages_identifier' requestBody: required: true content: application/json: schema: required: - url - state properties: state: $ref: '#/components/schemas/custom-pages_state' url: $ref: '#/components/schemas/custom-pages_url' responses: 4xx: description: Update a custom page response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/custom-pages_custom_pages_response_single' - $ref: '#/components/schemas/custom-pages_api-response-common-failure' "200": description: Update a custom page response content: application/json: schema: $ref: '#/components/schemas/custom-pages_custom_pages_response_single' security: - api_email: [] api_key: [] - api_token: [] /accounts/{account_identifier}/d1/database/{database_identifier}: delete: tags: - D1 summary: Delete D1 Database description: Deletes the specified D1 database. operationId: cloudflare-d1-delete-database parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/d1_account-identifier' - name: database_identifier in: path required: true schema: $ref: '#/components/schemas/d1_database-identifier' responses: 4XX: description: Delete D1 database response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/d1_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/d1_api-response-common-failure' "200": description: Delete D1 database response content: application/json: schema: allOf: - $ref: '#/components/schemas/d1_api-response-single' - properties: result: type: object nullable: true security: - api_token: [] - api_email: [] api_key: [] get: tags: - D1 summary: Get D1 Database description: Returns the specified D1 database. operationId: cloudflare-d1-get-database parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/d1_account-identifier' - name: database_identifier in: path required: true schema: $ref: '#/components/schemas/d1_database-identifier' responses: 4XX: description: Database details response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/d1_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/d1_api-response-common-failure' "200": description: Database details response content: application/json: schema: allOf: - $ref: '#/components/schemas/d1_api-response-single' - properties: result: $ref: '#/components/schemas/d1_database-details-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_identifier}/d1/database/{database_identifier}/query: post: tags: - D1 summary: Query D1 Database description: Returns the query result. operationId: cloudflare-d1-query-database parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/d1_account-identifier' - name: database_identifier in: path required: true schema: $ref: '#/components/schemas/d1_database-identifier' requestBody: required: true content: application/json: schema: type: object required: - sql properties: params: $ref: '#/components/schemas/d1_params' sql: $ref: '#/components/schemas/d1_sql' responses: 4XX: description: Query response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/d1_api-response-single' - type: object properties: result: type: object nullable: true - $ref: '#/components/schemas/d1_api-response-common-failure' "200": description: Query response content: application/json: schema: allOf: - $ref: '#/components/schemas/d1_api-response-single' - properties: result: type: array items: $ref: '#/components/schemas/d1_query-result-response' security: - api_token: [] - api_email: [] api_key: [] /accounts/{account_identifier}/email/routing/addresses: get: tags: - Email Routing destination addresses summary: List destination addresses description: Lists existing destination addresses. operationId: email-routing-destination-addresses-list-destination-addresses parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Maximum number of results per page. default: 20 minimum: 5 maximum: 50 - name: direction in: query schema: type: string description: Sorts results in an ascending or descending order. enum: - asc - desc default: asc example: asc - name: verified in: query schema: type: boolean description: Filter by verified destination addresses. enum: - true - false default: true example: true responses: "200": description: List destination addresses response content: application/json: schema: $ref: '#/components/schemas/email_destination_addresses_response_collection' security: - api_email: [] api_key: [] post: tags: - Email Routing destination addresses summary: Create a destination address description: Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used. operationId: email-routing-destination-addresses-create-a-destination-address parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/email_create_destination_address_properties' responses: "200": description: Create a destination address response content: application/json: schema: $ref: '#/components/schemas/email_destination_address_response_single' security: - api_email: [] api_key: [] /accounts/{account_identifier}/email/routing/addresses/{destination_address_identifier}: delete: tags: - Email Routing destination addresses summary: Delete destination address description: Deletes a specific destination address. operationId: email-routing-destination-addresses-delete-destination-address parameters: - name: destination_address_identifier in: path required: true schema: $ref: '#/components/schemas/email_destination_address_identifier' - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' responses: "200": description: Delete destination address response content: application/json: schema: $ref: '#/components/schemas/email_destination_address_response_single' security: - api_email: [] api_key: [] get: tags: - Email Routing destination addresses summary: Get a destination address description: Gets information for a specific destination email already created. operationId: email-routing-destination-addresses-get-a-destination-address parameters: - name: destination_address_identifier in: path required: true schema: $ref: '#/components/schemas/email_destination_address_identifier' - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' responses: "200": description: Get a destination address response content: application/json: schema: $ref: '#/components/schemas/email_destination_address_response_single' security: - api_email: [] api_key: [] /accounts/{account_identifier}/firewall/access_rules/rules: get: tags: - IP Access rules for an account summary: List IP Access rules description: Fetches IP Access rules of an account. These rules apply to all the zones in the account. You can filter the results using several optional parameters. operationId: ip-access-rules-for-an-account-list-ip-access-rules parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_account_identifier' - name: filters in: query schema: $ref: '#/components/schemas/firewall_filters' - name: egs-pagination.json in: query schema: $ref: '#/components/schemas/firewall_egs-pagination' - name: page in: query schema: type: number description: Requested page within paginated list of results. example: 1 - name: per_page in: query schema: type: number description: Maximum number of results requested. example: 20 - name: order in: query schema: type: string description: The field used to sort returned rules. enum: - configuration.target - configuration.value - mode example: mode - name: direction in: query schema: type: string description: The direction used to sort returned rules. enum: - asc - desc example: desc responses: 4XX: description: List IP Access rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_response_collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List IP Access rules response content: application/json: schema: $ref: '#/components/schemas/firewall_response_collection' security: - api_email: [] api_key: [] post: tags: - IP Access rules for an account summary: Create an IP Access rule description: |- Creates a new IP Access rule for an account. The rule will apply to all zones in the account. Note: To create an IP Access rule that applies to a single zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints. operationId: ip-access-rules-for-an-account-create-an-ip-access-rule parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_account_identifier' requestBody: required: true content: application/json: schema: required: - mode - configuration properties: configuration: $ref: '#/components/schemas/firewall_configuration' mode: $ref: '#/components/schemas/firewall_schemas-mode' notes: $ref: '#/components/schemas/firewall_notes' responses: 4XX: description: Create an IP Access rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Create an IP Access rule response content: application/json: schema: $ref: '#/components/schemas/firewall_response_single' security: - api_email: [] api_key: [] /accounts/{account_identifier}/firewall/access_rules/rules/{identifier}: delete: tags: - IP Access rules for an account summary: Delete an IP Access rule description: |- Deletes an existing IP Access rule defined at the account level. Note: This operation will affect all zones in the account. operationId: ip-access-rules-for-an-account-delete-an-ip-access-rule parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/firewall_components-schemas-identifier' - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_account_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete an IP Access rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_api-response-single-id' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Delete an IP Access rule response content: application/json: schema: $ref: '#/components/schemas/firewall_api-response-single-id' security: - api_email: [] api_key: [] get: tags: - IP Access rules for an account summary: Get an IP Access rule description: Fetches the details of an IP Access rule defined at the account level. operationId: ip-access-rules-for-an-account-get-an-ip-access-rule parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/firewall_components-schemas-identifier' - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_account_identifier' responses: 4XX: description: Get an IP Access rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Get an IP Access rule response content: application/json: schema: $ref: '#/components/schemas/firewall_response_single' security: - api_email: [] api_key: [] patch: tags: - IP Access rules for an account summary: Update an IP Access rule description: |- Updates an IP Access rule defined at the account level. Note: This operation will affect all zones in the account. operationId: ip-access-rules-for-an-account-update-an-ip-access-rule parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/firewall_components-schemas-identifier' - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_account_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/firewall_schemas-rule' responses: 4XX: description: Update an IP Access rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update an IP Access rule response content: application/json: schema: $ref: '#/components/schemas/firewall_response_single' security: - api_email: [] api_key: [] /accounts/{account_identifier}/rules/lists/{list_id}/items/{item_id}: get: tags: - Lists summary: Get a list item description: Fetches a list item in the list. operationId: lists-get-a-list-item parameters: - name: item_id in: path required: true schema: $ref: '#/components/schemas/lists_item_id' - name: list_id in: path required: true schema: $ref: '#/components/schemas/lists_list_id' - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/lists_identifier' responses: 4XX: description: Get a list item response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_item-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' "200": description: Get a list item response content: application/json: schema: $ref: '#/components/schemas/lists_item-response-collection' security: - api_email: [] api_key: [] /accounts/{account_identifier}/rules/lists/bulk_operations/{operation_id}: get: tags: - Lists summary: Get bulk operation status description: |- Gets the current status of an asynchronous operation on a list. The `status` property can have one of the following values: `pending`, `running`, `completed`, or `failed`. If the status is `failed`, the `error` property will contain a message describing the error. operationId: lists-get-bulk-operation-status parameters: - name: operation_id in: path required: true schema: $ref: '#/components/schemas/lists_operation_id' - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/lists_identifier' responses: 4XX: description: Get bulk operation status response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_bulk-operation-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' "200": description: Get bulk operation status response content: application/json: schema: $ref: '#/components/schemas/lists_bulk-operation-response-collection' security: - api_email: [] api_key: [] /accounts/{account_identifier}/subscriptions: get: tags: - Account Subscriptions summary: List Subscriptions description: Lists all of an account's subscriptions. operationId: account-subscriptions-list-subscriptions parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_identifier' responses: 4XX: description: List Subscriptions response failure 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' "200": description: List Subscriptions response content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_account_subscription_response_collection' security: - api_email: [] api_key: [] api_token: [] post: tags: - Account Subscriptions summary: Create Subscription description: Creates an account subscription. operationId: account-subscriptions-create-subscription parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_subscription-v2' responses: 4XX: description: Create Subscription response failure 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' "200": description: Create Subscription response content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_account_subscription_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_identifier}/subscriptions/{subscription_identifier}: delete: tags: - Account Subscriptions summary: Delete Subscription description: Deletes an account's subscription. operationId: account-subscriptions-delete-subscription parameters: - name: subscription_identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_schemas-identifier' - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Subscription response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-single' - properties: result: type: object properties: subscription_id: $ref: '#/components/schemas/bill-subs-api_schemas-identifier' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' "200": description: Delete Subscription response content: application/json: schema: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-single' - properties: result: type: object properties: subscription_id: $ref: '#/components/schemas/bill-subs-api_schemas-identifier' security: - api_email: [] api_key: [] api_token: [] put: tags: - Account Subscriptions summary: Update Subscription description: Updates an account subscription. operationId: account-subscriptions-update-subscription parameters: - name: subscription_identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_schemas-identifier' - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_subscription-v2' responses: 4XX: description: Update Subscription response failure 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' "200": description: Update Subscription response content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_account_subscription_response_single' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_identifier}/zt_risk_scoring/{user_id}: get: tags: - Zero Trust Risk Scoring summary: User risk details description: Get risk event/score information for a specific user operationId: dlp-zt-risk-score-user-details parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' - name: user_id in: path required: true schema: $ref: '#/components/schemas/dlp_user_id' - name: page in: query schema: type: integer - name: per_page in: query schema: type: integer - name: order_by in: query schema: type: string enum: - timestamp - risk_level - name: direction in: query schema: type: string enum: - desc - asc responses: 4XX: description: User risk details response failure content: application/json: schema: $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: User risk details response content: application/json: schema: $ref: '#/components/schemas/dlp_user_risk_summary_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_identifier}/zt_risk_scoring/{user_id}/reset: post: tags: - Zero Trust Risk Scoring summary: Reset user risk score description: Clear the risk score for a particular user operationId: dlp-zt-risk-score-reset-user parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' - name: user_id in: path required: true schema: $ref: '#/components/schemas/dlp_user_id' responses: 4XX: description: Reset user response failure content: application/json: schema: $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Reset user response content: application/json: schema: $ref: '#/components/schemas/dlp_reset_user_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_identifier}/zt_risk_scoring/behaviors: get: tags: - Zero Trust Risk Scoring summary: Get behaviors description: Get all behaviors and associated configuration operationId: dlp-zt-risk-score-get-behaviors parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' responses: 4XX: description: Get behaviors response failure content: application/json: schema: $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Get behaviors response content: application/json: schema: $ref: '#/components/schemas/dlp_get_behaviors_response' security: - api_email: [] api_key: [] api_token: [] put: tags: - Zero Trust Risk Scoring summary: Update behaviors description: Update configuration for risk behaviors operationId: dlp-zt-risk-score-put-behaviors parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dlp_update_behaviors_request' responses: 4XX: description: Put behaviors response failure content: application/json: schema: $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Put behaviors response content: application/json: schema: $ref: '#/components/schemas/dlp_get_behaviors_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{account_identifier}/zt_risk_scoring/summary: get: tags: - Zero Trust Risk Scoring summary: Risky user summary description: Get risk score info for all users in the account operationId: dlp-zt-risk-score-account-summary parameters: - name: account_identifier in: path required: true schema: $ref: '#/components/schemas/dlp_identifier' - name: page in: query schema: type: integer - name: per_page in: query schema: type: integer - name: order_by in: query schema: type: string enum: - timestamp - event_count - max_risk_level - name: direction in: query schema: type: string enum: - desc - asc responses: 4XX: description: Risky user summary response failure content: application/json: schema: $ref: '#/components/schemas/dlp_api-response-common-failure' "200": description: Risky user summary response content: application/json: schema: $ref: '#/components/schemas/dlp_account_risk_summary_response' security: - api_email: [] api_key: [] api_token: [] /accounts/{accountId}/urlscanner/scan: get: tags: - URL Scanner summary: Search URL scans description: Search scans by date and webpages' requests, including full URL (after redirects), hostname, and path.
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: - name: accountId in: path required: true schema: type: string description: Account Id - name: scanId in: query schema: type: string format: uuid description: Scan uuid - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 100 - name: next_cursor in: query schema: type: string description: Pagination cursor to get the next set of results. - name: date_start in: query schema: type: string format: date-time description: Filter scans requested after date (inclusive). - name: date_end in: query schema: type: string format: date-time description: Filter scans requested before date (inclusive). - name: url in: query schema: type: string description: Filter scans by exact match URL of _any_ request made by the webpage example: https://example.com/?hello - name: hostname in: query schema: type: string description: Filter scans by hostname of _any_ request made by the webpage. example: example.com - name: path in: query schema: type: string description: Filter scans by url path of _any_ request made by the webpage. example: /samples/subresource-integrity/ - name: ip in: query schema: type: string description: Filter scans by IP address (IPv4 or IPv6) of _any_ request made by the webpage. example: 1.1.1.1 - name: asn in: query schema: type: string description: Filter scans by Autonomous System Number (ASN) of _any_ request made by the webpage. example: "13335" - name: hash in: query schema: type: string description: Filter scans by hash of any html/js/css request made by the webpage. - name: page_url in: query schema: type: string description: Filter scans by exact match to scanned URL (_after redirects_) - name: page_hostname in: query schema: type: string description: Filter scans by main page hostname . - name: page_path in: query schema: type: string description: Filter scans by exact match URL path (also supports suffix search). - name: page_asn in: query schema: type: string description: Filter scans by main page Autonomous System Number (ASN). - name: page_ip in: query schema: type: string description: Filter scans by main page IP address (IPv4 or IPv6). - name: account_scans in: query schema: type: boolean description: Return only scans created by account. - name: is_malicious in: query schema: type: boolean description: Filter scans by malicious verdict. responses: "200": description: Search results content: application/json: schema: type: object required: - messages - errors - success - result properties: errors: type: array items: type: object required: - message properties: message: type: string example: Error messages: type: array items: type: object required: - message properties: message: type: string example: OK result: type: object required: - tasks properties: tasks: type: array items: type: object required: - uuid - url - success - time - country - visibility properties: country: type: string description: Alpha-2 country code success: type: boolean description: Whether scan was successful or not time: type: string format: date-time description: When scan was submitted (UTC) url: type: string description: Scan url (after redirects) example: https://www.example.com/ uuid: type: string format: uuid description: Scan id visibility: type: string description: Visibility status. example: public success: type: boolean description: Whether search request was successful or not "400": description: Invalid params. content: application/json: schema: type: object required: - messages - errors - success properties: errors: type: array items: type: object required: - message properties: message: type: string example: Scan ID is not a valid uuid. messages: type: array items: type: object required: - message properties: message: type: string success: type: boolean description: Whether request was successful or not security: - api_email: [] api_key: [] api_token: [] post: tags: - URL Scanner summary: Create URL Scan description: Submit a URL to scan. You can also set some options, like the visibility level and custom headers. Accounts are limited to 1 new scan every 10 seconds and 8000 per month. If you need more, please reach out. operationId: urlscanner-create-scan parameters: - name: accountId in: path required: true schema: type: string description: Account Id requestBody: content: application/json: schema: type: object required: - url properties: customHeaders: type: object description: Set custom headers screenshotsResolutions: type: array description: Take multiple screenshots targeting different device types default: - desktop items: type: string description: Device resolutions. enum: - desktop - mobile - tablet default: desktop url: type: string example: https://www.example.com visibility: type: string 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 default: Public responses: "200": description: Scan request accepted successfully. content: application/json: schema: type: object required: - messages - errors - success - result properties: errors: type: array items: type: object required: - message properties: message: type: string example: Submission unsuccessful messages: type: array items: type: object required: - message properties: message: type: string example: Submission successful result: type: object required: - visibility - uuid - url - time properties: time: type: string format: date-time description: Time when url was submitted for scanning. url: type: string description: Canonical form of submitted URL. Use this if you want to later search by URL. uuid: type: string format: uuid description: Scan ID. visibility: type: string description: Submitted visibility status. example: Public success: type: boolean "400": description: Invalid params. content: application/json: schema: type: object required: - messages - errors - success properties: errors: type: array items: type: object required: - message properties: message: type: string example: Scan ID is not a valid uuid. messages: type: array items: type: object required: - message properties: message: type: string success: type: boolean description: Whether request was successful or not "409": description: 'Scan request denied: hostname was recently scanned.' content: application/json: schema: type: object required: - messages - errors - success - result properties: errors: type: array items: type: object required: - message properties: message: type: string example: Submission unsuccessful messages: type: array items: type: object required: - message properties: message: type: string result: type: object required: - tasks properties: tasks: type: array items: type: object required: - uuid - url - status - success - errors - time - timeEnd - visibility - clientLocation - clientType - effectiveUrl - scannedFrom properties: clientLocation: type: string description: Submitter location example: PT clientType: type: string enum: - Site - Automatic - Api effectiveUrl: type: string description: URL of the primary request, after all HTTP redirects example: http://example.com/ errors: type: array items: type: object required: - message properties: message: type: string scannedFrom: type: object required: - colo properties: colo: type: string description: IATA code of Cloudflare datacenter example: MAD status: type: string enum: - Queued - InProgress - InPostProcessing - Finished success: type: boolean example: true time: type: string example: "2023-05-03T17:05:04.843Z" timeEnd: type: string example: "2023-05-03T17:05:19.374Z" url: type: string description: Submitted URL example: http://example.com uuid: type: string description: Scan ID example: 2ee568d0-bf70-4827-b922-b7088c0f056f visibility: type: string enum: - Public - Unlisted success: type: boolean example: true "429": description: 'Scan request denied: rate limited.' content: application/json: schema: type: object required: - messages - errors - success properties: errors: type: array items: type: object required: - message properties: message: type: string example: Submission unsuccessful messages: type: array items: type: object required: - message properties: message: type: string success: type: boolean example: true security: - api_email: [] api_key: [] api_token: [] /accounts/{accountId}/urlscanner/scan/{scanId}: get: tags: - URL Scanner summary: Get URL scan description: Get URL scan by uuid operationId: urlscanner-get-scan parameters: - name: scanId in: path required: true schema: type: string format: uuid description: Scan uuid - name: accountId in: path required: true schema: type: string description: Account Id responses: "200": description: Scan has finished. It may or may not have been successful. content: application/json: schema: type: object required: - messages - errors - success - result properties: errors: type: array items: type: object required: - message properties: message: type: string example: Error messages: type: array items: type: object required: - message properties: message: type: string example: OK result: type: object required: - scan properties: scan: type: object required: - task - meta - page - geo - certificates - performance - verdicts properties: asns: type: object description: Dictionary of Autonomous System Numbers where ASN's are the keys properties: asn: type: object description: ASN's contacted required: - asn - name - description - org_name - location_alpha2 properties: asn: type: string example: "15133" description: type: string example: EDGECAST location_alpha2: type: string example: US name: type: string example: EDGECAST org_name: type: string example: Edgecast Inc. certificates: type: array items: type: object required: - issuer - subjectName - validFrom - validTo properties: issuer: type: string subjectName: type: string example: rkmod.somee.com validFrom: type: number example: 1.6826844e+09 validTo: type: number example: 1.696698e+09 domains: type: object properties: example.com: type: object required: - name - type - categories - dns - rank properties: categories: type: object required: - inherited properties: content: type: array items: type: object required: - id - name properties: id: type: integer name: type: string example: Technology super_category_id: type: integer inherited: type: object properties: content: type: array items: type: object required: - id - name properties: id: type: integer name: type: string example: Technology super_category_id: type: integer from: type: string example: example.com risks: type: array items: type: object required: - id - name properties: id: type: integer name: type: string example: Technology super_category_id: type: integer risks: type: array items: type: object required: - id - name properties: id: type: integer name: type: string example: Technology super_category_id: type: integer dns: type: array items: type: object required: - name - address - type - dnssec_valid properties: address: type: string example: 93.184.216.34 dnssec_valid: type: boolean name: type: string example: example.com type: type: string example: A name: type: string example: example.com rank: type: object required: - name - bucket properties: bucket: type: string example: "500" name: type: string example: example.com rank: type: integer description: Rank in the Global Radar Rank, if set. See more at https://blog.cloudflare.com/radar-domain-rankings/ type: type: string example: Apex domain geo: type: object required: - locations - continents properties: continents: type: array description: GeoIP continent location items: type: string description: GeoIP continent location example: North America locations: type: array description: GeoIP country location items: type: string description: GeoIP country location example: US ips: type: object properties: ip: type: object required: - ip - ipVersion - locationAlpha2 - locationName - subdivision1Name - subdivision2Name - latitude - longitude - continent - geonameId - asn - asnName - asnOrgName - asnDescription - asnLocationAlpha2 properties: asn: type: string example: "15133" asnDescription: type: string example: EDGECAST asnLocationAlpha2: type: string example: US asnName: type: string example: EDGECAST asnOrgName: type: string example: Edgecast Inc. continent: type: string example: North America geonameId: type: string example: "6252001" ip: type: string example: 2606:2800:220:1:248:1893:25c8:1946 ipVersion: type: string example: IPv6 latitude: type: string example: "39.76" locationAlpha2: type: string example: US locationName: type: string example: United States longitude: type: string example: "-98.5" subdivision1Name: type: string subdivision2Name: type: string links: type: object properties: link: type: object required: - href - text properties: href: type: string description: Outgoing link detected in the DOM example: https://www.iana.org/domains/example text: type: string example: More information... meta: type: object required: - processors properties: processors: type: object required: - tech - categories - rank - phishing properties: categories: type: object required: - content - risks properties: content: type: array items: type: object required: - id - name properties: id: type: integer example: 155 name: type: string example: Technology super_category_id: type: integer risks: type: array items: type: object required: - id - super_category_id - name properties: id: type: integer example: 17 name: type: string example: Newly Seen Domains super_category_id: type: integer example: 32 phishing: type: array items: type: string example: CredentialHarvester rank: type: object required: - name - bucket properties: bucket: type: string example: "500" name: type: string example: example.com rank: type: integer description: Rank in the Global Radar Rank, if set. See more at https://blog.cloudflare.com/radar-domain-rankings/ tech: type: array items: type: object required: - name - slug - categories - confidence - icon - website - evidence properties: categories: type: array items: type: object required: - id - slug - groups - name - priority properties: groups: type: array items: type: integer id: type: integer example: 63 name: type: string example: IAAS priority: type: integer example: 8 slug: type: string example: iaas confidence: type: integer example: 100 description: type: string evidence: type: object required: - patterns - impliedBy properties: impliedBy: type: array items: type: string patterns: type: array items: type: object required: - type - regex - value - match - name - confidence - version - implies - excludes properties: confidence: type: integer example: 100 excludes: type: array items: type: string implies: type: array items: type: string match: type: string example: ECS name: type: string description: Header or Cookie name when set example: server regex: type: string example: ^ECS type: type: string example: headers value: type: string example: ECS (dcb/7EEE) version: type: string icon: type: string example: Amazon ECS.svg name: type: string example: Amazon ECS slug: type: string example: amazon-ecs website: type: string example: https://aws.amazon.com/ecs/ page: type: object required: - url - domain - country - countryLocationAlpha2 - subdivision1Name - subdivision2name - ip - asn - asnname - asnLocationAlpha2 - cookies - headers - status - js - console - securityViolations properties: asn: type: string example: "15133" asnLocationAlpha2: type: string example: US asnname: type: string example: EDGECAST console: type: array items: type: object required: - type - text - category properties: category: type: string example: network text: type: string example: 'Failed to load resource: the server responded with a status of 404 (Not Found)' type: type: string example: error url: type: string example: http://example.com/favicon.ico cookies: type: array items: type: object required: - name - value - domain - path - expires - size - httpOnly - secure - session - sameParty - sourceScheme - sourcePort properties: domain: type: string example: rkmod.somee.com expires: type: number example: -1 httpOnly: type: boolean name: type: string example: b path: type: string example: / priority: type: string example: Medium sameParty: type: boolean secure: type: boolean session: type: boolean example: true size: type: number example: 2 sourcePort: type: number example: 443 sourceScheme: type: string example: Secure value: type: string example: b country: type: string example: United States countryLocationAlpha2: type: string example: US domain: type: string example: example.com headers: type: array items: type: object required: - name - value properties: name: type: string example: Content-Length value: type: string example: "648" ip: type: string example: 2606:2800:220:1:248:1893:25c8:1946 js: type: object required: - variables properties: variables: type: array items: type: object required: - name - type properties: name: type: string example: checkFrame type: type: string example: string securityViolations: type: array items: type: object required: - text - category - url properties: category: type: string example: csp text: type: string 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: ... ' url: type: string example: http://example.com/ status: type: number example: 200 subdivision1Name: type: string subdivision2name: type: string url: type: string example: http://example.com/ performance: type: array items: type: object 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 properties: connectEnd: type: number example: 82.59999999403954 connectStart: type: number example: 72.79999999701977 decodedBodySize: type: number example: 1256 domComplete: type: number example: 306 domContentLoadedEventEnd: type: number example: 305.8999999910593 domContentLoadedEventStart: type: number example: 305.8999999910593 domInteractive: type: number example: 305.8999999910593 domainLookupEnd: type: number example: 72.79999999701977 domainLookupStart: type: number example: 2.199999988079071 duration: type: number example: 306 encodedBodySize: type: number example: 648 entryType: type: string example: navigation fetchStart: type: number example: 0.8999999910593033 initiatorType: type: string example: navigation loadEventEnd: type: number example: 306 loadEventStart: type: number example: 306 name: type: string example: http://example.com/ nextHopProtocol: type: string example: http/1.1 redirectCount: type: number redirectEnd: type: number redirectStart: type: number requestStart: type: number example: 82.69999998807907 responseEnd: type: number example: 270.8999999910593 responseStart: type: number example: 265.69999998807907 secureConnectionStart: type: number startTime: type: number transferSize: type: number example: 948 type: type: string example: navigate unloadEventEnd: type: number unloadEventStart: type: number workerStart: type: number task: type: object required: - uuid - url - status - success - errors - time - timeEnd - visibility - clientLocation - clientType - effectiveUrl - scannedFrom properties: clientLocation: type: string description: Submitter location example: PT clientType: type: string enum: - Site - Automatic - Api effectiveUrl: type: string description: URL of the primary request, after all HTTP redirects example: http://example.com/ errors: type: array items: type: object required: - message properties: message: type: string scannedFrom: type: object required: - colo properties: colo: type: string description: IATA code of Cloudflare datacenter example: MAD status: type: string enum: - Queued - InProgress - InPostProcessing - Finished success: type: boolean example: true time: type: string example: "2023-05-03T17:05:04.843Z" timeEnd: type: string example: "2023-05-03T17:05:19.374Z" url: type: string description: Submitted URL example: http://example.com uuid: type: string description: Scan ID example: 2ee568d0-bf70-4827-b922-b7088c0f056f visibility: type: string enum: - Public - Unlisted verdicts: type: object required: - overall properties: overall: type: object required: - malicious - categories - phishing properties: categories: type: array items: type: object required: - id - super_category_id - name properties: id: type: number example: 117 name: type: string example: Malware super_category_id: type: number example: 32 malicious: type: boolean description: At least one of our subsystems marked the site as potentially malicious at the time of the scan. example: true phishing: type: array items: type: string example: Credential Harvester success: type: boolean description: Whether request was successful or not "202": description: 'Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`.' content: application/json: schema: type: object required: - messages - errors - success - result properties: errors: type: array items: type: object required: - message properties: message: type: string messages: type: array items: type: object required: - message properties: message: type: string example: In Progress result: type: object required: - scan properties: scan: type: object required: - task properties: task: type: object required: - uuid - url - status - success - errors - time - visibility - location - region - effectiveUrl properties: effectiveUrl: type: string example: http://example.com/ errors: type: array items: type: object required: - message properties: message: type: string location: type: string example: PT region: type: string example: enam status: type: string example: InProgress success: type: boolean example: true time: type: string example: "2023-05-03T17:05:04.843Z" url: type: string example: http://example.com uuid: type: string example: 2ee568d0-bf70-4827-b922-b7088c0f056f visibility: type: string example: Public success: type: boolean description: Whether request was successful or not "400": description: Invalid params. content: application/json: schema: type: object required: - messages - errors - success properties: errors: type: array items: type: object required: - message properties: message: type: string example: Scan ID is not a valid uuid. messages: type: array items: type: object required: - message properties: message: type: string success: type: boolean description: Whether request was successful or not "404": description: Scan not found. content: application/json: schema: type: object required: - messages - errors - success properties: errors: type: array items: type: object required: - message properties: message: type: string example: Scan not found. messages: type: array items: type: object required: - message properties: message: type: string success: type: boolean description: Whether request was successful or not security: - api_email: [] api_key: [] api_token: [] /accounts/{accountId}/urlscanner/scan/{scanId}/har: get: tags: - URL Scanner summary: Get URL scan's HAR 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: - name: scanId in: path required: true schema: type: string format: uuid description: Scan uuid - name: accountId in: path required: true schema: type: string description: Account Id responses: "200": description: Returns the scan's har. content: application/json: schema: type: object required: - messages - errors - success - result properties: errors: type: array items: type: object required: - message properties: message: type: string example: Error messages: type: array items: type: object required: - message properties: message: type: string example: OK result: type: object required: - har properties: har: type: object required: - log properties: log: type: object required: - version - creator - pages - entries properties: creator: type: object required: - name - version - comment properties: comment: type: string example: https://github.com/sitespeedio/chrome-har name: type: string example: chrome-har version: type: string example: 0.13.1 entries: type: array items: type: object required: - cache - startedDateTime - _requestId - _initialPriority - _priority - pageref - request - time - _initiator_type - _resourceType - response - connection - serverIPAddress - _requestTime properties: _initialPriority: type: string example: VeryHigh _initiator_type: type: string example: other _priority: type: string example: VeryHigh _requestId: type: string example: DDC779F0CB3746BAF283EC1A51B0F2F8 _requestTime: type: number example: 114135.331081 _resourceType: type: string example: document cache: type: object connection: type: string example: "33" pageref: type: string example: page_1 request: type: object required: - method - url - headersSize - bodySize - headers - httpVersion properties: bodySize: type: number headers: type: array items: type: object required: - name - value properties: name: type: string example: Upgrade-Insecure-Requests value: type: string example: "1" headersSize: type: number example: 197 httpVersion: type: string example: http/1.1 method: type: string example: GET url: type: string example: http://example.com/ response: type: object required: - httpVersion - redirectURL - status - statusText - content - headersSize - bodySize - headers - _transferSize properties: _transferSize: type: number example: 1071 bodySize: type: number example: 648 content: type: object required: - mimeType - size properties: compression: type: integer example: 608 mimeType: type: string example: text/html size: type: number example: 1256 headers: type: array items: type: object required: - name - value properties: name: type: string example: Content-Encoding value: type: string example: gzip headersSize: type: number example: 423 httpVersion: type: string example: http/1.1 redirectURL: type: string status: type: number example: 200 statusText: type: string example: OK serverIPAddress: type: string example: 2606:2800:220:1:248:1893:25c8:1946 startedDateTime: type: string example: "2023-05-03T17:05:13.196Z" time: type: number example: 268.64 pages: type: array items: type: object required: - id - startedDateTime - title - pageTimings properties: id: type: string example: page_1 pageTimings: type: object required: - onLoad - onContentLoad properties: onContentLoad: type: number example: 305.408 onLoad: type: number example: 305.169 startedDateTime: type: string example: "2023-05-03T17:05:13.195Z" title: type: string example: http://example.com/ version: type: string example: "1.2" success: type: boolean description: Whether search request was successful or not "202": description: 'Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`.' content: application/json: schema: type: object required: - messages - errors - success - result properties: errors: type: array items: type: object required: - message properties: message: type: string messages: type: array items: type: object required: - message properties: message: type: string example: In Progress result: type: object required: - scan properties: scan: type: object required: - task properties: task: type: object required: - uuid - url - status - success - errors - time - visibility - location - region - effectiveUrl properties: effectiveUrl: type: string example: http://example.com/ errors: type: array items: type: object required: - message properties: message: type: string location: type: string example: PT region: type: string example: enam status: type: string example: InProgress success: type: boolean example: true time: type: string example: "2023-05-03T17:05:04.843Z" url: type: string example: http://example.com uuid: type: string example: 2ee568d0-bf70-4827-b922-b7088c0f056f visibility: type: string example: Public success: type: boolean description: Whether request was successful or not "400": description: Invalid params. content: application/json: schema: type: object required: - messages - errors - success properties: errors: type: array items: type: object required: - message properties: message: type: string example: Scan ID is not a valid uuid. messages: type: array items: type: object required: - message properties: message: type: string success: type: boolean description: Whether request was successful or not "404": description: Scan not found. content: application/json: schema: type: object required: - messages - errors - success properties: errors: type: array items: type: object required: - message properties: message: type: string example: Scan not found. messages: type: array items: type: object required: - message properties: message: type: string success: type: boolean description: Whether request was successful or not security: - api_email: [] api_key: [] api_token: [] /accounts/{accountId}/urlscanner/scan/{scanId}/screenshot: get: tags: - URL Scanner summary: Get screenshot description: Get scan's screenshot by resolution (desktop/mobile/tablet). operationId: urlscanner-get-scan-screenshot parameters: - name: scanId in: path required: true schema: type: string format: uuid description: Scan uuid - name: accountId in: path required: true schema: type: string description: Account Id - name: resolution in: query schema: type: string description: Target device type enum: - desktop - mobile - tablet default: desktop responses: "200": description: Returns the scan's requested screenshot. content: image/png: schema: type: string description: PNG Image "202": description: 'Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`.' content: application/json: schema: type: object required: - messages - errors - success - result properties: errors: type: array items: type: object required: - message properties: message: type: string messages: type: array items: type: object required: - message properties: message: type: string example: In Progress result: type: object required: - scan properties: scan: type: object required: - task properties: task: type: object required: - uuid - url - status - success - errors - time - visibility - location - region - effectiveUrl properties: effectiveUrl: type: string example: http://example.com/ errors: type: array items: type: object required: - message properties: message: type: string location: type: string example: PT region: type: string example: enam status: type: string example: InProgress success: type: boolean example: true time: type: string example: "2023-05-03T17:05:04.843Z" url: type: string example: http://example.com uuid: type: string example: 2ee568d0-bf70-4827-b922-b7088c0f056f visibility: type: string example: Public success: type: boolean description: Whether request was successful or not "400": description: Invalid params. content: application/json: schema: type: object required: - messages - errors - success properties: errors: type: array items: type: object required: - message properties: message: type: string example: Scan ID is not a valid uuid. messages: type: array items: type: object required: - message properties: message: type: string success: type: boolean description: Whether request was successful or not "404": description: Scan not found. content: application/json: schema: type: object required: - messages - errors - success properties: errors: type: array items: type: object required: - message properties: message: type: string example: Scan not found. messages: type: array items: type: object required: - message properties: message: type: string success: type: boolean description: Whether request was successful or not security: - api_email: [] api_key: [] api_token: [] /accounts/{identifier}/access/apps: get: tags: - Access applications summary: List Access applications description: Lists all Access applications in an account. operationId: access-applications-list-access-applications parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List Access applications response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List Access applications response content: application/json: schema: $ref: '#/components/schemas/access_apps_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Access applications summary: Add an Access Application description: Adds a new application to Access. operationId: access-applications-add-an-application parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/access_apps' responses: 4XX: description: Add a Bookmark application response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Add an application response content: application/json: schema: allOf: - $ref: '#/components/schemas/access_apps_components-schemas-single_response' - properties: result: $ref: '#/components/schemas/access_apps' security: - api_email: [] api_key: [] /accounts/{identifier}/access/apps/{app_id}: delete: tags: - Access applications summary: Delete an Access application description: Deletes an application from Access. operationId: access-applications-delete-an-access-application parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/access_app_id' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete an Access application response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Delete an Access application response content: application/json: schema: $ref: '#/components/schemas/access_id_response' security: - api_email: [] api_key: [] get: tags: - Access applications summary: Get an Access application description: Fetches information about an Access application. operationId: access-applications-get-an-access-application parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/access_app_id' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get an Access application response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get an Access application response content: application/json: schema: $ref: '#/components/schemas/access_apps_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Access applications summary: Update an Access application description: Updates an Access application. operationId: access-applications-update-a-bookmark-application parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/access_app_id' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/access_apps' responses: 4XX: description: Update an Access application response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update an Access application response content: application/json: schema: allOf: - $ref: '#/components/schemas/access_apps_components-schemas-single_response' - properties: result: $ref: '#/components/schemas/access_apps' security: - api_email: [] api_key: [] /accounts/{identifier}/access/apps/{app_id}/revoke_tokens: post: tags: - Access applications summary: Revoke application tokens description: Revokes all tokens issued for an application. operationId: access-applications-revoke-service-tokens parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/access_app_id' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Revoke application tokens response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Revoke application tokens response content: application/json: schema: $ref: '#/components/schemas/access_schemas-empty_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/apps/{app_id}/user_policy_checks: get: tags: - Access applications summary: Test Access policies description: Tests if a specific user has permission to access an application. operationId: access-applications-test-access-policies parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/access_app_id' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Test Access policies response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Test Access policies response content: application/json: schema: $ref: '#/components/schemas/access_policy_check_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/apps/{uuid}/ca: delete: tags: - Access short-lived certificate CAs summary: Delete a short-lived certificate CA description: Deletes a short-lived certificate CA. operationId: access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete a short-lived certificate CA response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Delete a short-lived certificate CA response content: application/json: schema: $ref: '#/components/schemas/access_schemas-id_response' security: - api_email: [] api_key: [] get: tags: - Access short-lived certificate CAs summary: Get a short-lived certificate CA description: Fetches a short-lived certificate CA and its public key. operationId: access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get a short-lived certificate CA response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get a short-lived certificate CA response content: application/json: schema: $ref: '#/components/schemas/access_ca_components-schemas-single_response' security: - api_email: [] api_key: [] post: tags: - Access short-lived certificate CAs summary: Create a short-lived certificate CA description: Generates a new short-lived certificate CA and public key. operationId: access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Create a short-lived certificate CA response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Create a short-lived certificate CA response content: application/json: schema: $ref: '#/components/schemas/access_ca_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/apps/{uuid}/policies: get: tags: - Access policies summary: List Access policies description: Lists Access policies configured for an application. operationId: access-policies-list-access-policies parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List Access policies response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List Access policies response content: application/json: schema: $ref: '#/components/schemas/access_policies_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Access policies summary: Create an Access policy description: Create a new Access policy for an application. operationId: access-policies-create-an-access-policy parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name - decision - include properties: approval_groups: $ref: '#/components/schemas/access_approval_groups' approval_required: $ref: '#/components/schemas/access_approval_required' decision: $ref: '#/components/schemas/access_decision' exclude: $ref: '#/components/schemas/access_schemas-exclude' include: $ref: '#/components/schemas/access_include' isolation_required: $ref: '#/components/schemas/access_isolation_required' name: $ref: '#/components/schemas/access_policies_components-schemas-name' precedence: $ref: '#/components/schemas/access_precedence' purpose_justification_prompt: $ref: '#/components/schemas/access_purpose_justification_prompt' purpose_justification_required: $ref: '#/components/schemas/access_purpose_justification_required' require: $ref: '#/components/schemas/access_schemas-require' session_duration: $ref: '#/components/schemas/access_components-schemas-session_duration' responses: 4XX: description: Create an Access policy response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Create an Access policy response content: application/json: schema: $ref: '#/components/schemas/access_policies_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/apps/{uuid1}/policies/{uuid}: delete: tags: - Access policies summary: Delete an Access policy description: Delete an Access policy. operationId: access-policies-delete-an-access-policy parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: uuid1 in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete an Access policy response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Delete an Access policy response content: application/json: schema: $ref: '#/components/schemas/access_id_response' security: - api_email: [] api_key: [] get: tags: - Access policies summary: Get an Access policy description: Fetches a single Access policy. operationId: access-policies-get-an-access-policy parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: uuid1 in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get an Access policy response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get an Access policy response content: application/json: schema: $ref: '#/components/schemas/access_policies_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Access policies summary: Update an Access policy description: Update a configured Access policy. operationId: access-policies-update-an-access-policy parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: uuid1 in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name - decision - include properties: approval_groups: $ref: '#/components/schemas/access_approval_groups' approval_required: $ref: '#/components/schemas/access_approval_required' decision: $ref: '#/components/schemas/access_decision' exclude: $ref: '#/components/schemas/access_schemas-exclude' include: $ref: '#/components/schemas/access_include' isolation_required: $ref: '#/components/schemas/access_isolation_required' name: $ref: '#/components/schemas/access_policies_components-schemas-name' precedence: $ref: '#/components/schemas/access_precedence' purpose_justification_prompt: $ref: '#/components/schemas/access_purpose_justification_prompt' purpose_justification_required: $ref: '#/components/schemas/access_purpose_justification_required' require: $ref: '#/components/schemas/access_schemas-require' session_duration: $ref: '#/components/schemas/access_components-schemas-session_duration' responses: 4XX: description: Update an Access policy response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update an Access policy response content: application/json: schema: $ref: '#/components/schemas/access_policies_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/apps/ca: get: tags: - Access short-lived certificate CAs summary: List short-lived certificate CAs description: Lists short-lived certificate CAs and their public keys. operationId: access-short-lived-certificate-c-as-list-short-lived-certificate-c-as parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List short-lived certificate CAs response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List short-lived certificate CAs response content: application/json: schema: $ref: '#/components/schemas/access_ca_components-schemas-response_collection' security: - api_email: [] api_key: [] /accounts/{identifier}/access/bookmarks: get: tags: - Access Bookmark applications (Deprecated) summary: List Bookmark applications description: Lists Bookmark applications. operationId: access-bookmark-applications-(-deprecated)-list-bookmark-applications parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_schemas-identifier' responses: 4XX: description: List Bookmark applications response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List Bookmark applications response content: application/json: schema: $ref: '#/components/schemas/access_bookmarks_components-schemas-response_collection' deprecated: true security: - api_email: [] api_key: [] /accounts/{identifier}/access/bookmarks/{uuid}: delete: tags: - Access Bookmark applications (Deprecated) summary: Delete a Bookmark application description: Deletes a Bookmark application. operationId: access-bookmark-applications-(-deprecated)-delete-a-bookmark-application parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a Bookmark application response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Delete a Bookmark application response content: application/json: schema: $ref: '#/components/schemas/access_id_response' deprecated: true security: - api_email: [] api_key: [] get: tags: - Access Bookmark applications (Deprecated) summary: Get a Bookmark application description: Fetches a single Bookmark application. operationId: access-bookmark-applications-(-deprecated)-get-a-bookmark-application parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_schemas-identifier' responses: 4XX: description: Get a Bookmark application response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get a Bookmark application response content: application/json: schema: $ref: '#/components/schemas/access_bookmarks_components-schemas-single_response' deprecated: true security: - api_email: [] api_key: [] post: tags: - Access Bookmark applications (Deprecated) summary: Create a Bookmark application description: Create a new Bookmark application. operationId: access-bookmark-applications-(-deprecated)-create-a-bookmark-application parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Create a Bookmark application response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Create a Bookmark application response content: application/json: schema: $ref: '#/components/schemas/access_bookmarks_components-schemas-single_response' deprecated: true security: - api_email: [] api_key: [] put: tags: - Access Bookmark applications (Deprecated) summary: Update a Bookmark application description: Updates a configured Bookmark application. operationId: access-bookmark-applications-(-deprecated)-update-a-bookmark-application parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Update a Bookmark application response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update a Bookmark application response content: application/json: schema: $ref: '#/components/schemas/access_bookmarks_components-schemas-single_response' deprecated: true security: - api_email: [] api_key: [] /accounts/{identifier}/access/certificates: get: tags: - Access mTLS authentication summary: List mTLS certificates description: Lists all mTLS root certificates. operationId: access-mtls-authentication-list-mtls-certificates parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List mTLS certificates response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List mTLS certificates response content: application/json: schema: $ref: '#/components/schemas/access_certificates_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Access mTLS authentication summary: Add an mTLS certificate description: Adds a new mTLS root certificate to Access. operationId: access-mtls-authentication-add-an-mtls-certificate parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name - certificate properties: associated_hostnames: $ref: '#/components/schemas/access_associated_hostnames' certificate: type: string description: The certificate content. example: |- -----BEGIN CERTIFICATE----- MIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10 DrUtmu/B -----END CERTIFICATE----- name: $ref: '#/components/schemas/access_certificates_components-schemas-name' responses: 4XX: description: Add an mTLS certificate response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Add an mTLS certificate response content: application/json: schema: $ref: '#/components/schemas/access_certificates_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/certificates/{uuid}: delete: tags: - Access mTLS authentication summary: Delete an mTLS certificate description: Deletes an mTLS certificate. operationId: access-mtls-authentication-delete-an-mtls-certificate parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete an mTLS certificate response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Delete an mTLS certificate response content: application/json: schema: $ref: '#/components/schemas/access_components-schemas-id_response' security: - api_email: [] api_key: [] get: tags: - Access mTLS authentication summary: Get an mTLS certificate description: Fetches a single mTLS certificate. operationId: access-mtls-authentication-get-an-mtls-certificate parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get an mTLS certificate response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get an mTLS certificate response content: application/json: schema: $ref: '#/components/schemas/access_certificates_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Access mTLS authentication summary: Update an mTLS certificate description: Updates a configured mTLS certificate. operationId: access-mtls-authentication-update-an-mtls-certificate parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - associated_hostnames properties: associated_hostnames: $ref: '#/components/schemas/access_associated_hostnames' name: $ref: '#/components/schemas/access_certificates_components-schemas-name' responses: 4XX: description: Update an mTLS certificate response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update an mTLS certificate response content: application/json: schema: $ref: '#/components/schemas/access_certificates_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/certificates/settings: get: tags: - Access mTLS authentication summary: List all mTLS hostname settings description: List all mTLS hostname settings for this account. operationId: access-mtls-authentication-list-mtls-certificates-hostname-settings parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List mTLS hostname settings response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List mTLS hostname settings response content: application/json: schema: $ref: '#/components/schemas/access_response_collection_hostnames' security: - api_email: [] api_key: [] put: tags: - Access mTLS authentication summary: Update an mTLS certificate's hostname settings description: Updates an mTLS certificate's hostname settings. operationId: access-mtls-authentication-update-an-mtls-certificate-settings parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: type: object required: - settings properties: settings: type: array items: $ref: '#/components/schemas/access_settings' responses: 4XX: description: Update an mTLS certificates hostname settings failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Update an mTLS certificates hostname settings response content: application/json: schema: $ref: '#/components/schemas/access_response_collection_hostnames' security: - api_email: [] api_key: [] /accounts/{identifier}/access/custom_pages: get: tags: - Access custom pages summary: List custom pages description: List custom pages operationId: access-custom-pages-list-custom-pages parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List custom pages response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List custom pages response content: application/json: schema: $ref: '#/components/schemas/access_custom-pages_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Access custom pages summary: Create a custom page description: Create a custom page operationId: access-custom-pages-create-a-custom-page parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/access_custom_page' responses: 4XX: description: Create a custom page response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Create a custom page response content: application/json: schema: $ref: '#/components/schemas/access_single_response_without_html' security: - api_email: [] api_key: [] /accounts/{identifier}/access/custom_pages/{uuid}: delete: tags: - Access custom pages summary: Delete a custom page description: Delete a custom page operationId: access-custom-pages-delete-a-custom-page parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete a custom page response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Delete a custom page response content: application/json: schema: $ref: '#/components/schemas/access_components-schemas-id_response' security: - api_email: [] api_key: [] get: tags: - Access custom pages summary: Get a custom page description: Fetches a custom page and also returns its HTML. operationId: access-custom-pages-get-a-custom-page parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get a custom page response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get a custom page response content: application/json: schema: $ref: '#/components/schemas/access_custom-pages_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Access custom pages summary: Update a custom page description: Update a custom page operationId: access-custom-pages-update-a-custom-page parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/access_custom_page' responses: 4XX: description: Update a custom page response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update a custom page response content: application/json: schema: $ref: '#/components/schemas/access_single_response_without_html' security: - api_email: [] api_key: [] /accounts/{identifier}/access/groups: get: tags: - Access groups summary: List Access groups description: Lists all Access groups. operationId: access-groups-list-access-groups parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List Access groups response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List Access groups response content: application/json: schema: $ref: '#/components/schemas/access_schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Access groups summary: Create an Access group description: Creates a new Access group. operationId: access-groups-create-an-access-group parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name - include properties: exclude: $ref: '#/components/schemas/access_exclude' include: $ref: '#/components/schemas/access_include' is_default: $ref: '#/components/schemas/access_is_default' name: $ref: '#/components/schemas/access_components-schemas-name' require: $ref: '#/components/schemas/access_require' responses: 4XX: description: Create an Access group response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Create an Access group response content: application/json: schema: $ref: '#/components/schemas/access_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/groups/{uuid}: delete: tags: - Access groups summary: Delete an Access group description: Deletes an Access group. operationId: access-groups-delete-an-access-group parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete an Access group response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Delete an Access group response content: application/json: schema: $ref: '#/components/schemas/access_id_response' security: - api_email: [] api_key: [] get: tags: - Access groups summary: Get an Access group description: Fetches a single Access group. operationId: access-groups-get-an-access-group parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get an Access group response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get an Access group response content: application/json: schema: $ref: '#/components/schemas/access_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Access groups summary: Update an Access group description: Updates a configured Access group. operationId: access-groups-update-an-access-group parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name - include properties: exclude: $ref: '#/components/schemas/access_exclude' include: $ref: '#/components/schemas/access_include' is_default: $ref: '#/components/schemas/access_is_default' name: $ref: '#/components/schemas/access_components-schemas-name' require: $ref: '#/components/schemas/access_require' responses: 4XX: description: Update an Access group response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update an Access group response content: application/json: schema: $ref: '#/components/schemas/access_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/identity_providers: get: tags: - Access identity providers summary: List Access identity providers description: Lists all configured identity providers. operationId: access-identity-providers-list-access-identity-providers parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List Access identity providers response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List Access identity providers response content: application/json: schema: $ref: '#/components/schemas/access_response_collection' security: - api_email: [] api_key: [] post: tags: - Access identity providers summary: Add an Access identity provider description: Adds a new identity provider to Access. operationId: access-identity-providers-add-an-access-identity-provider parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/access_identity-providers' responses: 4XX: description: Add an Access identity provider response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Add an Access identity provider response content: application/json: schema: $ref: '#/components/schemas/access_schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/identity_providers/{uuid}: delete: tags: - Access identity providers summary: Delete an Access identity provider description: Deletes an identity provider from Access. operationId: access-identity-providers-delete-an-access-identity-provider parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete an Access identity provider response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Delete an Access identity provider response content: application/json: schema: $ref: '#/components/schemas/access_id_response' security: - api_email: [] api_key: [] get: tags: - Access identity providers summary: Get an Access identity provider description: Fetches a configured identity provider. operationId: access-identity-providers-get-an-access-identity-provider parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get an Access identity provider response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get an Access identity provider response content: application/json: schema: $ref: '#/components/schemas/access_schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Access identity providers summary: Update an Access identity provider description: Updates a configured identity provider. operationId: access-identity-providers-update-an-access-identity-provider parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/access_identity-providers' responses: 4XX: description: Update an Access identity provider response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update an Access identity provider response content: application/json: schema: $ref: '#/components/schemas/access_schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/keys: get: tags: - Access key configuration summary: Get the Access key configuration description: Gets the Access key rotation settings for an account. operationId: access-key-configuration-get-the-access-key-configuration parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get the Access key configuration response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get the Access key configuration response content: application/json: schema: $ref: '#/components/schemas/access_keys_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Access key configuration summary: Update the Access key configuration description: Updates the Access key rotation settings for an account. operationId: access-key-configuration-update-the-access-key-configuration parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - key_rotation_interval_days properties: key_rotation_interval_days: $ref: '#/components/schemas/access_key_rotation_interval_days' responses: 4XX: description: Update the Access key configuration response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update the Access key configuration response content: application/json: schema: $ref: '#/components/schemas/access_keys_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/keys/rotate: post: tags: - Access key configuration summary: Rotate Access keys description: Perfoms a key rotation for an account. operationId: access-key-configuration-rotate-access-keys parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Rotate Access keys response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Rotate Access keys response content: application/json: schema: $ref: '#/components/schemas/access_keys_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/logs/access_requests: get: tags: - Access authentication logs summary: Get Access authentication logs description: Gets a list of Access authentication audit logs for an account. operationId: access-authentication-logs-get-access-authentication-logs parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get Access authentication logs response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get Access authentication logs response content: application/json: schema: $ref: '#/components/schemas/access_access-requests_components-schemas-response_collection' security: - api_email: [] api_key: [] /accounts/{identifier}/access/organizations: get: tags: - Zero Trust organization summary: Get your Zero Trust organization description: Returns the configuration for your Zero Trust organization. operationId: zero-trust-organization-get-your-zero-trust-organization parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get your Zero Trust organization response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get your Zero Trust organization response content: application/json: schema: $ref: '#/components/schemas/access_single_response' security: - api_email: [] api_key: [] post: tags: - Zero Trust organization summary: Create your Zero Trust organization description: Sets up a Zero Trust organization for your account. operationId: zero-trust-organization-create-your-zero-trust-organization parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name - auth_domain 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' responses: 4XX: description: Create your Zero Trust organization response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Create your Zero Trust organization response content: application/json: schema: $ref: '#/components/schemas/access_single_response' security: - api_email: [] api_key: [] put: tags: - Zero Trust organization summary: Update your Zero Trust organization description: Updates the configuration for your Zero Trust organization. operationId: zero-trust-organization-update-your-zero-trust-organization parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true 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' responses: 4XX: description: Update your Zero Trust organization response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update your Zero Trust organization response content: application/json: schema: $ref: '#/components/schemas/access_single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/organizations/revoke_user: post: tags: - Zero Trust organization summary: Revoke all Access tokens for a user description: Revokes a user's access across all applications. operationId: zero-trust-organization-revoke-all-access-tokens-for-a-user parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - email properties: email: type: string description: The email of the user to revoke. example: test@example.com responses: 4xx: description: Revoke all Access tokens for a user response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Revoke all Access tokens for a user response content: application/json: schema: $ref: '#/components/schemas/access_empty_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/seats: patch: tags: - Zero Trust seats summary: Update a user seat description: Removes a user from a Zero Trust seat when both `access_seat` and `gateway_seat` are set to false. operationId: zero-trust-seats-update-a-user-seat parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/access_seats_definition' responses: 4XX: description: Update a user seat response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update a user seat response content: application/json: schema: $ref: '#/components/schemas/access_seats_components-schemas-response_collection' security: - api_email: [] api_key: [] /accounts/{identifier}/access/service_tokens: get: tags: - Access service tokens summary: List service tokens description: Lists all service tokens. operationId: access-service-tokens-list-service-tokens parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List service tokens response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List service tokens response content: application/json: schema: $ref: '#/components/schemas/access_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Access service tokens summary: Create a service token description: Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token. operationId: access-service-tokens-create-a-service-token parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name properties: duration: $ref: '#/components/schemas/access_duration' name: $ref: '#/components/schemas/access_service-tokens_components-schemas-name' responses: 4XX: description: Create a service token response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Create a service token response content: application/json: schema: $ref: '#/components/schemas/access_create_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/service_tokens/{uuid}: delete: tags: - Access service tokens summary: Delete a service token description: Deletes a service token. operationId: access-service-tokens-delete-a-service-token parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete a service token response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Delete a service token response content: application/json: schema: $ref: '#/components/schemas/access_service-tokens_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Access service tokens summary: Update a service token description: Updates a configured service token. operationId: access-service-tokens-update-a-service-token parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: properties: duration: $ref: '#/components/schemas/access_duration' name: $ref: '#/components/schemas/access_service-tokens_components-schemas-name' responses: 4XX: description: Update a service token response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update a service token response content: application/json: schema: $ref: '#/components/schemas/access_service-tokens_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/service_tokens/{uuid}/refresh: post: tags: - Access service tokens summary: Refresh a service token description: Refreshes the expiration of a service token. operationId: access-service-tokens-refresh-a-service-token parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Refresh a service token response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Refresh a service token response content: application/json: schema: $ref: '#/components/schemas/access_service-tokens_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/service_tokens/{uuid}/rotate: post: tags: - Access service tokens summary: Rotate a service token description: Generates a new Client Secret for a service token and revokes the old one. operationId: access-service-tokens-rotate-a-service-token parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Rotate a service token response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Rotate a service token response content: application/json: schema: $ref: '#/components/schemas/access_create_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/tags: get: tags: - Access tags summary: List tags description: List tags operationId: access-tags-list-tags parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List tags response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List tags response content: application/json: schema: $ref: '#/components/schemas/access_tags_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Access tags summary: Create a tag description: Create a tag operationId: access-tags-create-tag parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/access_tag_without_app_count' responses: 4XX: description: Create a tag response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Create a tag response content: application/json: schema: $ref: '#/components/schemas/access_tags_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/tags/{name}: delete: tags: - Access tags summary: Delete a tag description: Delete a tag operationId: access-tags-delete-a-tag parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' - name: name in: path required: true schema: $ref: '#/components/schemas/access_tags_components-schemas-name' responses: 4XX: description: Delete a tag response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Delete a tag response content: application/json: schema: $ref: '#/components/schemas/access_name_response' security: - api_email: [] api_key: [] get: tags: - Access tags summary: Get a tag description: Get a tag operationId: access-tags-get-a-tag parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' - name: name in: path required: true schema: $ref: '#/components/schemas/access_tags_components-schemas-name' responses: 4XX: description: Get a tag response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get a tag response content: application/json: schema: $ref: '#/components/schemas/access_tags_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Access tags summary: Update a tag description: Update a tag operationId: access-tags-update-a-tag parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' - name: name in: path 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: description: Update a tag response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update a tag response content: application/json: schema: $ref: '#/components/schemas/access_tags_components-schemas-single_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/users: get: tags: - Zero Trust users summary: Get users description: Gets a list of users for an account. operationId: zero-trust-users-get-users parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get users response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get users response content: application/json: schema: $ref: '#/components/schemas/access_users_components-schemas-response_collection' security: - api_email: [] api_key: [] /accounts/{identifier}/access/users/{id}/active_sessions: get: tags: - Zero Trust users summary: Get active sessions description: Get active sessions for a single user. operationId: zero-trust-users-get-active-sessions parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get active sessions response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get active sessions response content: application/json: schema: $ref: '#/components/schemas/access_active_sessions_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/users/{id}/active_sessions/{nonce}: get: tags: - Zero Trust users summary: Get single active session description: Get an active session for a single user. operationId: zero-trust-users-get-active-session parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' - name: nonce in: path required: true schema: $ref: '#/components/schemas/access_nonce' responses: 4XX: description: Get active session response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get active session response content: application/json: schema: $ref: '#/components/schemas/access_active_session_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/users/{id}/failed_logins: get: tags: - Zero Trust users summary: Get failed logins description: Get all failed login attempts for a single user. operationId: zero-trust-users-get-failed-logins parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get failed logins response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get failed logins response content: application/json: schema: $ref: '#/components/schemas/access_failed_login_response' security: - api_email: [] api_key: [] /accounts/{identifier}/access/users/{id}/last_seen_identity: get: tags: - Zero Trust users summary: Get last seen identity description: Get last seen identity for a single user. operationId: zero-trust-users-get-last-seen-identity parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get active session response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get active session response content: application/json: schema: $ref: '#/components/schemas/access_last_seen_identity_response' security: - api_email: [] api_key: [] /certificates: get: tags: - Origin CA summary: List Certificates description: List all existing Origin CA certificates for a given zone. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)). operationId: origin-ca-list-certificates parameters: - name: identifier in: query schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: List Certificates response failure 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' "200": description: List Certificates response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_collection' security: - user_service_key: [] post: tags: - Origin CA summary: Create Certificate description: Create an Origin CA certificate. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)). operationId: origin-ca-create-certificate requestBody: required: true content: application/json: schema: type: object properties: csr: $ref: '#/components/schemas/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' responses: 4XX: description: Create Certificate response failure 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' "200": description: Create Certificate response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single' security: - user_service_key: [] /certificates/{certificate_id}: delete: tags: - Origin CA summary: Revoke Certificate description: Revoke an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)). operationId: origin-ca-revoke-certificate parameters: - name: certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Revoke Certificate response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single_id' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Revoke Certificate response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single_id' security: - user_service_key: [] get: tags: - Origin CA summary: Get Certificate description: Get an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)). operationId: origin-ca-get-certificate parameters: - name: certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Get Certificate response failure 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' "200": description: Get Certificate response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single' security: - user_service_key: [] /ips: get: tags: - Cloudflare IPs summary: Cloudflare/JD Cloud IP Details 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: - name: networks in: query description: Specified as `jdcloud` to list IPs used by JD Cloud data centers. schema: type: string responses: 4XX: description: Cloudflare IP Details response failure 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' "200": description: Cloudflare IP Details response 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' security: - api_token: [] - api_email: [] api_key: [] /memberships: get: tags: - User's Account Memberships summary: List Memberships description: List memberships of accounts the user can access. operationId: user'-s-account-memberships-list-memberships parameters: - name: account.name in: query schema: $ref: '#/components/schemas/iam_properties-name' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of memberships per page. default: 20 minimum: 5 maximum: 50 - name: order in: query schema: type: string description: Field to order memberships by. enum: - id - account.name - status example: status - name: direction in: query schema: type: string description: Direction to order memberships. enum: - asc - desc example: desc - name: name in: query schema: $ref: '#/components/schemas/iam_properties-name' - name: status in: query schema: type: string description: Status of this membership. enum: - accepted - pending - rejected example: accepted responses: 4XX: description: List Memberships response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_collection_membership_response' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: List Memberships response content: application/json: schema: $ref: '#/components/schemas/iam_collection_membership_response' security: - api_email: [] api_key: [] /memberships/{membership_id}: delete: tags: - User's Account Memberships summary: Delete Membership description: Remove the associated member from an account. operationId: user'-s-account-memberships-delete-membership parameters: - name: membership_id in: path required: true schema: $ref: '#/components/schemas/iam_membership_components-schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Membership response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: properties: id: $ref: '#/components/schemas/iam_membership_components-schemas-identifier' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Delete Membership response content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_api-response-single' - type: object properties: result: properties: id: $ref: '#/components/schemas/iam_membership_components-schemas-identifier' security: - api_email: [] api_key: [] get: tags: - User's Account Memberships summary: Membership Details description: Get a specific membership. operationId: user'-s-account-memberships-membership-details parameters: - name: membership_id in: path required: true schema: $ref: '#/components/schemas/iam_membership_components-schemas-identifier' responses: 4XX: description: Membership Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_single_membership_response' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Membership Details response content: application/json: schema: $ref: '#/components/schemas/iam_single_membership_response' security: - api_email: [] api_key: [] put: tags: - User's Account Memberships summary: Update Membership description: Accept or reject this account invitation. operationId: user'-s-account-memberships-update-membership parameters: - name: membership_id in: path required: true schema: $ref: '#/components/schemas/iam_membership_components-schemas-identifier' requestBody: required: true content: application/json: schema: required: - status properties: status: description: Whether to accept or reject this account invitation. enum: - accepted - rejected example: accepted responses: 4XX: description: Update Membership response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_single_membership_response' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Update Membership response content: application/json: schema: $ref: '#/components/schemas/iam_single_membership_response' security: - api_email: [] api_key: [] /organizations/{organization_id}/audit_logs: get: tags: - Audit Logs summary: Get organization audit logs 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: - name: organization_id in: path required: true schema: $ref: '#/components/schemas/aaa_identifier' - name: id in: query schema: type: string description: Finds a specific log by its ID. example: f174be97-19b1-40d6-954d-70cd5fbd52db - name: export in: query schema: type: boolean description: Indicates that this request is an export of logs in CSV format. example: true - name: action.type in: query schema: type: string description: Filters by the action type. example: add - name: actor.ip in: query schema: type: string 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 - name: actor.email in: query schema: type: string format: email description: Filters by the email address of the actor that made the change. example: alice@example.com - name: since in: query schema: type: string format: date-time description: Limits the returned results to logs newer than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339. example: "2019-04-30T01:12:20Z" - name: before in: query schema: type: string format: date-time description: Limits the returned results to logs older than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339. example: "2019-04-30T01:12:20Z" - name: zone.name in: query schema: type: string description: Filters by the name of the zone associated to the change. example: example.com - name: direction in: query schema: type: string description: Changes the direction of the chronological sorting. enum: - desc - asc default: desc example: desc - name: per_page in: query schema: type: number description: Sets the number of results to return per page. default: 100 example: 25 minimum: 1 maximum: 1000 - name: page in: query schema: type: number description: Defines which page of results to return. default: 1 example: 50 minimum: 1 - name: hide_user_logs in: query schema: type: boolean description: Indicates whether or not to hide user level audit logs. default: false responses: 4XX: description: Get organization audit logs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_audit_logs_response_collection' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Get organization audit logs response content: application/json: schema: $ref: '#/components/schemas/aaa_audit_logs_response_collection' deprecated: true security: - api_token: [] - api_email: [] api_key: [] /radar/annotations/outages: get: tags: - Radar Annotations summary: Get latest Internet outages and anomalies. operationId: radar-get-annotations-outages parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: offset in: query schema: type: integer description: Number of objects to skip before grabbing results. - name: dateRange in: query schema: type: string description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: asn in: query schema: type: integer description: Single ASN as integer. example: "174" - name: location in: query schema: type: string description: Location Alpha2 code. example: US - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - annotations properties: annotations: type: array items: type: object required: - id - dataSource - startDate - asns - asnsDetails - locations - locationsDetails - eventType - outage properties: asns: type: array items: type: integer example: 189 asnsDetails: type: array items: type: object required: - asn - name properties: asn: type: string example: "189" locations: type: object required: - code - name properties: code: type: string example: US name: type: string example: United States name: type: string example: LUMEN-LEGACY-L3-PARTITION dataSource: type: string example: ALL description: type: string example: example endDate: type: string example: "2022-09-08T10:00:28Z" eventType: type: string example: OUTAGE id: type: string example: "550" linkedUrl: type: string example: http://example.com locations: type: array items: type: string example: US locationsDetails: type: array items: type: object required: - code - name properties: code: type: string example: US name: type: string example: United States outage: type: object required: - outageCause - outageType properties: outageCause: type: string example: CABLE_CUT outageType: type: string example: NATIONWIDE scope: type: string example: Colima, Michoacán, México startDate: type: string example: "2022-09-06T10:00:28Z" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/annotations/outages/locations: get: tags: - Radar Annotations summary: Get the number of outages for locations. operationId: radar-get-annotations-outages-top parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: dateRange in: query schema: type: string description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - annotations properties: annotations: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: PT clientCountryName: type: string example: Portugal value: type: string example: "5" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/summary/dnssec: get: tags: - Radar AS112 summary: Get AS112 DNSSEC Summary description: Percentage distribution of DNS queries to AS112 by DNSSEC support. operationId: radar-get-dns-as112-timeseries-by-dnssec parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - SUPPORTED - NOT_SUPPORTED properties: NOT_SUPPORTED: type: string example: "16" SUPPORTED: type: string example: "84" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/summary/edns: get: tags: - Radar AS112 summary: Get AS112 EDNS Summary description: Percentage distribution of DNS queries, to AS112, by EDNS support. operationId: radar-get-dns-as112-timeseries-by-edns parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - SUPPORTED - NOT_SUPPORTED properties: NOT_SUPPORTED: type: string example: "6" SUPPORTED: type: string example: "94" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/summary/ip_version: get: tags: - Radar AS112 summary: Get AS112 IP Version Summary description: Percentage distribution of DNS queries to AS112 per IP Version. operationId: radar-get-dns-as112-timeseries-by-ip-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: string example: "80" IPv6: type: string example: "20" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/summary/protocol: get: tags: - Radar AS112 summary: Get AS112 DNS Protocol Summary description: Percentage distribution of DNS queries to AS112 per protocol. operationId: radar-get-dns-as112-timeseries-by-protocol parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - udp - tcp properties: tcp: type: string example: "1" udp: type: string example: "99" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/summary/query_type: get: tags: - Radar AS112 summary: Get AS112 Query Types Summary description: Percentage distribution of DNS queries to AS112 by Query Type. operationId: radar-get-dns-as112-timeseries-by-query-type parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - PTR - A - SOA - AAAA - SRV properties: A: type: string example: "19" AAAA: type: string example: "1" PTR: type: string example: "74" SOA: type: string example: "5" SRV: type: string example: "1" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/summary/response_codes: get: tags: - Radar AS112 summary: Get a summary of AS112 Response Codes description: Percentage distribution of AS112 dns requests classified per Response Codes. operationId: radar-get-dns-as112-timeseries-by-response-codes parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - NXDOMAIN - NOERROR properties: NOERROR: type: string example: "6" NXDOMAIN: type: string example: "94" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries: get: tags: - Radar AS112 summary: Get AS112 DNS Queries Time Series description: Get AS112 queries change over time. operationId: radar-get-dns-as112-timeseries parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - values properties: timestamps: type: array items: type: string format: date-time values: type: array items: type: string example: 0.56 success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries_groups/dnssec: get: tags: - Radar AS112 summary: Get AS112 DNSSEC Support Time Series description: Percentage distribution of DNS AS112 queries by DNSSEC support over time. operationId: radar-get-dns-as112-timeseries-group-by-dnssec parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - SUPPORTED - NOT_SUPPORTED properties: NOT_SUPPORTED: type: array items: type: string example: "16" SUPPORTED: type: array items: type: string example: "84" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries_groups/edns: get: tags: - Radar AS112 summary: Get AS112 EDNS Support Summary description: Percentage distribution of AS112 DNS queries by EDNS support over time. operationId: radar-get-dns-as112-timeseries-group-by-edns parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - SUPPORTED - NOT_SUPPORTED properties: NOT_SUPPORTED: type: array items: type: string example: "6" SUPPORTED: type: array items: type: string example: "94" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries_groups/ip_version: get: tags: - Radar AS112 summary: Get AS112 IP Version Time Series description: Percentage distribution of AS112 DNS queries by IP Version over time. operationId: radar-get-dns-as112-timeseries-group-by-ip-version parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: array items: type: string example: "80" IPv6: type: array items: type: string example: "20" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries_groups/protocol: get: tags: - Radar AS112 summary: Get AS112 DNS Protocol Time Series description: Percentage distribution of AS112 dns requests classified per Protocol over time. operationId: radar-get-dns-as112-timeseries-group-by-protocol parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - udp - tcp properties: tcp: type: array items: type: string example: "1" udp: type: array items: type: string example: "99" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries_groups/query_type: get: tags: - Radar AS112 summary: Get AS112 Query Types Time Series description: Percentage distribution of AS112 DNS queries by Query Type over time. operationId: radar-get-dns-as112-timeseries-group-by-query-type parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - PTR - A - SOA - AAAA - SRV properties: A: type: array items: type: string example: "19" AAAA: type: array items: type: string example: "1" PTR: type: array items: type: string example: "74" SOA: type: array items: type: string example: "5" SRV: type: array items: type: string example: "1" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries_groups/response_codes: get: tags: - Radar AS112 summary: Get a time series of AS112 Response Codes description: Percentage distribution of AS112 dns requests classified per Response Codes over time. operationId: radar-get-dns-as112-timeseries-group-by-response-codes parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NXDOMAIN - NOERROR properties: NOERROR: type: array items: type: string example: "6" NXDOMAIN: type: array items: type: string example: "94" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/top/locations: get: tags: - Radar AS112 summary: Get top autonomous systems by AS112 DNS queries 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/as112/top/locations/dnssec/{dnssec}: get: tags: - Radar AS112 summary: Get Top Locations By DNS Queries DNSSEC Support description: Get the top locations by DNS queries DNSSEC support to AS112. operationId: radar-get-dns-as112-top-locations-by-dnssec parameters: - name: dnssec in: path required: true schema: type: string description: DNSSEC. enum: - SUPPORTED - NOT_SUPPORTED example: SUPPORTED - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/as112/top/locations/edns/{edns}: get: tags: - Radar AS112 summary: Get Top Locations By EDNS Support description: Get the top locations, by DNS queries EDNS support to AS112. operationId: radar-get-dns-as112-top-locations-by-edns parameters: - name: edns in: path required: true schema: type: string description: EDNS. enum: - SUPPORTED - NOT_SUPPORTED example: SUPPORTED - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/as112/top/locations/ip_version/{ip_version}: get: tags: - Radar AS112 summary: Get Top Locations by DNS Queries IP version description: Get the top locations by DNS queries IP version to AS112. operationId: radar-get-dns-as112-top-locations-by-ip-version parameters: - name: ip_version in: path required: true schema: type: string description: IP Version. enum: - IPv4 - IPv6 example: IPv4 - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/summary: get: tags: - Radar Attacks summary: Get Layer 3 Attacks Summary description: Percentage distribution of network protocols in layer 3/4 attacks over a given time period. operationId: radar-get-attacks-layer3-summary parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" summary_0: type: object required: - tcp - udp - gre - icmp properties: gre: type: string example: "0.9" icmp: type: string example: "0.1" tcp: type: string example: "60" udp: type: string example: "39" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false deprecated: true security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/summary/bitrate: get: tags: - Radar Attacks summary: Get Attack Bitrate Summary description: Percentage distribution of attacks by bitrate. operationId: radar-get-attacks-layer3-summary-by-bitrate parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - UNDER_500_MBPS - OVER_100_GBPS - _1_GBPS_TO_10_GBPS - _500_MBPS_TO_1_GBPS - _10_GBPS_TO_100_GBPS properties: _1_GBPS_TO_10_GBPS: type: string example: "6.007082" _10_GBPS_TO_100_GBPS: type: string example: "0.01056" _500_MBPS_TO_1_GBPS: type: string example: "5.948652" OVER_100_GBPS: type: string example: "13.141944" UNDER_500_MBPS: type: string example: "74.891763" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/summary/duration: get: tags: - Radar Attacks summary: Get Attack Durations Summary description: Percentage distribution of attacks by duration. operationId: radar-get-attacks-layer3-summary-by-duration parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object 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 properties: _1_HOUR_TO_3_HOURS: type: string example: "4.038413" _10_MINS_TO_20_MINS: type: string example: "9.48709" _20_MINS_TO_40_MINS: type: string example: "3.87624" _40_MINS_TO_1_HOUR: type: string example: "1.892012" OVER_3_HOURS: type: string example: "4.462923" UNDER_10_MINS: type: string example: "76.243322" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/summary/ip_version: get: tags: - Radar Attacks summary: Get IP Versions Summary description: Percentage distribution of attacks by ip version used. operationId: radar-get-attacks-layer3-summary-by-ip-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: string example: "99.984766" IPv6: type: string example: "0.015234" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/summary/protocol: get: tags: - Radar Attacks summary: Get Layer 3 Protocols Summary description: Percentage distribution of attacks by protocol used. operationId: radar-get-attacks-layer3-summary-by-protocol parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - TCP - UDP - GRE - ICMP properties: GRE: type: string example: "0.756379" ICMP: type: string example: "0.015245" TCP: type: string example: "82.89908" UDP: type: string example: "16.328986" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/summary/vector: get: tags: - Radar Attacks summary: Get Attack Vector Summary description: Percentage distribution of attacks by vector. operationId: radar-get-attacks-layer3-summary-by-vector parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object example: ACK Flood: - "65.662148" SYN Flood: - "16.86401" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries: get: tags: - Radar Attacks summary: Get Attacks By Bytes Summary description: Get attacks change over time by bytes. operationId: radar-get-attacks-layer3-timeseries-by-bytes parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE_CHANGE - MIN0_MAX example: MIN0_MAX - name: metric in: query schema: type: string description: Measurement units, eg. bytes. enum: - BYTES - BYTES_OLD default: bytes - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - values properties: timestamps: type: array items: type: string values: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups: get: tags: - Radar Attacks summary: Get Layer 3 Attacks By Network Protocol Time Series description: Get a timeseries of the percentage distribution of network protocols in Layer 3/4 attacks. operationId: radar-get-attacks-layer3-timeseries-groups parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - udp - tcp - gre - icmp properties: gre: type: array items: type: string example: "0.9" icmp: type: array items: type: string example: "0.1" tcp: type: array items: type: string example: "70" timestamps: type: array items: type: string udp: type: array items: type: string example: "29" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false deprecated: true security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/bitrate: get: tags: - Radar Attacks summary: Get Attacks By Bitrate Time Series description: Percentage distribution of attacks by bitrate over time. operationId: radar-get-attacks-layer3-timeseries-group-by-bitrate parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - UNDER_500_MBPS - OVER_100_GBPS - _1_GBPS_TO_10_GBPS - _500_MBPS_TO_1_GBPS - _10_GBPS_TO_100_GBPS properties: _1_GBPS_TO_10_GBPS: type: array items: type: string _10_GBPS_TO_100_GBPS: type: array items: type: string _500_MBPS_TO_1_GBPS: type: array items: type: string OVER_100_GBPS: type: array items: type: string UNDER_500_MBPS: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/duration: get: tags: - Radar Attacks summary: Get Layer 3 Attack By Duration Time Series description: Percentage distribution of attacks by duration over time. operationId: radar-get-attacks-layer3-timeseries-group-by-duration parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object 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 properties: _1_HOUR_TO_3_HOURS: type: array items: type: string _10_MINS_TO_20_MINS: type: array items: type: string _20_MINS_TO_40_MINS: type: array items: type: string _40_MINS_TO_1_HOUR: type: array items: type: string OVER_3_HOURS: type: array items: type: string UNDER_10_MINS: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/industry: get: tags: - Radar Attacks summary: Get Layer 3 Attacks By Target Industries Time Series description: Percentage distribution of attacks by industry used over time. operationId: radar-get-attacks-layer3-timeseries-group-by-industry parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: limitPerGroup in: query schema: type: integer description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range. example: 4 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: Internet: - "5.519081" timestamps: - "2023-08-08T10:15:00Z" required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/ip_version: get: tags: - Radar Attacks summary: Get Layer 3 Attacks By IP Version Time Series description: Percentage distribution of attacks by ip version used over time. operationId: radar-get-attacks-layer3-timeseries-group-by-ip-version parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - IPv4 - IPv6 properties: IPv4: type: array items: type: string IPv6: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/protocol: get: tags: - Radar Attacks summary: Get Layer 3 Attacks By Protocol Timeseries description: Percentage distribution of attacks by protocol used over time. operationId: radar-get-attacks-layer3-timeseries-group-by-protocol parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - TCP - UDP - GRE - ICMP properties: GRE: type: array items: type: string ICMP: type: array items: type: string TCP: type: array items: type: string UDP: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/vector: get: tags: - Radar Attacks summary: Get Layer 3 Attacks By Vector description: Percentage distribution of attacks by vector used over time. operationId: radar-get-attacks-layer3-timeseries-group-by-vector parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: limitPerGroup in: query schema: type: integer description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range. example: 4 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: ACK Flood: - "97.28898" timestamps: - "2023-08-08T10:15:00Z" required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/vertical: get: tags: - Radar Attacks summary: Get Layer 3 Attacks By Vertical Time Series description: Percentage distribution of attacks by vertical used over time. operationId: radar-get-attacks-layer3-timeseries-group-by-vertical parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: limitPerGroup in: query schema: type: integer description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range. example: 4 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: Internet and Telecom: - "5.519081" timestamps: - "2023-08-08T10:15:00Z" required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/top/attacks: get: tags: - Radar Attacks summary: Get top attack pairs (origin and target locations) of Layer 3 attacks 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: limitDirection in: query schema: type: string description: Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location. enum: - ORIGIN - TARGET default: ORIGIN example: ORIGIN - name: limitPerLocation in: query schema: type: integer description: Limit the number of attacks per origin/target (refer to `limitDirection` parameter) location. example: 10 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - originCountryAlpha2 - originCountryName - value properties: originCountryAlpha2: type: string example: FR originCountryName: type: string example: France value: type: string example: "4.323214" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/top/industry: get: tags: - Radar Attacks summary: Get top Industry of attack description: Get the Industry of attacks. operationId: radar-get-attacks-layer3-top-industries parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - name - value properties: name: type: string example: Computer Software value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/top/locations/origin: get: tags: - Radar Attacks summary: Get top origin locations of attack description: Get the origin locations of attacks. operationId: radar-get-attacks-layer3-top-origin-locations parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - originCountryAlpha2 - originCountryName - value - rank properties: originCountryAlpha2: type: string example: FR originCountryName: type: string example: France rank: type: number example: 1 value: type: string example: "4.323214" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/top/locations/target: get: tags: - Radar Attacks summary: Get top target locations of attack description: Get the target locations of attacks. operationId: radar-get-attacks-layer3-top-target-locations parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - targetCountryAlpha2 - targetCountryName - value - rank properties: rank: type: number example: 1 targetCountryAlpha2: type: string example: FR targetCountryName: type: string example: France value: type: string example: "4.323214" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/top/vertical: get: tags: - Radar Attacks summary: Get top Verticals of attack description: Get the Verticals of attacks. operationId: radar-get-attacks-layer3-top-verticals parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - name - value properties: name: type: string example: Internet and Telecom value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/summary: get: tags: - Radar Attacks summary: Get Layer 7 Attacks Summary description: Percentage distribution of mitigation techniques in Layer 7 attacks. operationId: radar-get-attacks-layer7-summary parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" summary_0: type: object required: - WAF - DDOS - IP_REPUTATION - ACCESS_RULES - BOT_MANAGEMENT - API_SHIELD - DATA_LOSS_PREVENTION properties: ACCESS_RULES: type: string example: "0.9" API_SHIELD: type: string example: "0.9" BOT_MANAGEMENT: type: string example: "0.9" DATA_LOSS_PREVENTION: type: string example: "0.9" DDOS: type: string example: "34" IP_REPUTATION: type: string example: "0.1" WAF: type: string example: "65" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false deprecated: true security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/summary/http_method: get: tags: - Radar Attacks summary: Get HTTP Method Summary description: Percentage distribution of attacks by http method used. operationId: radar-get-attacks-layer7-summary-by-http-method parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - GET - POST properties: GET: type: string example: "99.100257" POST: type: string example: "0.899743" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/summary/http_version: get: tags: - Radar Attacks summary: Get HTTP Version Summary description: Percentage distribution of attacks by http version used. operationId: radar-get-attacks-layer7-summary-by-http-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string 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 - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - HTTP/2 - HTTP/1.x - HTTP/3 properties: HTTP/1.x: type: string example: "21.722365" HTTP/2: type: string example: "77.056555" HTTP/3: type: string example: "1.22108" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/summary/ip_version: get: tags: - Radar Attacks summary: Get Ip Version Summary description: Percentage distribution of attacks by ip version used. operationId: radar-get-attacks-layer7-summary-by-ip-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string 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 - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: string example: "99.935733" IPv6: type: string example: "0.064267" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/summary/managed_rules: get: tags: - Radar Attacks summary: Get Managed Rules Summary description: Percentage distribution of attacks by managed rules used. operationId: radar-get-attacks-layer7-summary-by-managed-rules parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string 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 - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - HTTP Anomaly - Bot properties: Bot: type: string example: "14.285714" HTTP Anomaly: type: string example: "85.714286" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/summary/mitigation_product: get: tags: - Radar Attacks summary: Get Mitigation Product Summary description: Percentage distribution of attacks by mitigation product used. operationId: radar-get-attacks-layer7-summary-by-mitigation-product parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string 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 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - WAF - DDOS properties: DDOS: type: string example: "24.421594" WAF: type: string example: "53.213368" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries: get: tags: - Radar Attacks summary: Get Layer 7 Attacks Time Series 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: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: attack in: query schema: type: array description: Array of L7 attack types. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE_CHANGE - MIN0_MAX example: MIN0_MAX - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - values properties: timestamps: type: array items: type: string format: date-time values: type: array items: type: string example: 0.56 success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups: get: tags: - Radar Attacks summary: Get Layer 7 Attacks By Mitigation Technique Time Series description: Get a time series of the percentual distribution of mitigation techniques, over time. operationId: radar-get-attacks-layer7-timeseries-group parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - WAF - DDOS - IP_REPUTATION - ACCESS_RULES - BOT_MANAGEMENT - API_SHIELD - DATA_LOSS_PREVENTION properties: ACCESS_RULES: type: array items: type: string example: "5" API_SHIELD: type: array items: type: string example: "5" BOT_MANAGEMENT: type: array items: type: string example: "5" DATA_LOSS_PREVENTION: type: array items: type: string example: "5" DDOS: type: array items: type: string example: "60" IP_REPUTATION: type: array items: type: string example: "5" WAF: type: array items: type: string example: "30" timestamps: type: array items: type: string format: date-time success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false deprecated: true security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/http_method: get: tags: - Radar Attacks summary: Get Layer 7 Attacks By HTTP Method Time Series description: Percentage distribution of attacks by http method used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-http-method parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - GET properties: GET: type: array items: type: string example: "70.970199" timestamps: type: array items: type: string example: "2023-10-01T00:00:00Z" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/http_version: get: tags: - Radar Attacks summary: Get Layer 7 Attacks By HTTP Version Time Series description: Percentage distribution of attacks by http version used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-http-version parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string 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 - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - HTTP/1.x properties: HTTP/1.x: type: array items: type: string example: "50.338734" timestamps: type: array items: type: string example: "2023-10-01T00:00:00Z" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/industry: get: tags: - Radar Attacks summary: Get Layer 7 Attacks By Target Industries Time Series description: Percentage distribution of attacks by industry used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-industry parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string 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 - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: limitPerGroup in: query schema: type: integer description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range. example: 4 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: Internet: - "5.519081" timestamps: - "2023-08-08T10:15:00Z" required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/ip_version: get: tags: - Radar Attacks summary: Get Layer 7 Attacks By IP Version Time Series description: Percentage distribution of attacks by ip version used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-ip-version parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string 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 - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - IPv4 - IPv6 properties: IPv4: type: array items: type: string example: "99.935733" IPv6: type: array items: type: string example: "0.064267" timestamps: type: array items: type: string example: "2023-10-01T00:00:00Z" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/managed_rules: get: tags: - Radar Attacks summary: Get Layer 7 Attacks By Managed Rules Time Series description: Percentage distribution of attacks by managed rules used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-managed-rules parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string 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 - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - Bot properties: Bot: type: array items: type: string example: "0.324198" timestamps: type: array items: type: string example: "2023-10-01T00:00:00Z" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/mitigation_product: get: tags: - Radar Attacks summary: Get Layer 7 Attacks By Mitigation Product Time Series description: Percentage distribution of attacks by mitigation product used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-mitigation-product parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string 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 - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - DDOS properties: DDOS: type: array items: type: string example: "48.926354" timestamps: type: array items: type: string example: "2023-10-01T00:00:00Z" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/vertical: get: tags: - Radar Attacks summary: Get Layer 7 Attacks By Vertical Time Series description: Percentage distribution of attacks by vertical used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-vertical parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string 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 - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: limitPerGroup in: query schema: type: integer description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range. example: 4 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: Internet and Telecom: - "5.519081" timestamps: - "2023-08-08T10:15:00Z" required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/top/ases/origin: get: tags: - Radar Attacks summary: Get Top Origin Autonomous Systems By Layer 7 Attacks 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - originAsnName - originAsn - value - rank properties: originAsn: type: string example: "55836" originAsnName: type: string example: RELIANCEJIO-IN Reliance Jio Infocomm Limited rank: type: number example: 1 value: type: string example: "4.323214" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/top/attacks: get: tags: - Radar Attacks summary: Get Top Attack Pairs (origin and target locations) By Layer 7 Attacks 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: limitDirection in: query schema: type: string description: Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location. enum: - ORIGIN - TARGET default: ORIGIN example: ORIGIN - name: limitPerLocation in: query schema: type: integer description: Limit the number of attacks per origin/target (refer to `limitDirection` parameter) location. example: 10 - name: magnitude in: query schema: type: string description: Attack magnitude can be defined by total requests mitigated or by total zones attacked. enum: - AFFECTED_ZONES - MITIGATED_REQUESTS example: MITIGATED_REQUESTS - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - originCountryAlpha2 - originCountryName - targetCountryAlpha2 - targetCountryName - value properties: originCountryAlpha2: type: string example: US originCountryName: type: string example: United States targetCountryAlpha2: type: string example: FR targetCountryName: type: string example: France value: type: string example: "4.323214" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/top/industry: get: tags: - Radar Attacks summary: Get top Industry of attack description: Get the Industry of attacks. operationId: radar-get-attacks-layer7-top-industries parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - name - value properties: name: type: string example: Computer Software value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/top/locations/origin: get: tags: - Radar Attacks summary: Get Top Origin Locations By Layer 7 Attacks 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - originCountryAlpha2 - originCountryName - value - rank properties: originCountryAlpha2: type: string example: FR originCountryName: type: string example: France rank: type: number example: 1 value: type: string example: "4.323214" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/top/locations/target: get: tags: - Radar Attacks summary: Get layer 7 top target locations description: Get the top target locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The target location is determined by the attacked zone's billing country, when available. operationId: radar-get-attacks-layer7-top-target-location parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - targetCountryAlpha2 - targetCountryName - value - rank properties: rank: type: number example: 1 targetCountryAlpha2: type: string example: FR targetCountryName: type: string example: France value: type: string example: "4.323214" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/top/vertical: get: tags: - Radar Attacks summary: Get top Verticals of attack description: Get the Verticals of attacks. operationId: radar-get-attacks-layer7-top-verticals parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - name - value properties: name: type: string example: Internet and Telecom value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/bgp/hijacks/events: get: tags: - Radar BGP summary: Get BGP hijack events description: Get the BGP hijack events. (Beta) operationId: radar-get-bgp-hijacks-events parameters: - name: page in: query schema: type: integer description: Current page number, starting from 1 - name: per_page in: query schema: type: integer description: Number of entries per page - name: eventId in: query schema: type: integer description: The unique identifier of a event - name: hijackerAsn in: query schema: type: integer description: The potential hijacker AS of a BGP hijack event - name: victimAsn in: query schema: type: integer description: The potential victim AS of a BGP hijack event - name: involvedAsn in: query schema: type: integer description: The potential hijacker or victim AS of a BGP hijack event - name: involvedCountry in: query schema: type: string description: The country code of the potential hijacker or victim AS of a BGP hijack event - name: prefix in: query schema: type: string description: The prefix hijacked during a BGP hijack event - name: minConfidence in: query schema: type: integer description: The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high) - name: maxConfidence in: query schema: type: integer description: The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high) - name: dateRange in: query schema: type: string description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: sortBy in: query schema: type: string description: Sort events by field enum: - ID - TIME - CONFIDENCE example: TIME - name: sortOrder in: query schema: type: string description: Sort order enum: - ASC - DESC example: DESC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - result_info - success properties: result: type: object required: - asn_info - events - total_monitors properties: asn_info: type: array items: type: object required: - asn - org_name - country_code properties: asn: type: integer country_code: type: string org_name: type: string events: type: array items: type: object 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 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: type: array items: type: integer peer_ip_count: type: integer prefixes: type: array items: type: string tags: type: array items: type: object required: - name - score properties: name: type: string score: type: integer victim_asns: type: array items: type: integer victim_countries: type: array items: type: string total_monitors: type: integer result_info: type: object required: - count - total_count - page - per_page properties: count: type: integer page: type: integer per_page: type: integer total_count: type: integer success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/leaks/events: get: tags: - Radar BGP summary: Get BGP route leak events description: Get the BGP route leak events (Beta). operationId: radar-get-bgp-route-leak-events parameters: - name: page in: query schema: type: integer description: Current page number, starting from 1 - name: per_page in: query schema: type: integer description: Number of entries per page - name: eventId in: query schema: type: integer description: The unique identifier of a event - name: leakAsn in: query schema: type: integer description: The leaking AS of a route leak event - name: involvedAsn in: query schema: type: integer description: ASN that is causing or affected by a route leak event - name: involvedCountry in: query schema: type: string description: Country code of a involved ASN in a route leak event - name: dateRange in: query schema: type: string description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: sortBy in: query schema: type: string description: Sort events by field enum: - ID - LEAKS - PEERS - PREFIXES - ORIGINS - TIME example: TIME - name: sortOrder in: query schema: type: string description: Sort order enum: - ASC - DESC example: DESC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - result_info - success properties: result: type: object required: - asn_info - events properties: asn_info: type: array items: type: object required: - asn - org_name - country_code properties: asn: type: integer country_code: type: string org_name: type: string events: type: array items: type: object required: - detected_ts - finished - id - leak_asn - leak_count - leak_seg - leak_type - max_ts - min_ts - origin_count - peer_count - prefix_count - countries properties: countries: type: array items: type: string detected_ts: type: string finished: type: boolean id: type: integer leak_asn: type: integer leak_count: type: integer leak_seg: type: array items: type: integer leak_type: type: integer max_ts: type: string min_ts: type: string origin_count: type: integer peer_count: type: integer prefix_count: type: integer result_info: type: object required: - count - total_count - page - per_page properties: count: type: integer page: type: integer per_page: type: integer total_count: type: integer success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/routes/moas: get: tags: - Radar BGP summary: Get MOASes description: List all Multi-origin AS (MOAS) prefixes on the global routing tables. operationId: radar-get-bgp-pfx2as-moas parameters: - name: origin in: query schema: type: integer description: Lookup MOASes originated by the given ASN - name: prefix in: query schema: type: string description: Lookup MOASes by prefix - name: invalid_only in: query schema: type: boolean description: Lookup only RPKI invalid MOASes - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - moas - meta properties: meta: type: object required: - data_time - query_time - total_peers properties: data_time: type: string query_time: type: string total_peers: type: integer moas: type: array items: type: object required: - prefix - origins properties: origins: type: array items: type: object required: - origin - peer_count - rpki_validation properties: origin: type: integer peer_count: type: integer rpki_validation: type: string prefix: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/routes/pfx2as: get: tags: - Radar BGP summary: Get prefix-to-ASN mapping description: Lookup prefix-to-ASN mapping on global routing tables. operationId: radar-get-bgp-pfx2as parameters: - name: origin in: query schema: type: integer description: Lookup prefixes originated by the given ASN - name: prefix in: query schema: type: string description: Lookup origin ASNs of the given prefix example: 1.1.1.0/24 - name: rpkiStatus in: query schema: type: string description: 'Return only results with matching rpki status: valid, invalid or unknown' enum: - VALID - INVALID - UNKNOWN example: INVALID - name: longestPrefixMatch in: query schema: type: boolean 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" - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - prefix_origins - meta properties: meta: type: object required: - data_time - query_time - total_peers properties: data_time: type: string query_time: type: string total_peers: type: integer prefix_origins: type: array items: type: object required: - origin - peer_count - prefix - rpki_validation properties: origin: type: integer peer_count: type: integer prefix: type: string rpki_validation: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/routes/stats: get: tags: - Radar BGP summary: 'Get BGP routing table stats ' description: Get the BGP routing table stats (Beta). operationId: radar-get-bgp-routes-stats parameters: - name: asn in: query schema: type: integer description: Single ASN as integer. example: "174" - name: location in: query schema: type: string description: Location Alpha2 code. example: US - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - stats - meta properties: meta: type: object required: - data_time - query_time - total_peers properties: data_time: type: string query_time: type: string total_peers: type: integer stats: type: object 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 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 success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/routes/timeseries: get: tags: - Radar BGP summary: Get BGP IP space time series 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-ip-space-timeseries parameters: - name: dateRange in: query schema: type: string description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: asn in: query schema: type: integer description: Single ASN as integer. example: "174" - name: location in: query schema: type: string description: Location Alpha2 code. example: US - name: includeDelay in: query schema: type: boolean description: Include data delay meta information example: "true" - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_ipv4_24s - serie_ipv6_48s properties: meta: type: object required: - dateRange properties: dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" serie_ipv4_24s: type: object required: - timestamps - values properties: timestamps: type: array items: type: string format: date-time values: type: array items: type: integer example: 30 serie_ipv6_48s: type: object required: - timestamps - values properties: timestamps: type: array items: type: string format: date-time values: type: array items: type: integer example: 1234 success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/timeseries: get: tags: - Radar BGP summary: Get BGP time series description: Gets BGP updates change over time. Raw values are returned. When requesting updates of an autonomous system (AS), only BGP updates of type announcement are returned. operationId: radar-get-bgp-timeseries parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: prefix in: query schema: type: array description: Array of BGP network prefixes. example: 1.1.1.0/24 items: type: string - name: updateType in: query schema: type: array description: Array of BGP update types. example: ANNOUNCEMENT items: type: string enum: - ANNOUNCEMENT - WITHDRAWAL - name: asn in: query schema: 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. example: "15169" items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - values properties: timestamps: type: array items: type: string format: date-time values: type: array items: type: string example: 0.56 success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/top/ases: get: tags: - Radar BGP summary: Get top autonomous systems description: Get the top autonomous systems (AS) by BGP updates (announcements only). Values are a percentage out of the total updates. operationId: radar-get-bgp-top-ases parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: prefix in: query schema: type: array description: Array of BGP network prefixes. example: 1.1.1.0/24 items: type: string - name: updateType in: query schema: type: array description: Array of BGP update types. example: ANNOUNCEMENT items: type: string enum: - ANNOUNCEMENT - WITHDRAWAL - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange properties: dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" top_0: type: array items: type: object required: - asn - ASName - value properties: ASName: type: string example: Apple-Engineering asn: type: integer example: 714 value: type: string description: Percentage of updates by this AS out of the total updates by all autonomous systems. example: "0.73996" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/top/ases/prefixes: get: tags: - Radar BGP summary: Get list of ASNs ordered by prefix count 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: - name: country in: query schema: type: string description: Alpha-2 country code. example: NZ - name: limit in: query schema: type: integer description: Maximum number of ASes to return example: 10 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - asns - meta properties: asns: type: array items: type: object required: - asn - country - name - pfxs_count properties: asn: type: integer country: type: string name: type: string pfxs_count: type: integer meta: type: object required: - data_time - query_time - total_peers properties: data_time: type: string query_time: type: string total_peers: type: integer success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/bgp/top/prefixes: get: tags: - Radar BGP summary: Get top prefixes description: Get the top network prefixes by BGP updates. Values are a percentage out of the total BGP updates. operationId: radar-get-bgp-top-prefixes parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: updateType in: query schema: type: array description: Array of BGP update types. example: ANNOUNCEMENT items: type: string enum: - ANNOUNCEMENT - WITHDRAWAL - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange properties: dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" top_0: type: array items: type: object required: - prefix - value properties: prefix: type: string example: 2804:77cc:8000::/33 value: type: string example: "0.73996" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/connection_tampering/summary: get: tags: - Radar Connection Tampering summary: Get Connection Tampering Summary description: Distribution of connection tampering types over a given time period. operationId: radar-get-connection-tampering-summary parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" summary_0: type: object required: - no_match - post_syn - post_ack - post_psh - later_in_flow properties: later_in_flow: type: string description: Connections matching signatures for tampering later in the connection, after the transfer of multiple data packets. example: "10" no_match: type: string description: Connections that do not match any tampering signatures. example: "65" post_ack: type: string description: Connections matching signatures for tampering after the receipt of a SYN packet and ACK packet, meaning the TCP connection was successfully established but the server did not receive any subsequent packets. example: "5" post_psh: type: string description: Connections matching signatures for tampering after the receipt of a packet with PSH flag set, following connection establishment. example: "10" post_syn: type: string description: Connections matching signatures for tampering after the receipt of only a single SYN packet, and before the handshake completes. example: "10" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/connection_tampering/timeseries_groups: get: tags: - Radar Connection Tampering summary: Get Connection Tampering Time Series description: Distribution of connection tampering types over time. operationId: radar-get-connection-tampering-timeseries-group parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - no_match - post_syn - post_ack - post_psh - later_in_flow properties: later_in_flow: type: array description: Connections matching signatures for tampering later in the connection, after the transfer of multiple data packets. items: type: string description: Connections matching signatures for tampering later in the connection, after the transfer of multiple data packets. example: "10" no_match: type: array description: Connections that do not match any tampering signatures. items: type: string description: Connections that do not match any tampering signatures. example: "65" post_ack: type: array description: Connections matching signatures for tampering after the receipt of a SYN packet and ACK packet, meaning the TCP connection was successfully established but the server did not receive any subsequent packets. items: type: string description: Connections matching signatures for tampering after the receipt of a SYN packet and ACK packet, meaning the TCP connection was successfully established but the server did not receive any subsequent packets. example: "5" post_psh: type: array description: Connections matching signatures for tampering after the receipt of a packet with PSH flag set, following connection establishment. items: type: string description: Connections matching signatures for tampering after the receipt of a packet with PSH flag set, following connection establishment. example: "10" post_syn: type: array description: Connections matching signatures for tampering after the receipt of only a single SYN packet, and before the handshake completes. items: type: string description: Connections matching signatures for tampering after the receipt of only a single SYN packet, and before the handshake completes. example: "10" timestamps: type: array items: type: string format: date-time success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/datasets: get: tags: - Radar Datasets summary: Get Datasets description: Get a list of datasets. operationId: radar-get-reports-datasets parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: offset in: query schema: type: integer description: Number of objects to skip before grabbing results. - name: datasetType in: query schema: type: string description: Dataset type. enum: - RANKING_BUCKET - REPORT default: RANKING_BUCKET example: RANKING_BUCKET - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - datasets properties: datasets: type: array items: type: object required: - id - title - description - type - tags - meta properties: description: type: string example: This dataset contains a list of the op 20000 domains globally id: type: integer example: 3 meta: type: object tags: type: array items: type: string example: global title: type: string example: Top bucket 20000 domains type: type: string example: RANKING_BUCKET success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/datasets/{alias}: get: tags: - Radar Datasets summary: Get Dataset csv Stream 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: - name: alias in: path required: true schema: type: string description: Dataset alias or id example: ranking_top_1000 - name: date in: query schema: type: string description: Filter dataset alias by date nullable: true responses: "200": description: Successful Response content: text/csv: schema: type: string "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/datasets/download: post: tags: - Radar Datasets summary: Get Dataset download url description: Get a url to download a single dataset. operationId: radar-post-reports-dataset-download-url parameters: - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json requestBody: content: application/json: schema: type: object required: - datasetId properties: datasetId: type: integer example: 3 responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - dataset properties: dataset: type: object required: - url properties: url: type: string example: https://example.com/download success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/dns/top/ases: get: tags: - Radar DNS summary: Get Top Autonomous Systems by DNS queries. description: Get top autonomous systems by DNS queries made to Cloudflare's public DNS resolver. operationId: radar-get-dns-top-ases parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: domain in: query required: true schema: type: array description: Array of domain names. example: google.com items: type: string pattern: ^([a-zA-Z0-9]([a-zA-Z0-9-]{0,63}[a-zA-Z0-9-])?\.)+[a-zA-Z0-9-]{2,63}$ - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 174 clientASName: type: string example: Cogent-174 value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/dns/top/locations: get: tags: - Radar DNS summary: Get Top Locations by DNS queries description: Get top locations by DNS queries made to Cloudflare's public DNS resolver. operationId: radar-get-dns-top-locations parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: domain in: query required: true schema: type: array description: Array of domain names. example: google.com items: type: string pattern: ^([a-zA-Z0-9]([a-zA-Z0-9-]{0,63}[a-zA-Z0-9-])?\.)+[a-zA-Z0-9-]{2,63}$ - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: PT clientCountryName: type: string example: Portugal value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/summary/arc: get: tags: - Radar Email Routing summary: Get ARC Validations Summary description: Percentage distribution of emails classified per ARC validation. operationId: radar-get-email-routing-summary-by-arc parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: "2" NONE: type: string example: "53" PASS: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/summary/dkim: get: tags: - Radar Email Routing summary: Get DKIM Validations Summary description: Percentage distribution of emails classified per DKIM validation. operationId: radar-get-email-routing-summary-by-dkim parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: "2" NONE: type: string example: "53" PASS: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/summary/dmarc: get: tags: - Radar Email Routing summary: Get DMARC Validations Summary description: Percentage distribution of emails classified per DMARC validation. operationId: radar-get-email-routing-summary-by-dmarc parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: "2" NONE: type: string example: "53" PASS: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/summary/encrypted: get: tags: - Radar Email Routing summary: Get Encrypted Summary description: Percentage distribution of emails by Encrypted operationId: radar-get-email-routing-summary-by-encrypted parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - ENCRYPTED - NOT_ENCRYPTED properties: ENCRYPTED: type: string example: "65" NOT_ENCRYPTED: type: string example: "35" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/summary/ip_version: get: tags: - Radar Email Routing summary: Get Ip Version Summary description: Percentage distribution of emails by Ip Version. operationId: radar-get-email-routing-summary-by-ip-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: string example: "65" IPv6: type: string example: "35" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/summary/spf: get: tags: - Radar Email Routing summary: Get SPF Validations Summary description: Percentage distribution of emails classified per SPF validation. operationId: radar-get-email-routing-summary-by-spf parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: "2" NONE: type: string example: "53" PASS: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/timeseries_groups/arc: get: tags: - Radar Email Routing summary: Get ARC Validations Time Series description: Percentage distribution of emails classified per Arc validation over time. operationId: radar-get-email-routing-timeseries-group-by-arc parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: "2" NONE: type: array items: type: string example: "53" PASS: type: array items: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/timeseries_groups/dkim: get: tags: - Radar Email Routing summary: Get DKIM Validations Time Series description: Percentage distribution of emails classified per DKIM validation over time. operationId: radar-get-email-routing-timeseries-group-by-dkim parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: "2" NONE: type: array items: type: string example: "53" PASS: type: array items: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/timeseries_groups/dmarc: get: tags: - Radar Email Routing summary: Get DMARC Validations Time Series description: Percentage distribution of emails classified per DMARC validation over time. operationId: radar-get-email-routing-timeseries-group-by-dmarc parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: "2" NONE: type: array items: type: string example: "53" PASS: type: array items: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/timeseries_groups/encrypted: get: tags: - Radar Email Routing summary: Get Encrypted Time Series description: Percentage distribution of emails by Encrypted over time. operationId: radar-get-email-routing-timeseries-group-by-encrypted parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - ENCRYPTED - NOT_ENCRYPTED properties: ENCRYPTED: type: array items: type: string example: "65" NOT_ENCRYPTED: type: array items: type: string example: "35" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/timeseries_groups/ip_version: get: tags: - Radar Email Routing summary: Get Ip Version Time Series description: Percentage distribution of emails by Ip Version over time. operationId: radar-get-email-routing-timeseries-group-by-ip-version parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: array items: type: string example: "65" IPv6: type: array items: type: string example: "35" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/timeseries_groups/spf: get: tags: - Radar Email Routing summary: Get SPF Validations Time Series description: Percentage distribution of emails classified per SPF validation over time. operationId: radar-get-email-routing-timeseries-group-by-spf parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: "2" NONE: type: array items: type: string example: "53" PASS: type: array items: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/arc: get: tags: - Radar Email Security summary: Get ARC Validations Summary description: Percentage distribution of emails classified per ARC validation. operationId: radar-get-email-security-summary-by-arc parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: "2" NONE: type: string example: "53" PASS: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/dkim: get: tags: - Radar Email Security summary: Get DKIM Validations Summary description: Percentage distribution of emails classified per DKIM validation. operationId: radar-get-email-security-summary-by-dkim parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: "2" NONE: type: string example: "53" PASS: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/dmarc: get: tags: - Radar Email Security summary: Get DMARC Validations Summary description: Percentage distribution of emails classified per DMARC validation. operationId: radar-get-email-security-summary-by-dmarc parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: "2" NONE: type: string example: "53" PASS: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/malicious: get: tags: - Radar Email Security summary: Get MALICIOUS Validations Summary description: Percentage distribution of emails classified as MALICIOUS. operationId: radar-get-email-security-summary-by-malicious parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - MALICIOUS - NOT_MALICIOUS properties: MALICIOUS: type: string example: "65" NOT_MALICIOUS: type: string example: "35" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/spam: get: tags: - Radar Email Security summary: Get SPAM Summary description: Proportion of emails categorized as either spam or legitimate (non-spam). operationId: radar-get-email-security-summary-by-spam parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - SPAM - NOT_SPAM properties: NOT_SPAM: type: string example: "35" SPAM: type: string example: "65" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/spf: get: tags: - Radar Email Security summary: Get SPF Validations Summary description: Percentage distribution of emails classified per SPF validation. operationId: radar-get-email-security-summary-by-spf parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: "2" NONE: type: string example: "53" PASS: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/spoof: get: tags: - Radar Email Security summary: Get SPOOF Summary description: Proportion of emails categorized as either spoof or legitimate (non-spoof). operationId: radar-get-email-security-summary-by-spoof parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - SPOOF - NOT_SPOOF properties: NOT_SPOOF: type: string example: "35" SPOOF: type: string example: "65" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/threat_category: get: tags: - Radar Email Security summary: Get Threat Categories Summary description: Percentage distribution of emails classified in Threat Categories. operationId: radar-get-email-security-summary-by-threat-category parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - IdentityDeception - Link - BrandImpersonation - CredentialHarvester properties: BrandImpersonation: type: string example: "35" CredentialHarvester: type: string example: "32" IdentityDeception: type: string example: "47" Link: type: string example: "43" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/tls_version: get: tags: - Radar Email Security summary: Get TLS Version Summary description: Percentage distribution of emails classified per TLS Version. operationId: radar-get-email-security-summary-by-tls-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - TLS 1.0 - TLS 1.1 - TLS 1.2 - TLS 1.3 properties: TLS 1.0: type: string example: "3" TLS 1.1: type: string example: "12" TLS 1.2: type: string example: "41" TLS 1.3: type: string example: "44" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/arc: get: tags: - Radar Email Security summary: Get ARC Validations Time Series description: Percentage distribution of emails classified per Arc validation over time. operationId: radar-get-email-security-timeseries-group-by-arc parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: "2" NONE: type: array items: type: string example: "53" PASS: type: array items: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/dkim: get: tags: - Radar Email Security summary: Get DKIM Validations Time Series description: Percentage distribution of emails classified per DKIM validation over time. operationId: radar-get-email-security-timeseries-group-by-dkim parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: "2" NONE: type: array items: type: string example: "53" PASS: type: array items: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/dmarc: get: tags: - Radar Email Security summary: Get DMARC Validations Time Series description: Percentage distribution of emails classified per DMARC validation over time. operationId: radar-get-email-security-timeseries-group-by-dmarc parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: "2" NONE: type: array items: type: string example: "53" PASS: type: array items: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/malicious: get: tags: - Radar Email Security summary: Get MALICIOUS Validations Time Series description: Percentage distribution of emails classified as MALICIOUS over time. operationId: radar-get-email-security-timeseries-group-by-malicious parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - MALICIOUS - NOT_MALICIOUS properties: MALICIOUS: type: array items: type: string example: "65" NOT_MALICIOUS: type: array items: type: string example: "35" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/spam: get: tags: - Radar Email Security summary: Get SPAM Validations Time Series description: Percentage distribution of emails classified as SPAM over time. operationId: radar-get-email-security-timeseries-group-by-spam parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - SPAM - NOT_SPAM properties: NOT_SPAM: type: array items: type: string example: "35" SPAM: type: array items: type: string example: "65" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/spf: get: tags: - Radar Email Security summary: Get SPF Validations Time Series description: Percentage distribution of emails classified per SPF validation over time. operationId: radar-get-email-security-timeseries-group-by-spf parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: "2" NONE: type: array items: type: string example: "53" PASS: type: array items: type: string example: "45" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/spoof: get: tags: - Radar Email Security summary: Get SPOOF Validations Time Series description: Percentage distribution of emails classified as SPOOF over time. operationId: radar-get-email-security-timeseries-group-by-spoof parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - SPOOF - NOT_SPOOF properties: NOT_SPOOF: type: array items: type: string example: "35" SPOOF: type: array items: type: string example: "65" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/threat_category: get: tags: - Radar Email Security summary: Get Threat Categories Time Series description: Percentage distribution of emails classified in Threat Categories over time. operationId: radar-get-email-security-timeseries-group-by-threat-category parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - IdentityDeception - Link - BrandImpersonation - CredentialHarvester properties: BrandImpersonation: type: array items: type: string example: "35" CredentialHarvester: type: array items: type: string example: "32" IdentityDeception: type: array items: type: string example: "47" Link: type: array items: type: string example: "43" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/tls_version: get: tags: - Radar Email Security summary: Get TLS Version Time Series description: Percentage distribution of emails classified per TLS Version over time. operationId: radar-get-email-security-timeseries-group-by-tls-version parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - TLS 1.0 - TLS 1.1 - TLS 1.2 - TLS 1.3 properties: TLS 1.0: type: array items: type: string example: "3" TLS 1.1: type: array items: type: string example: "12" TLS 1.2: type: array items: type: string example: "41" TLS 1.3: type: array items: type: string example: "44" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/top/tlds: get: tags: - Radar Email Security summary: Get Top TLDs By Email Messages 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: tldCategory in: query schema: type: string description: Filter for TLDs by category. enum: - CLASSIC - COUNTRY example: CLASSIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - name - value properties: name: type: string example: com. value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/email/security/top/tlds/malicious/{malicious}: get: tags: - Radar Email Security summary: Get Top TLDs By Malicious Classification description: Get the TLDs by emails classified as malicious or not. operationId: radar-get-email-security-top-tlds-by-malicious parameters: - name: malicious in: path required: true schema: type: string description: Malicious. enum: - MALICIOUS - NOT_MALICIOUS example: MALICIOUS - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: tldCategory in: query schema: type: string description: Filter for TLDs by category. enum: - CLASSIC - COUNTRY example: CLASSIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - name - value properties: name: type: string example: com. value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/email/security/top/tlds/spam/{spam}: get: tags: - Radar Email Security summary: Get Top TLDs By Spam Classification description: Get the top TLDs by emails classified as Spam or not. operationId: radar-get-email-security-top-tlds-by-spam parameters: - name: spam in: path required: true schema: type: string description: Spam. enum: - SPAM - NOT_SPAM example: SPAM - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: tldCategory in: query schema: type: string description: Filter for TLDs by category. enum: - CLASSIC - COUNTRY example: CLASSIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - name - value properties: name: type: string example: com. value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/email/security/top/tlds/spoof/{spoof}: get: tags: - Radar Email Security summary: Get Top TLDs By Spoof Classification description: Get the TLDs by emails classified as spoof or not. operationId: radar-get-email-security-top-tlds-by-spoof parameters: - name: spoof in: path required: true schema: type: string description: Spoof. enum: - SPOOF - NOT_SPOOF example: SPOOF - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: tldCategory in: query schema: type: string description: Filter for TLDs by category. enum: - CLASSIC - COUNTRY example: CLASSIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - name - value properties: name: type: string example: com. value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/entities/asns: get: tags: - Radar Entities summary: Get autonomous systems description: Gets a list of autonomous systems (AS). operationId: radar-get-entities-asn-list parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: offset in: query schema: type: integer description: Number of objects to skip before grabbing results. - name: asn in: query schema: type: string description: Comma separated list of ASNs. example: 174,7922 - name: location in: query schema: type: string description: Location Alpha2 to filter results. example: US - name: orderBy in: query schema: type: string description: Order asn list. enum: - ASN - POPULATION default: ASN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - asns properties: asns: type: array items: type: object required: - name - asn - country - countryName properties: aka: type: string asn: type: integer example: 714 country: type: string example: GB countryName: type: string example: United Kingdom name: type: string example: Apple Inc. nameLong: type: string description: Deprecated field. Please use 'aka'. orgName: type: string website: type: string example: https://www.apple.com/support/systemstatus/ success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/entities/asns/{asn}: get: tags: - Radar Entities summary: Get autonomous system information by AS number 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: - name: asn in: path required: true schema: type: integer description: Autonomous System Number (ASN). example: 3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - asn properties: asn: type: object required: - name - country - countryName - confidenceLevel - related - source - asn - website - orgName - estimatedUsers properties: aka: type: string asn: type: integer example: 714 confidenceLevel: type: integer example: 5 country: type: string example: GB countryName: type: string example: United Kingdom estimatedUsers: type: object required: - locations properties: estimatedUsers: type: integer description: Total estimated users example: 86099 locations: type: array items: type: object required: - locationName - locationAlpha2 properties: estimatedUsers: type: integer description: Estimated users per location example: 16710 locationAlpha2: type: string example: US locationName: type: string example: United States name: type: string example: Apple Inc. nameLong: type: string description: Deprecated field. Please use 'aka'. orgName: type: string related: type: array items: type: object required: - name - asn properties: aka: type: string asn: type: integer example: 174 estimatedUsers: type: integer description: Total estimated users example: 65345 name: type: string example: Cogent-174 source: type: string description: Regional Internet Registry example: RIPE website: type: string example: https://www.apple.com/support/systemstatus/ success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/entities/asns/{asn}/rel: get: tags: - Radar Entities summary: Get AS-level relationships by AS number description: Get AS-level relationship for given networks. operationId: radar-get-asns-rel parameters: - name: asn in: path required: true schema: type: integer description: Get all ASNs with provider-customer or peering relationships with the given ASN example: 3 - name: asn2 in: query schema: type: integer description: Get the AS relationship of ASN2 with respect to the given ASN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - rels - meta properties: meta: type: object required: - data_time - query_time - total_peers properties: data_time: type: string query_time: type: string total_peers: type: integer rels: type: array items: type: object required: - asn1 - asn1_country - asn1_name - asn2 - asn2_country - asn2_name - rel 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 success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/entities/asns/ip: get: tags: - Radar Entities summary: Get autonomous system information by IP address 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: - name: ip in: query required: true schema: type: string description: IP address. example: 8.8.8.8 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - asn properties: asn: type: object required: - name - country - countryName - related - asn - website - orgName - source - estimatedUsers properties: aka: type: string asn: type: integer example: 714 country: type: string example: GB countryName: type: string example: United Kingdom estimatedUsers: type: object required: - locations properties: estimatedUsers: type: integer description: Total estimated users example: 86099 locations: type: array items: type: object required: - locationName - locationAlpha2 properties: estimatedUsers: type: integer description: Estimated users per location example: 16710 locationAlpha2: type: string example: US locationName: type: string example: United States name: type: string example: Apple Inc. nameLong: type: string description: Deprecated field. Please use 'aka'. orgName: type: string related: type: array items: type: object required: - name - asn properties: aka: type: string asn: type: integer estimatedUsers: type: integer description: Total estimated users example: 65345 name: type: string source: type: string description: Regional Internet Registry example: RIPE website: type: string example: https://www.apple.com/support/systemstatus/ success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/entities/ip: get: tags: - Radar Entities summary: Get IP address description: 'Get IP address information. ' operationId: radar-get-entities-ip parameters: - name: ip in: query required: true schema: type: string description: IP address. example: 8.8.8.8 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - ip properties: ip: type: object required: - ip - ipVersion - location - locationName - asn - asnName - asnLocation - asnOrgName properties: asn: type: string example: "15169" asnLocation: type: string example: US asnName: type: string example: GOOGLE asnOrgName: type: string example: Google LLC ip: type: string example: 8.8.8.8 ipVersion: type: string example: IPv4 location: type: string example: GB locationName: type: string example: United Kingdom success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/entities/locations: get: tags: - Radar Entities summary: Get locations description: Get a list of locations. operationId: radar-get-entities-locations parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: offset in: query schema: type: integer description: Number of objects to skip before grabbing results. - name: location in: query schema: type: string description: Comma separated list of locations. example: US,CA - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - locations properties: locations: type: array items: type: object required: - name - latitude - longitude - alpha2 properties: alpha2: type: string example: AF latitude: type: string example: 33.939116 longitude: type: string example: 67.709953 name: type: string example: Afghanistan success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/entities/locations/{location}: get: tags: - Radar Entities summary: Get location description: Get the requested location information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location). operationId: radar-get-entities-location-by-alpha2 parameters: - name: location in: path required: true schema: type: string description: Alpha-2 country code. example: US - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - location properties: location: type: object required: - name - region - subregion - latitude - longitude - alpha2 - confidenceLevel properties: alpha2: type: string example: AF confidenceLevel: type: integer example: 5 latitude: type: string example: 33.939116 longitude: type: string example: 67.709953 name: type: string example: Afghanistan region: type: string example: Middle East subregion: type: string example: Southern Asia success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/bot_class: get: tags: - Radar Http summary: Get Bot Class Summary 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: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - human - bot properties: bot: type: string example: "35" human: type: string example: "65" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/device_type: get: tags: - Radar Http summary: Get Device Type Summary 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: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - desktop - mobile - other properties: desktop: type: string example: "65" mobile: type: string example: "30" other: type: string example: "5" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/http_protocol: get: tags: - Radar Http summary: Get HTTP protocols summary description: Percentage distribution of traffic per HTTP protocol over a given time period. operationId: radar-get-http-summary-by-http-protocol parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - http - https properties: http: type: string example: "99" https: type: string example: "1" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/http_version: get: tags: - Radar Http summary: Get HTTP Versions Summary description: Percentage distribution of traffic per HTTP protocol version over a given time period. operationId: radar-get-http-summary-by-http-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - HTTP/1.x - HTTP/2 - HTTP/3 properties: HTTP/1.x: type: string example: "1" HTTP/2: type: string example: "39" HTTP/3: type: string example: "60" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/ip_version: get: tags: - Radar Http summary: Get IP Version Summary 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: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: string example: "65" IPv6: type: string example: "35" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/os: get: tags: - Radar Http summary: Get Operating Systems Summary 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: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - ANDROID - IOS properties: ANDROID: type: string example: "65" IOS: type: string example: "35" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/tls_version: get: tags: - Radar Http summary: Get TLS Versions Summary description: Percentage distribution of traffic per TLS protocol version, over a given time period. operationId: radar-get-http-summary-by-tls-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - TLS 1.0 - TLS 1.1 - TLS 1.2 - TLS 1.3 - TLS QUIC properties: TLS 1.0: type: string example: "0.5" TLS 1.1: type: string example: "0.5" TLS 1.2: type: string example: "60" TLS 1.3: type: string example: "10" TLS QUIC: type: string example: "29" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/bot_class: get: tags: - Radar Http summary: Get Bot Classes Time Series 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: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - human - bot properties: bot: type: array items: type: string human: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/browser: get: tags: - Radar Http summary: Get User Agents Time Series 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: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: limitPerGroup in: query schema: type: integer description: Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range. example: 4 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: Chrome: - "50.168733" timestamps: - "2023-08-08T10:15:00Z" required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/browser_family: get: tags: - Radar Http summary: Get User Agent Families Time Series 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: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: Chrome: - "50.168733" timestamps: - "2023-08-08T10:15:00Z" required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/device_type: get: tags: - Radar Http summary: Get Device Types Time Series description: Get a time series of the percentage distribution of traffic per device type. operationId: radar-get-http-timeseries-group-by-device-type parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - desktop - mobile - other properties: desktop: type: array items: type: string mobile: type: array items: type: string other: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/http_protocol: get: tags: - Radar Http summary: Get HTTP protocols Time Series description: Get a time series of the percentage distribution of traffic per HTTP protocol. operationId: radar-get-http-timeseries-group-by-http-protocol parameters: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - http - https properties: http: type: array items: type: string https: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/http_version: get: tags: - Radar Http summary: Get HTTP Versions Time Series 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: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - HTTP/1.x - HTTP/2 - HTTP/3 properties: HTTP/1.x: type: array items: type: string HTTP/2: type: array items: type: string HTTP/3: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/ip_version: get: tags: - Radar Http summary: Get IP Versions Time Series 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: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - IPv4 - IPv6 properties: IPv4: type: array items: type: string IPv6: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/os: get: tags: - Radar Http summary: Get Operating Systems Time Series 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: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: ANDROID: - "97.28898" timestamps: - "2023-08-08T10:15:00Z" required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/tls_version: get: tags: - Radar Http summary: Get TLS Versions Time Series 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: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - TLS 1.0 - TLS 1.1 - TLS 1.2 - TLS 1.3 - TLS QUIC properties: TLS 1.0: type: array items: type: string TLS 1.1: type: array items: type: string TLS 1.2: type: array items: type: string TLS 1.3: type: array items: type: string TLS QUIC: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases: get: tags: - Radar Http summary: Get Top Autonomous Systems By HTTP Requests description: Get the top autonomous systems by HTTP traffic. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-http-requests parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: "3" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/bot_class/{bot_class}: get: tags: - Radar Http summary: Get Top Autonomous Systems By Bot Class description: Get the top autonomous systems (AS), by HTTP traffic, of the requested bot class. These two categories use Cloudflare's bot score - refer to [Bot Scores](https://developers.cloudflare.com/bots/concepts/bot-score) for more information. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-bot-class parameters: - name: bot_class in: path required: true schema: type: string description: Bot class. enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: "3" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/device_type/{device_type}: get: tags: - Radar Http summary: Get Top Autonomous Systems By Device Type description: Get the top autonomous systems (AS), by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-device-type parameters: - name: device_type in: path required: true schema: type: string description: Device type. enum: - DESKTOP - MOBILE - OTHER - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: "3" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/http_protocol/{http_protocol}: get: tags: - Radar Http summary: Get Top Autonomous Systems By HTTP Protocol description: Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-http-protocol parameters: - name: http_protocol in: path required: true schema: type: string description: HTTP Protocol. enum: - HTTP - HTTPS - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: "3" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/http_version/{http_version}: get: tags: - Radar Http summary: Get Top Autonomous Systems By HTTP Version description: Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol version. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-http-version parameters: - name: http_version in: path required: true schema: type: string description: HTTP version. enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: "3" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/ip_version/{ip_version}: get: tags: - Radar Http summary: Get Top Autonomous Systems By IP Version description: Get the top autonomous systems, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-ip-version parameters: - name: ip_version in: path required: true schema: type: string description: IP version. enum: - IPv4 - IPv6 - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: "3" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/os/{os}: get: tags: - Radar Http summary: Get Top Autonomous Systems By Operating System 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: - name: os in: path required: true schema: type: string description: IP version. enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: "3" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/tls_version/{tls_version}: get: tags: - Radar Http summary: Get Top Autonomous Systems By TLS Version description: Get the top autonomous systems (AS), by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-tls-version parameters: - name: tls_version in: path required: true schema: type: string description: TLS version. enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: "3" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/browser_families: get: tags: - Radar Http summary: Get Top User Agents Families by HTTP requests description: Get the top user agents aggregated in families by HTTP traffic. Values are a percentage out of the total traffic. operationId: radar-get-http-top-browser-families parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - name - value properties: name: type: string example: chrome value: type: string success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/browsers: get: tags: - Radar Http summary: Get Top User Agents By HTTP requests description: Get the top user agents by HTTP traffic. Values are a percentage out of the total traffic. operationId: radar-get-http-top-browsers parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - name - value properties: name: type: string example: chrome value: type: string success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations: get: tags: - Radar Http summary: Get Top Locations By HTTP requests description: Get the top locations by HTTP traffic. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-http-requests parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/bot_class/{bot_class}: get: tags: - Radar Http summary: Get Top Locations By Bot Class description: Get the top locations, by HTTP traffic, of the requested bot class. These two categories use Cloudflare's bot score - refer to [Bot scores])https://developers.cloudflare.com/bots/concepts/bot-score). Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-bot-class parameters: - name: bot_class in: path required: true schema: type: string description: Bot class. enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/device_type/{device_type}: get: tags: - Radar Http summary: Get Top Locations By Device Type description: Get the top locations, by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-device-type parameters: - name: device_type in: path required: true schema: type: string description: Device type. enum: - DESKTOP - MOBILE - OTHER - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/http_protocol/{http_protocol}: get: tags: - Radar Http summary: Get Top Locations By HTTP Protocol description: Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-http-protocol parameters: - name: http_protocol in: path required: true schema: type: string description: HTTP Protocol. enum: - HTTP - HTTPS - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/http_version/{http_version}: get: tags: - Radar Http summary: Get Top Locations By HTTP Version description: Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-http-version parameters: - name: http_version in: path required: true schema: type: string description: HTTP version. enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/ip_version/{ip_version}: get: tags: - Radar Http summary: Get Top Locations By IP Version description: Get the top locations, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-ip-version parameters: - name: ip_version in: path required: true schema: type: string description: IP version. enum: - IPv4 - IPv6 - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/os/{os}: get: tags: - Radar Http summary: Get Top Locations By Operating System 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: - name: os in: path required: true schema: type: string description: IP version. enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/tls_version/{tls_version}: get: tags: - Radar Http summary: Get Top Locations By TLS Version description: Get the top locations, by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-tls-version parameters: - name: tls_version in: path required: true schema: type: string description: TLS version. enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "65" success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/netflows/timeseries: get: tags: - Radar Netflows summary: Get NetFlows Time Series 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: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: product in: query schema: type: array description: Array of network traffic product types. example: all items: type: string enum: - HTTP - ALL - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: normalization in: query schema: type: string description: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE_CHANGE - MIN0_MAX example: MIN0_MAX - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - values properties: timestamps: type: array items: type: string format: date-time values: type: array items: type: string example: 0.56 success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/netflows/top/ases: get: tags: - Radar Netflows summary: Get Top Autonomous Systems By Network Traffic 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - top_0 properties: top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: number example: 16509 clientASName: type: string example: AMAZON-02 value: type: string example: "0.73996" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/netflows/top/locations: get: tags: - Radar Netflows summary: Get Top Locations By Network Traffic 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - top_0 properties: top_0: type: array items: type: object required: - clientCountryName - clientCountryAlpha2 - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: "0.73996" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/quality/iqi/summary: get: tags: - Radar Quality summary: Get IQI Summary 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: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: metric in: query required: true schema: type: string description: 'Which metric to return: bandwidth, latency or DNS response time.' enum: - BANDWIDTH - DNS - LATENCY example: latency - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - p75 - p50 - p25 properties: p25: type: string example: "32.20938" p50: type: string example: "61.819881" p75: type: string example: "133.813087" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/quality/iqi/timeseries_groups: get: tags: - Radar Quality summary: Get IQI Time Series 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: - name: aggInterval in: query schema: type: string 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 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: interpolation in: query schema: type: boolean description: Enable interpolation for all series (using the average). - name: metric in: query required: true schema: type: string description: 'Which metric to return: bandwidth, latency or DNS response time.' enum: - BANDWIDTH - DNS - LATENCY example: latency - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - p75 - p50 - p25 properties: p25: type: array items: type: string example: "31.253439" p50: type: array items: type: string example: "60.337738" p75: type: array items: type: string example: "125.940175" timestamps: type: array items: type: string example: "2023-04-17T00:00:00Z" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/quality/speed/histogram: get: tags: - Radar Quality summary: Get Speed Tests Histogram 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: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: bucketSize in: query schema: type: integer description: The width for every bucket in the histogram. - name: metricGroup in: query schema: type: string description: Metrics to be returned. enum: - BANDWIDTH - LATENCY - JITTER default: bandwidth example: bandwidth - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - histogram_0 properties: histogram_0: type: object required: - bandwidthUpload - bandwidthDownload - bucketMin properties: bandwidthDownload: type: array items: type: string example: "83681" bandwidthUpload: type: array items: type: string example: "181079" bucketMin: type: array items: type: string example: "0" meta: type: object success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/quality/speed/summary: get: tags: - Radar Quality summary: Get Speed Tests Summary 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: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" normalization: type: string example: PERCENTAGE summary_0: type: object required: - bandwidthDownload - bandwidthUpload - latencyIdle - latencyLoaded - jitterIdle - jitterLoaded - packetLoss properties: bandwidthDownload: type: string example: "83.765201" bandwidthUpload: type: string example: "39.005561" jitterIdle: type: string example: "25.648713" jitterLoaded: type: string example: "77.462155" latencyIdle: type: string example: "83.165385" latencyLoaded: type: string example: "270.561124" packetLoss: type: string example: "1.23705" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/quality/speed/top/ases: get: tags: - Radar Quality summary: Get Top Speed Test Autonomous Systems 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: orderBy in: query schema: type: string description: Metric to order the results by. enum: - BANDWIDTH_DOWNLOAD - BANDWIDTH_UPLOAD - LATENCY_IDLE - LATENCY_LOADED - JITTER_IDLE - JITTER_LOADED default: BANDWIDTH_DOWNLOAD - name: reverse in: query schema: type: boolean description: Reverse the order of results. - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientASN - clientASName - bandwidthDownload - bandwidthUpload - latencyIdle - latencyLoaded - jitterIdle - jitterLoaded - numTests - rankPower properties: bandwidthDownload: type: string example: "642.509004" bandwidthUpload: type: string example: "300.672274" clientASN: type: number example: 33353 clientASName: type: string example: SIE-CGEI-ASN-1 jitterIdle: type: string example: "2.956908" jitterLoaded: type: string example: "19.500469" latencyIdle: type: string example: "15.925" latencyLoaded: type: string example: "65.65" numTests: type: number example: 13123 rankPower: type: number example: 0.77 success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/quality/speed/top/locations: get: tags: - Radar Quality summary: Get Top Speed Test Locations 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: orderBy in: query schema: type: string description: Metric to order the results by. enum: - BANDWIDTH_DOWNLOAD - BANDWIDTH_UPLOAD - LATENCY_IDLE - LATENCY_LOADED - JITTER_IDLE - JITTER_LOADED default: BANDWIDTH_DOWNLOAD - name: reverse in: query schema: type: boolean description: Reverse the order of results. - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" lastUpdated: type: string example: "2023-07-26T08:59:57Z" top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - bandwidthDownload - bandwidthUpload - latencyIdle - latencyLoaded - jitterIdle - jitterLoaded - numTests - rankPower properties: bandwidthDownload: type: string example: "295.886073" bandwidthUpload: type: string example: "158.85269" clientCountryAlpha2: type: string example: IS clientCountryName: type: string example: Iceland jitterIdle: type: string example: "9.640685" jitterLoaded: type: string example: "46.480023" latencyIdle: type: string example: "15.208124" latencyLoaded: type: string example: "114.758887" numTests: type: number example: 13123 rankPower: type: number example: 0.77 success: type: boolean example: true "404": description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/ranking/domain/{domain}: get: tags: - Radar Ranking summary: Get Domains Rank details 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: - name: domain in: path required: true schema: type: string 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])$ - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: rankingType in: query schema: type: string description: The ranking type. enum: - POPULAR - TRENDING_RISE - TRENDING_STEADY default: POPULAR example: POPULAR - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: date in: query schema: type: array description: Array of dates to filter the ranking. example: "2022-09-19" items: type: string nullable: true - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - details_0 properties: details_0: type: object required: - categories - top_locations properties: bucket: type: string description: Only available in POPULAR ranking for the most recent ranking. example: "2000" categories: type: array items: type: object required: - superCategoryId - name - id properties: id: type: number example: 81 name: type: string example: Content Servers superCategoryId: type: number example: 26 rank: type: integer example: 3 top_locations: type: array items: type: object required: - rank - locationName - locationCode properties: locationCode: type: string example: US locationName: type: string example: United States rank: type: integer example: 1 success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/ranking/timeseries_groups: get: tags: - Radar Ranking summary: Get Domains Rank time series description: Gets Domains Rank updates change over time. Raw values are returned. operationId: radar-get-ranking-domain-timeseries parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: rankingType in: query schema: type: string description: The ranking type. enum: - POPULAR - TRENDING_RISE - TRENDING_STEADY default: POPULAR example: POPULAR - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: location in: query schema: type: array description: Array of locations (alpha-2 country codes). example: US items: type: string - name: domains in: query schema: type: array description: Array of comma separated list of domains names. example: google.com,facebook.com items: type: string pattern: ^([a-zA-Z0-9]([a-zA-Z0-9-]{0,63}[a-zA-Z0-9-])?\.)+[a-zA-Z0-9-]{2,63}$ - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange properties: dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" serie_0: type: object example: google.com: - 2 timestamps: - "2022-09-02" required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/ranking/top: get: tags: - Radar Ranking summary: Get Top or Trending Domains 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: location in: query schema: type: array description: Array of locations (alpha-2 country codes). example: US items: type: string - name: date in: query schema: type: array description: Array of dates to filter the ranking. example: "2022-09-19" items: type: string nullable: true - name: rankingType in: query schema: type: string description: The ranking type. enum: - POPULAR - TRENDING_RISE - TRENDING_STEADY default: POPULAR example: POPULAR - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - top_0 properties: top_0: type: object required: - date properties: date: type: string example: "2022-09-19" top_0: type: array items: type: object required: - rank - domain - categories properties: categories: type: array items: type: object required: - superCategoryId - name - id properties: id: type: number example: 81 name: type: string example: Content Servers superCategoryId: type: number example: 26 domain: type: string example: google.com pctRankChange: type: number description: Only available in TRENDING rankings. example: 10.8 rank: type: integer example: 1 success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/search/global: get: tags: - Radar Search summary: Search for locations, autonomous systems (AS) and reports. description: Lets you search for locations, autonomous systems (AS) and reports. operationId: radar-get-search-global parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: limitPerGroup in: query schema: type: number description: Limit the number of objects per search category. - name: query in: query required: true schema: type: string description: Search for locations, AS and reports. example: United - name: include in: query schema: type: array description: Search types to be included in results. items: type: string enum: - SPECIAL_EVENTS - NOTEBOOKS - LOCATIONS - ASNS - name: exclude in: query schema: type: array description: Search types to be excluded from results. items: type: string enum: - SPECIAL_EVENTS - NOTEBOOKS - LOCATIONS - ASNS - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - search properties: search: type: array items: type: object required: - code - name - type properties: code: type: string example: "13335" name: type: string example: Cloudflare type: type: string example: asn success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/traffic_anomalies: get: tags: - Radar Traffic Anomalies summary: Get latest Internet traffic anomalies. 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: offset in: query schema: type: integer description: Number of objects to skip before grabbing results. - name: dateRange in: query schema: type: string description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: status in: query schema: type: string enum: - VERIFIED - UNVERIFIED - name: asn in: query schema: type: integer description: Single ASN as integer. example: "174" - name: location in: query schema: type: string description: Location Alpha2 code. example: US - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: List of Internet traffic anomalies content: application/json: schema: type: object required: - result - success properties: result: type: object required: - trafficAnomalies properties: trafficAnomalies: type: array items: type: object required: - uuid - type - status - startDate properties: asnDetails: type: object required: - asn - name properties: asn: type: string example: "189" locations: type: object required: - code - name properties: code: type: string example: US name: type: string example: United States name: type: string example: LUMEN-LEGACY-L3-PARTITION endDate: type: string example: "2023-08-03T23:15:00Z" locationDetails: type: object required: - code - name properties: code: type: string example: US name: type: string example: United States startDate: type: string example: "2023-08-02T23:15:00Z" status: type: string example: UNVERIFIED type: type: string example: LOCATION uuid: type: string example: 55a57f33-8bc0-4984-b4df-fdaff72df39d visibleInDataSources: type: array items: type: string success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/traffic_anomalies/locations: get: tags: - Radar Traffic Anomalies summary: Get top locations by total traffic anomalies generated. 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: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: dateRange in: query schema: type: string description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" - name: status in: query schema: type: string enum: - VERIFIED - UNVERIFIED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: List of locations with number of traffic anomalies content: application/json: schema: type: object required: - result - success properties: result: type: object required: - trafficAnomalies properties: trafficAnomalies: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: PT clientCountryName: type: string example: Portugal value: type: string example: "5" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/verified_bots/top/bots: get: tags: - Radar Verified Bots summary: Get Top Verified Bots By HTTP Requests description: Get top verified bots by HTTP requests, with owner and category. operationId: radar-get-verified-bots-top-by-http-requests parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" top_0: type: array items: type: object required: - botName - botCategory - botOwner - value properties: botCategory: type: string example: Search Engine Crawler botName: type: string example: GoogleBot botOwner: type: string example: Google value: type: string example: "29.034407" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/verified_bots/top/categories: get: tags: - Radar Verified Bots summary: Get Top Verified Bot Categories By HTTP Requests description: Get top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests. operationId: radar-get-verified-bots-top-categories-by-http-requests parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: 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). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: "2023-09-01T11:41:33.782Z" items: type: string format: date-time - name: asn in: query schema: 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. example: "15169" items: type: string - name: location in: query schema: 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. example: US,CA items: type: string - name: continent in: query schema: 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. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: "200": description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: "2022-09-17T10:22:57.555Z" startTime: type: string format: date-time description: Adjusted start of date range. example: "2022-09-16T10:22:57.555Z" top_0: type: array items: type: object required: - botCategory - value properties: botCategory: type: string example: Search value: type: string example: "65" success: type: boolean example: true "400": description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /user: get: tags: - User summary: User Details operationId: user-user-details responses: 4XX: description: User Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_single_user_response' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: User Details response content: application/json: schema: $ref: '#/components/schemas/iam_single_user_response' security: - api_email: [] api_key: [] patch: tags: - User summary: Edit User description: Edit part of your user details. operationId: user-edit-user requestBody: required: true content: application/json: schema: properties: country: $ref: '#/components/schemas/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' responses: 4XX: description: Edit User response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_single_user_response' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Edit User response content: application/json: schema: $ref: '#/components/schemas/iam_single_user_response' security: - api_token: [] - api_email: [] api_key: [] /user/audit_logs: get: tags: - Audit Logs summary: Get user audit logs 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: - name: id in: query schema: type: string description: Finds a specific log by its ID. example: f174be97-19b1-40d6-954d-70cd5fbd52db - name: export in: query schema: type: boolean description: Indicates that this request is an export of logs in CSV format. example: true - name: action.type in: query schema: type: string description: Filters by the action type. example: add - name: actor.ip in: query schema: type: string 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 - name: actor.email in: query schema: type: string format: email description: Filters by the email address of the actor that made the change. example: alice@example.com - name: since in: query schema: type: string format: date-time description: Limits the returned results to logs newer than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339. example: "2019-04-30T01:12:20Z" - name: before in: query schema: type: string format: date-time description: Limits the returned results to logs older than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339. example: "2019-04-30T01:12:20Z" - name: zone.name in: query schema: type: string description: Filters by the name of the zone associated to the change. example: example.com - name: direction in: query schema: type: string description: Changes the direction of the chronological sorting. enum: - desc - asc default: desc example: desc - name: per_page in: query schema: type: number description: Sets the number of results to return per page. default: 100 example: 25 minimum: 1 maximum: 1000 - name: page in: query schema: type: number description: Defines which page of results to return. default: 1 example: 50 minimum: 1 - name: hide_user_logs in: query schema: type: boolean description: Indicates whether or not to hide user level audit logs. default: false responses: 4XX: description: Get user audit logs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/aaa_audit_logs_response_collection' - $ref: '#/components/schemas/aaa_api-response-common-failure' "200": description: Get user audit logs response content: application/json: schema: $ref: '#/components/schemas/aaa_audit_logs_response_collection' security: - api_token: [] - api_email: [] api_key: [] /user/billing/history: get: tags: - User Billing History summary: Billing History Details description: Accesses your billing history object. operationId: user-billing-history-(-deprecated)-billing-history-details parameters: - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of items per page. default: 20 minimum: 5 maximum: 50 - name: order in: query schema: type: string description: Field to order billing history by. enum: - type - occured_at - action example: occured_at - name: occured_at in: query schema: $ref: '#/components/schemas/bill-subs-api_occurred_at' - name: occurred_at in: query schema: $ref: '#/components/schemas/bill-subs-api_occurred_at' - name: type in: query schema: type: string description: The billing item type. example: charge readOnly: true maxLength: 30 - name: action in: query schema: type: string description: The billing item action. example: subscription readOnly: true maxLength: 30 responses: 4XX: description: Billing History Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/bill-subs-api_billing_history_collection' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' "200": description: Billing History Details response content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_billing_history_collection' deprecated: true security: - api_email: [] api_key: [] api_token: [] /user/billing/profile: get: tags: - User Billing Profile summary: Billing Profile Details description: Accesses your billing profile object. operationId: user-billing-profile-(-deprecated)-billing-profile-details responses: 4XX: description: Billing Profile Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/bill-subs-api_billing_response_single' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' "200": description: Billing Profile Details response content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_billing_response_single' deprecated: true security: - api_email: [] api_key: [] api_token: [] /user/firewall/access_rules/rules: get: tags: - IP Access rules for a user summary: List IP Access rules description: Fetches IP Access rules of the user. You can filter the results using several optional parameters. operationId: ip-access-rules-for-a-user-list-ip-access-rules parameters: - name: filters in: query schema: $ref: '#/components/schemas/firewall_filters' - name: egs-pagination.json in: query schema: $ref: '#/components/schemas/firewall_egs-pagination' - name: page in: query schema: type: number description: Requested page within paginated list of results. example: 1 - name: per_page in: query schema: type: number description: Maximum number of results requested. example: 20 - name: order in: query schema: type: string description: The field used to sort returned rules. enum: - configuration.target - configuration.value - mode example: mode - name: direction in: query schema: type: string description: The direction used to sort returned rules. enum: - asc - desc example: desc responses: 4XX: description: List IP Access rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_rule_collection_response' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List IP Access rules response content: application/json: schema: $ref: '#/components/schemas/firewall_rule_collection_response' security: - api_email: [] api_key: [] post: tags: - IP Access rules for a user summary: Create an IP Access rule description: |- Creates a new IP Access rule for all zones owned by the current user. Note: To create an IP Access rule that applies to a specific zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints. operationId: ip-access-rules-for-a-user-create-an-ip-access-rule requestBody: required: true content: application/json: schema: required: - mode - configuration properties: configuration: $ref: '#/components/schemas/firewall_configuration' mode: $ref: '#/components/schemas/firewall_schemas-mode' notes: $ref: '#/components/schemas/firewall_notes' responses: 4XX: description: Create an IP Access rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_rule_single_response' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Create an IP Access rule response content: application/json: schema: $ref: '#/components/schemas/firewall_rule_single_response' security: - api_email: [] api_key: [] /user/firewall/access_rules/rules/{identifier}: delete: tags: - IP Access rules for a user summary: Delete an IP Access rule description: |- Deletes an IP Access rule at the user level. Note: Deleting a user-level rule will affect all zones owned by the user. operationId: ip-access-rules-for-a-user-delete-an-ip-access-rule parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/firewall_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete an IP Access rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_rule_single_id_response' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Delete an IP Access rule response content: application/json: schema: $ref: '#/components/schemas/firewall_rule_single_id_response' security: - api_email: [] api_key: [] patch: tags: - IP Access rules for a user summary: Update an IP Access rule description: Updates an IP Access rule defined at the user level. You can only update the rule action (`mode` parameter) and notes. operationId: ip-access-rules-for-a-user-update-an-ip-access-rule parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/firewall_schemas-identifier' requestBody: required: true content: application/json: schema: properties: mode: $ref: '#/components/schemas/firewall_schemas-mode' notes: $ref: '#/components/schemas/firewall_notes' responses: 4XX: description: Update an IP Access rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_rule_single_response' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update an IP Access rule response content: application/json: schema: $ref: '#/components/schemas/firewall_rule_single_response' security: - api_email: [] api_key: [] /user/invites: get: tags: - User's Invites summary: List Invitations description: Lists all invitations associated with my user. operationId: user'-s-invites-list-invitations responses: 4XX: description: List Invitations response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_schemas-collection_invite_response' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: List Invitations response content: application/json: schema: $ref: '#/components/schemas/iam_schemas-collection_invite_response' security: - api_email: [] api_key: [] /user/invites/{invite_id}: get: tags: - User's Invites summary: Invitation Details description: Gets the details of an invitation. operationId: user'-s-invites-invitation-details parameters: - name: invite_id in: path required: true schema: $ref: '#/components/schemas/iam_invite_components-schemas-identifier' responses: 4XX: description: Invitation Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_single_invite_response' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Invitation Details response content: application/json: schema: $ref: '#/components/schemas/iam_single_invite_response' security: - api_email: [] api_key: [] patch: tags: - User's Invites summary: Respond to Invitation description: Responds to an invitation. operationId: user'-s-invites-respond-to-invitation parameters: - name: invite_id in: path required: true schema: $ref: '#/components/schemas/iam_invite_components-schemas-identifier' requestBody: required: true content: application/json: schema: type: object required: - status properties: status: description: Status of your response to the invitation (rejected or accepted). enum: - accepted - rejected example: accepted responses: 4XX: description: Respond to Invitation response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_single_invite_response' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Respond to Invitation response content: application/json: schema: $ref: '#/components/schemas/iam_single_invite_response' security: - api_email: [] api_key: [] /user/load_balancers/monitors: get: tags: - Load Balancer Monitors summary: List Monitors description: List configured monitors for a user. operationId: load-balancer-monitors-list-monitors responses: 4XX: description: List Monitors response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-response-collection' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: List Monitors response content: application/json: schema: $ref: '#/components/schemas/load-balancing_monitor-response-collection' security: - api_email: [] api_key: [] api_token: [] post: tags: - Load Balancer Monitors summary: Create Monitor description: Create a configured monitor. operationId: load-balancer-monitors-create-monitor requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-editable' - required: - expected_codes responses: 4XX: description: Create Monitor response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-response-single' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Create Monitor response content: application/json: schema: $ref: '#/components/schemas/load-balancing_monitor-response-single' security: - api_email: [] api_key: [] api_token: [] /user/load_balancers/monitors/{monitor_id}: delete: tags: - Load Balancer Monitors summary: Delete Monitor description: Delete a configured monitor. operationId: load-balancer-monitors-delete-monitor parameters: - name: monitor_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Monitor response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_id_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Delete Monitor response content: application/json: schema: $ref: '#/components/schemas/load-balancing_id_response' security: - api_email: [] api_key: [] api_token: [] get: tags: - Load Balancer Monitors summary: Monitor Details description: List a single configured monitor for a user. operationId: load-balancer-monitors-monitor-details parameters: - name: monitor_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_identifier' responses: 4XX: description: Monitor Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-response-single' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Monitor Details response content: application/json: schema: $ref: '#/components/schemas/load-balancing_monitor-response-single' security: - api_email: [] api_key: [] api_token: [] patch: tags: - Load Balancer Monitors summary: Patch Monitor description: Apply changes to an existing monitor, overwriting the supplied properties. operationId: load-balancer-monitors-patch-monitor parameters: - name: monitor_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_identifier' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-editable' - required: - expected_codes responses: 4XX: description: Patch Monitor response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-response-single' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Patch Monitor response content: application/json: schema: $ref: '#/components/schemas/load-balancing_monitor-response-single' security: - api_email: [] api_key: [] api_token: [] put: tags: - Load Balancer Monitors summary: Update Monitor description: Modify a configured monitor. operationId: load-balancer-monitors-update-monitor parameters: - name: monitor_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_identifier' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-editable' - required: - expected_codes responses: 4XX: description: Update Monitor response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-response-single' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Update Monitor response content: application/json: schema: $ref: '#/components/schemas/load-balancing_monitor-response-single' security: - api_email: [] api_key: [] api_token: [] /user/load_balancers/monitors/{monitor_id}/preview: post: tags: - Load Balancer Monitors summary: Preview Monitor description: Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results. operationId: load-balancer-monitors-preview-monitor parameters: - name: monitor_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_identifier' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-editable' - required: - expected_codes responses: 4XX: description: Preview Monitor response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_preview_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Preview Monitor response content: application/json: schema: $ref: '#/components/schemas/load-balancing_preview_response' security: - api_email: [] api_key: [] api_token: [] /user/load_balancers/monitors/{monitor_id}/references: get: tags: - Load Balancer Monitors summary: List Monitor References description: Get the list of resources that reference the provided monitor. operationId: load-balancer-monitors-list-monitor-references parameters: - name: monitor_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_identifier' responses: 4XX: description: List Monitor References response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_references_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: List Monitor References response content: application/json: schema: $ref: '#/components/schemas/load-balancing_references_response' security: - api_email: [] api_key: [] api_token: [] /user/load_balancers/pools: get: tags: - Load Balancer Pools summary: List Pools description: List configured pools. operationId: load-balancer-pools-list-pools parameters: - name: monitor in: query schema: description: The ID of the Monitor to use for checking the health of origins within this pool. responses: 4XX: description: List Pools response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-response_collection' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: List Pools response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-response_collection' security: - api_email: [] api_key: [] api_token: [] patch: tags: - Load Balancer Pools summary: Patch Pools description: Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`. operationId: load-balancer-pools-patch-pools requestBody: required: true content: application/json: schema: properties: notification_email: $ref: '#/components/schemas/load-balancing_patch_pools_notification_email' responses: 4XX: description: Patch Pools response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-response_collection' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Patch Pools response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-response_collection' security: - api_email: [] api_key: [] api_token: [] post: tags: - Load Balancer Pools summary: Create Pool description: Create a new pool. operationId: load-balancer-pools-create-pool requestBody: required: true content: application/json: schema: required: - origins - name properties: check_regions: $ref: '#/components/schemas/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' 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' responses: 4XX: description: Create Pool response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Create Pool response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-single_response' security: - api_email: [] api_key: [] api_token: [] /user/load_balancers/pools/{pool_id}: delete: tags: - Load Balancer Pools summary: Delete Pool description: Delete a configured pool. operationId: load-balancer-pools-delete-pool parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Pool response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-id_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Delete Pool response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-id_response' security: - api_email: [] api_key: [] api_token: [] get: tags: - Load Balancer Pools summary: Pool Details description: Fetch a single configured pool. operationId: load-balancer-pools-pool-details parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' responses: 4XX: description: Pool Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Pool Details response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-single_response' security: - api_email: [] api_key: [] api_token: [] patch: tags: - Load Balancer Pools summary: Patch Pool description: Apply changes to an existing pool, overwriting the supplied properties. operationId: load-balancer-pools-patch-pool parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' requestBody: required: true 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' responses: 4XX: description: Patch Pool response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Patch Pool response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-single_response' security: - api_email: [] api_key: [] api_token: [] put: tags: - Load Balancer Pools summary: Update Pool description: Modify a configured pool. operationId: load-balancer-pools-update-pool parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' requestBody: required: true content: application/json: schema: required: - origins - name 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' responses: 4XX: description: Update Pool response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Update Pool response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-single_response' security: - api_email: [] api_key: [] api_token: [] /user/load_balancers/pools/{pool_id}/health: get: tags: - Load Balancer Pools summary: Pool Health Details description: Fetch the latest pool health status for a single pool. operationId: load-balancer-pools-pool-health-details parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' responses: 4XX: description: Pool Health Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_health_details' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Pool Health Details response content: application/json: schema: $ref: '#/components/schemas/load-balancing_health_details' security: - api_email: [] api_key: [] api_token: [] /user/load_balancers/pools/{pool_id}/preview: post: tags: - Load Balancer Pools summary: Preview Pool description: Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results. operationId: load-balancer-pools-preview-pool parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_monitor-editable' - required: - expected_codes responses: 4XX: description: Preview Pool response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_preview_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Preview Pool response content: application/json: schema: $ref: '#/components/schemas/load-balancing_preview_response' security: - api_email: [] api_key: [] api_token: [] /user/load_balancers/pools/{pool_id}/references: get: tags: - Load Balancer Pools summary: List Pool References description: Get the list of resources that reference the provided pool. operationId: load-balancer-pools-list-pool-references parameters: - name: pool_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' responses: 4XX: description: List Pool References response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_schemas-references_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: List Pool References response content: application/json: schema: $ref: '#/components/schemas/load-balancing_schemas-references_response' security: - api_email: [] api_key: [] api_token: [] /user/load_balancers/preview/{preview_id}: get: tags: - Load Balancer Monitors summary: Preview Result description: Get the result of a previous preview operation using the provided preview_id. operationId: load-balancer-monitors-preview-result parameters: - name: preview_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_preview_id' responses: 4XX: description: Preview Result response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_preview_result_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Preview Result response content: application/json: schema: $ref: '#/components/schemas/load-balancing_preview_result_response' security: - api_email: [] api_key: [] api_token: [] /user/load_balancing_analytics/events: get: tags: - Load Balancer Healthcheck Events summary: List Healthcheck Events description: List origin health changes. operationId: load-balancer-healthcheck-events-list-healthcheck-events parameters: - name: until in: query schema: $ref: '#/components/schemas/load-balancing_until' - name: pool_name in: query schema: $ref: '#/components/schemas/load-balancing_pool_name' - name: origin_healthy in: query schema: $ref: '#/components/schemas/load-balancing_origin_healthy' - name: pool_id in: query schema: $ref: '#/components/schemas/load-balancing_schemas-identifier' - name: since in: query schema: type: string format: date-time description: Start date and time of requesting data period in the ISO8601 format. example: "2016-11-11T12:00:00Z" - name: origin_name in: query schema: type: string description: The name for the origin to filter. example: primary-dc-1 - name: pool_healthy in: query schema: type: boolean description: If true, filter events where the pool status is healthy. If false, filter events where the pool status is unhealthy. default: true example: true responses: 4XX: description: List Healthcheck Events response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_components-schemas-response_collection' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: List Healthcheck Events response content: application/json: schema: $ref: '#/components/schemas/load-balancing_components-schemas-response_collection' security: - api_email: [] api_key: [] api_token: [] /user/organizations: get: tags: - User's Organizations summary: List Organizations description: Lists organizations the user is associated with. operationId: user'-s-organizations-list-organizations parameters: - name: name in: query schema: $ref: '#/components/schemas/iam_schemas-name' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of organizations per page. default: 20 minimum: 5 maximum: 50 - name: order in: query schema: type: string description: Field to order organizations by. enum: - id - name - status example: status - name: direction in: query schema: type: string description: Direction to order organizations. enum: - asc - desc example: desc - name: match in: query schema: type: string description: Whether to match all search requirements or at least one (any). enum: - any - all default: all - name: status in: query schema: type: string description: Whether the user is a member of the organization or has an inivitation pending. enum: - member - invited example: member responses: 4XX: description: List Organizations response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_collection_organization_response' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: List Organizations response content: application/json: schema: $ref: '#/components/schemas/iam_collection_organization_response' security: - api_email: [] api_key: [] /user/organizations/{organization_id}: delete: tags: - User's Organizations summary: Leave Organization description: Removes association to an organization. operationId: user'-s-organizations-leave-organization parameters: - name: organization_id in: path required: true schema: $ref: '#/components/schemas/iam_common_components-schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Leave Organization response failure content: application/json: schema: allOf: - type: object properties: id: $ref: '#/components/schemas/iam_common_components-schemas-identifier' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Leave Organization response content: application/json: schema: type: object properties: id: $ref: '#/components/schemas/iam_common_components-schemas-identifier' security: - api_email: [] api_key: [] get: tags: - User's Organizations summary: Organization Details description: Gets a specific organization the user is associated with. operationId: user'-s-organizations-organization-details parameters: - name: organization_id in: path required: true schema: $ref: '#/components/schemas/iam_common_components-schemas-identifier' responses: 4XX: description: Organization Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_single_organization_response' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Organization Details response content: application/json: schema: $ref: '#/components/schemas/iam_single_organization_response' security: - api_email: [] api_key: [] /user/subscriptions: get: tags: - User Subscription summary: Get User Subscriptions description: Lists all of a user's subscriptions. operationId: user-subscription-get-user-subscriptions responses: 4XX: description: Get User Subscriptions response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/bill-subs-api_user_subscription_response_collection' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' "200": description: Get User Subscriptions response content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_user_subscription_response_collection' security: - api_email: [] api_key: [] api_token: [] /user/subscriptions/{identifier}: delete: tags: - User Subscription summary: Delete User Subscription description: Deletes a user's subscription. operationId: user-subscription-delete-user-subscription parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete User Subscription response failure content: application/json: schema: allOf: - type: object properties: subscription_id: $ref: '#/components/schemas/bill-subs-api_schemas-identifier' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' "200": description: Delete User Subscription response content: application/json: schema: type: object properties: subscription_id: $ref: '#/components/schemas/bill-subs-api_schemas-identifier' security: - api_email: [] api_key: [] api_token: [] put: tags: - User Subscription summary: Update User Subscription description: Updates a user's subscriptions. operationId: user-subscription-update-user-subscription parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_schemas-identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_subscription-v2' responses: 4XX: description: Update User Subscription response failure 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' "200": description: Update User Subscription response content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_user_subscription_response_single' security: - api_email: [] api_key: [] api_token: [] /user/tokens: get: tags: - User API Tokens summary: List Tokens description: List all access tokens you created. operationId: user-api-tokens-list-tokens parameters: - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Maximum number of results per page. default: 20 minimum: 5 maximum: 50 - name: direction in: query schema: type: string description: Direction to order results. enum: - asc - desc example: desc responses: 4XX: description: List Tokens response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_collection' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: List Tokens response content: application/json: schema: $ref: '#/components/schemas/iam_response_collection' security: - api_token: [] post: tags: - User API Tokens summary: Create Token description: Create a new access token. operationId: user-api-tokens-create-token requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/iam_create_payload' responses: 4XX: description: Create Token response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_create' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Create Token response content: application/json: schema: $ref: '#/components/schemas/iam_response_create' security: - api_token: [] /user/tokens/{token_id}: delete: tags: - User API Tokens summary: Delete Token description: Destroy a token. operationId: user-api-tokens-delete-token parameters: - name: token_id in: path required: true schema: $ref: '#/components/schemas/iam_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Token response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_api-response-single-id' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Delete Token response content: application/json: schema: $ref: '#/components/schemas/iam_api-response-single-id' security: - api_token: [] get: tags: - User API Tokens summary: Token Details description: Get information about a specific token. operationId: user-api-tokens-token-details parameters: - name: token_id in: path required: true schema: $ref: '#/components/schemas/iam_schemas-identifier' responses: 4XX: description: Token Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_single' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Token Details response content: application/json: schema: $ref: '#/components/schemas/iam_response_single' security: - api_token: [] put: tags: - User API Tokens summary: Update Token description: Update an existing token. operationId: user-api-tokens-update-token parameters: - name: token_id in: path required: true schema: $ref: '#/components/schemas/iam_schemas-identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/iam_schemas-token' responses: 4XX: description: Update Token response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_single' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Update Token response content: application/json: schema: $ref: '#/components/schemas/iam_response_single' security: - api_token: [] /user/tokens/{token_id}/value: put: tags: - User API Tokens summary: Roll Token description: Roll the token secret. operationId: user-api-tokens-roll-token parameters: - name: token_id in: path required: true schema: $ref: '#/components/schemas/iam_schemas-identifier' requestBody: required: true content: application/json: schema: type: object responses: 4XX: description: Roll Token response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_single_value' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Roll Token response content: application/json: schema: $ref: '#/components/schemas/iam_response_single_value' security: - api_token: [] /user/tokens/permission_groups: get: tags: - Permission Groups summary: List Permission Groups description: Find all available permission groups. operationId: permission-groups-list-permission-groups responses: 4XX: description: List Permission Groups response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_schemas-response_collection' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: List Permission Groups response content: application/json: schema: $ref: '#/components/schemas/iam_schemas-response_collection' security: - api_token: [] /user/tokens/verify: get: tags: - User API Tokens summary: Verify Token description: Test whether a token works. operationId: user-api-tokens-verify-token responses: 4XX: description: Verify Token response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/iam_response_single_segment' - $ref: '#/components/schemas/iam_api-response-common-failure' "200": description: Verify Token response content: application/json: schema: $ref: '#/components/schemas/iam_response_single_segment' security: - api_token: [] /zones: get: tags: - Zone summary: List Zones description: Lists, searches, sorts, and filters your zones. operationId: zones-get parameters: - name: name in: query schema: type: string description: | A domain name. Optional filter operators can be provided to extend refine the search: * `equal` (default) * `not_equal` * `starts_with` * `ends_with` * `contains` * `starts_with_case_sensitive` * `ends_with_case_sensitive` * `contains_case_sensitive` maxLength: 253 examples: Basic Query: summary: Simple Query value: example.com Contains Query: summary: Contains Query value: contains:.org Ends With Query: summary: Ends With Query value: ends_with:arpa Starts With Query: summary: Starts With Query value: starts_with:dev - name: status in: query schema: type: string description: A zone status enum: - initializing - pending - active - moved - name: account.id in: query schema: type: string description: An account ID - name: account.name in: query schema: type: string description: | An account Name. Optional filter operators can be provided to extend refine the search: * `equal` (default) * `not_equal` * `starts_with` * `ends_with` * `contains` * `starts_with_case_sensitive` * `ends_with_case_sensitive` * `contains_case_sensitive` maxLength: 253 examples: Basic Query: summary: Simple Query value: Dev Account Contains Query: summary: Contains Query value: contains:Test - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of zones per page. default: 20 minimum: 5 maximum: 50 - name: order in: query schema: type: string description: Field to order zones by. enum: - name - status - account.id - account.name example: status - name: direction in: query schema: type: string description: Direction to order zones. enum: - asc - desc example: desc - name: match in: query schema: type: string description: Whether to match all search requirements or at least one (any). enum: - any - all default: all responses: 4XX: description: List Zones response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: List Zones response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_api-response-common' - properties: result_info: $ref: '#/components/schemas/zones_result_info' - properties: result: type: array items: $ref: '#/components/schemas/zones_zone' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Zone summary: Create Zone operationId: zones-post requestBody: required: true content: application/json: schema: type: object required: - name - account properties: account: type: object properties: id: $ref: '#/components/schemas/zones_identifier' name: $ref: '#/components/schemas/zones_name' type: $ref: '#/components/schemas/zones_type' responses: 4XX: description: Create Zone response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Create Zone response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_api-response-common' - type: object properties: result: $ref: '#/components/schemas/zones_zone' security: - api_token: [] - api_email: [] api_key: [] /zones/{identifier}/access/apps: get: tags: - Zone-Level Access applications summary: List Access Applications description: List all Access Applications in a zone. operationId: zone-level-access-applications-list-access-applications parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List Access Applications response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List Access Applications response content: application/json: schema: $ref: '#/components/schemas/access_apps_components-schemas-response_collection-2' security: - api_email: [] api_key: [] post: tags: - Zone-Level Access applications summary: Add an Access application description: Adds a new application to Access. operationId: zone-level-access-applications-add-a-bookmark-application parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/access_schemas-apps' responses: 4XX: description: Add an Access application response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Add an Access application response content: application/json: schema: allOf: - $ref: '#/components/schemas/access_apps_components-schemas-single_response-2' - properties: result: $ref: '#/components/schemas/access_schemas-apps' security: - api_email: [] api_key: [] /zones/{identifier}/access/apps/{app_id}: delete: tags: - Zone-Level Access applications summary: Delete an Access application description: Deletes an application from Access. operationId: zone-level-access-applications-delete-an-access-application parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/access_app_id' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete an Access application response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Delete an Access application response content: application/json: schema: $ref: '#/components/schemas/access_id_response' security: - api_email: [] api_key: [] get: tags: - Zone-Level Access applications summary: Get an Access application description: Fetches information about an Access application. operationId: zone-level-access-applications-get-an-access-application parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/access_app_id' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get an Access application response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get an Access application response content: application/json: schema: $ref: '#/components/schemas/access_apps_components-schemas-single_response-2' security: - api_email: [] api_key: [] put: tags: - Zone-Level Access applications summary: Update an Access application description: Updates an Access application. operationId: zone-level-access-applications-update-a-bookmark-application parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/access_app_id' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/access_schemas-apps' responses: 4XX: description: Update an Access application response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update an Access application response content: application/json: schema: allOf: - $ref: '#/components/schemas/access_apps_components-schemas-single_response-2' - properties: result: $ref: '#/components/schemas/access_schemas-apps' security: - api_email: [] api_key: [] /zones/{identifier}/access/apps/{app_id}/revoke_tokens: post: tags: - Zone-Level Access applications summary: Revoke application tokens description: Revokes all tokens issued for an application. operationId: zone-level-access-applications-revoke-service-tokens parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/access_app_id' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Revoke application tokens response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Revoke application tokens response content: application/json: schema: $ref: '#/components/schemas/access_schemas-empty_response' security: - api_email: [] api_key: [] /zones/{identifier}/access/apps/{app_id}/user_policy_checks: get: tags: - Zone-Level Access applications summary: Test Access policies description: Tests if a specific user has permission to access an application. operationId: zone-level-access-applications-test-access-policies parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/access_app_id' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Test Access policies response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Test Access policies response content: application/json: schema: $ref: '#/components/schemas/access_schemas-policy_check_response' security: - api_email: [] api_key: [] /zones/{identifier}/access/apps/{uuid}/ca: delete: tags: - Zone-Level Access short-lived certificate CAs summary: Delete a short-lived certificate CA description: Deletes a short-lived certificate CA. operationId: zone-level-access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete a short-lived certificate CA response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Delete a short-lived certificate CA response content: application/json: schema: $ref: '#/components/schemas/access_schemas-id_response' security: - api_email: [] api_key: [] get: tags: - Zone-Level Access short-lived certificate CAs summary: Get a short-lived certificate CA description: Fetches a short-lived certificate CA and its public key. operationId: zone-level-access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get a short-lived certificate CA response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get a short-lived certificate CA response content: application/json: schema: $ref: '#/components/schemas/access_ca_components-schemas-single_response' security: - api_email: [] api_key: [] post: tags: - Zone-Level Access short-lived certificate CAs summary: Create a short-lived certificate CA description: Generates a new short-lived certificate CA and public key. operationId: zone-level-access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Create a short-lived certificate CA response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Create a short-lived certificate CA response content: application/json: schema: $ref: '#/components/schemas/access_ca_components-schemas-single_response' security: - api_email: [] api_key: [] /zones/{identifier}/access/apps/{uuid}/policies: get: tags: - Zone-Level Access policies summary: List Access policies description: Lists Access policies configured for an application. operationId: zone-level-access-policies-list-access-policies parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List Access policies response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List Access policies response content: application/json: schema: $ref: '#/components/schemas/access_policies_components-schemas-response_collection-2' security: - api_email: [] api_key: [] post: tags: - Zone-Level Access policies summary: Create an Access policy description: Create a new Access policy for an application. operationId: zone-level-access-policies-create-an-access-policy parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name - decision - include properties: approval_groups: $ref: '#/components/schemas/access_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_precedence' purpose_justification_prompt: $ref: '#/components/schemas/access_purpose_justification_prompt' purpose_justification_required: $ref: '#/components/schemas/access_purpose_justification_required' require: $ref: '#/components/schemas/access_schemas-require' responses: 4XX: description: Create an Access policy response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Create an Access policy response content: application/json: schema: $ref: '#/components/schemas/access_policies_components-schemas-single_response-2' security: - api_email: [] api_key: [] /zones/{identifier}/access/apps/{uuid1}/policies/{uuid}: delete: tags: - Zone-Level Access policies summary: Delete an Access policy description: Delete an Access policy. operationId: zone-level-access-policies-delete-an-access-policy parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: uuid1 in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete an Access policy response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Delete an Access policy response content: application/json: schema: $ref: '#/components/schemas/access_id_response' security: - api_email: [] api_key: [] get: tags: - Zone-Level Access policies summary: Get an Access policy description: Fetches a single Access policy. operationId: zone-level-access-policies-get-an-access-policy parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: uuid1 in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get an Access policy response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get an Access policy response content: application/json: schema: $ref: '#/components/schemas/access_policies_components-schemas-single_response-2' security: - api_email: [] api_key: [] put: tags: - Zone-Level Access policies summary: Update an Access policy description: Update a configured Access policy. operationId: zone-level-access-policies-update-an-access-policy parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: uuid1 in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name - decision - include properties: approval_groups: $ref: '#/components/schemas/access_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_precedence' purpose_justification_prompt: $ref: '#/components/schemas/access_purpose_justification_prompt' purpose_justification_required: $ref: '#/components/schemas/access_purpose_justification_required' require: $ref: '#/components/schemas/access_schemas-require' responses: 4XX: description: Update an Access policy response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update an Access policy response content: application/json: schema: $ref: '#/components/schemas/access_policies_components-schemas-single_response-2' security: - api_email: [] api_key: [] /zones/{identifier}/access/apps/ca: get: tags: - Zone-Level Access short-lived certificate CAs summary: List short-lived certificate CAs description: Lists short-lived certificate CAs and their public keys. operationId: zone-level-access-short-lived-certificate-c-as-list-short-lived-certificate-c-as parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List short-lived certificate CAs response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List short-lived certificate CAs response content: application/json: schema: $ref: '#/components/schemas/access_ca_components-schemas-response_collection' security: - api_email: [] api_key: [] /zones/{identifier}/access/certificates: get: tags: - Zone-Level Access mTLS authentication summary: List mTLS certificates description: Lists all mTLS certificates. operationId: zone-level-access-mtls-authentication-list-mtls-certificates parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List mTLS certificates response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List mTLS certificates response content: application/json: schema: $ref: '#/components/schemas/access_certificates_components-schemas-response_collection-2' security: - api_email: [] api_key: [] post: tags: - Zone-Level Access mTLS authentication summary: Add an mTLS certificate description: Adds a new mTLS root certificate to Access. operationId: zone-level-access-mtls-authentication-add-an-mtls-certificate parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name - certificate properties: associated_hostnames: $ref: '#/components/schemas/access_associated_hostnames' certificate: type: string description: The certificate content. example: |- -----BEGIN CERTIFICATE----- MIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10 DrUtmu/B -----END CERTIFICATE----- name: $ref: '#/components/schemas/access_certificates_components-schemas-name' responses: 4XX: description: Add an mTLS certificate response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Add an mTLS certificate response content: application/json: schema: $ref: '#/components/schemas/access_certificates_components-schemas-single_response-2' security: - api_email: [] api_key: [] /zones/{identifier}/access/certificates/{uuid}: delete: tags: - Zone-Level Access mTLS authentication summary: Delete an mTLS certificate description: Deletes an mTLS certificate. operationId: zone-level-access-mtls-authentication-delete-an-mtls-certificate parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete an mTLS certificate response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Delete an mTLS certificate response content: application/json: schema: $ref: '#/components/schemas/access_components-schemas-id_response' security: - api_email: [] api_key: [] get: tags: - Zone-Level Access mTLS authentication summary: Get an mTLS certificate description: Fetches a single mTLS certificate. operationId: zone-level-access-mtls-authentication-get-an-mtls-certificate parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get an mTLS certificate response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get an mTLS certificate response content: application/json: schema: $ref: '#/components/schemas/access_certificates_components-schemas-single_response-2' security: - api_email: [] api_key: [] put: tags: - Zone-Level Access mTLS authentication summary: Update an mTLS certificate description: Updates a configured mTLS certificate. operationId: zone-level-access-mtls-authentication-update-an-mtls-certificate parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - associated_hostnames properties: associated_hostnames: $ref: '#/components/schemas/access_associated_hostnames' name: $ref: '#/components/schemas/access_certificates_components-schemas-name' responses: 4XX: description: Update an mTLS certificate response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update an mTLS certificate response content: application/json: schema: $ref: '#/components/schemas/access_certificates_components-schemas-single_response-2' security: - api_email: [] api_key: [] /zones/{identifier}/access/certificates/settings: get: tags: - Zone-Level Access mTLS authentication summary: List all mTLS hostname settings description: List all mTLS hostname settings for this zone. operationId: zone-level-access-mtls-authentication-list-mtls-certificates-hostname-settings parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List mTLS hostname settings response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List mTLS hostname settings response content: application/json: schema: $ref: '#/components/schemas/access_response_collection_hostnames' security: - api_email: [] api_key: [] put: tags: - Zone-Level Access mTLS authentication summary: Update an mTLS certificate's hostname settings description: Updates an mTLS certificate's hostname settings. operationId: zone-level-access-mtls-authentication-update-an-mtls-certificate-settings parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: type: object required: - settings properties: settings: type: array items: $ref: '#/components/schemas/access_settings' responses: 4XX: description: Update an mTLS certificates hostname settings failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Update an mTLS certificates hostname settings response content: application/json: schema: $ref: '#/components/schemas/access_response_collection_hostnames' security: - api_email: [] api_key: [] /zones/{identifier}/access/groups: get: tags: - Zone-Level Access groups summary: List Access groups description: Lists all Access groups. operationId: zone-level-access-groups-list-access-groups parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List Access groups response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List Access groups response content: application/json: schema: $ref: '#/components/schemas/access_groups_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Zone-Level Access groups summary: Create an Access group description: Creates a new Access group. operationId: zone-level-access-groups-create-an-access-group parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name - include properties: exclude: $ref: '#/components/schemas/access_exclude' include: $ref: '#/components/schemas/access_include' name: $ref: '#/components/schemas/access_components-schemas-name' require: $ref: '#/components/schemas/access_require' responses: 4XX: description: Create an Access group response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Create an Access group response content: application/json: schema: $ref: '#/components/schemas/access_groups_components-schemas-single_response' security: - api_email: [] api_key: [] /zones/{identifier}/access/groups/{uuid}: delete: tags: - Zone-Level Access groups summary: Delete an Access group description: Deletes an Access group. operationId: zone-level-access-groups-delete-an-access-group parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete an Access group response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Delete an Access group response content: application/json: schema: $ref: '#/components/schemas/access_id_response' security: - api_email: [] api_key: [] get: tags: - Zone-Level Access groups summary: Get an Access group description: Fetches a single Access group. operationId: zone-level-access-groups-get-an-access-group parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get an Access group response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get an Access group response content: application/json: schema: $ref: '#/components/schemas/access_groups_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Zone-Level Access groups summary: Update an Access group description: Updates a configured Access group. operationId: zone-level-access-groups-update-an-access-group parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name - include properties: exclude: $ref: '#/components/schemas/access_exclude' include: $ref: '#/components/schemas/access_include' name: $ref: '#/components/schemas/access_components-schemas-name' require: $ref: '#/components/schemas/access_require' responses: 4XX: description: Update an Access group response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update an Access group response content: application/json: schema: $ref: '#/components/schemas/access_groups_components-schemas-single_response' security: - api_email: [] api_key: [] /zones/{identifier}/access/identity_providers: get: tags: - Zone-Level Access identity providers summary: List Access identity providers description: Lists all configured identity providers. operationId: zone-level-access-identity-providers-list-access-identity-providers parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List Access identity providers response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List Access identity providers response content: application/json: schema: $ref: '#/components/schemas/access_identity-providers_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Zone-Level Access identity providers summary: Add an Access identity provider description: Adds a new identity provider to Access. operationId: zone-level-access-identity-providers-add-an-access-identity-provider parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/access_schemas-identity-providers' responses: 4XX: description: Add an Access identity provider response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Add an Access identity provider response content: application/json: schema: $ref: '#/components/schemas/access_identity-providers_components-schemas-single_response' security: - api_email: [] api_key: [] /zones/{identifier}/access/identity_providers/{uuid}: delete: tags: - Zone-Level Access identity providers summary: Delete an Access identity provider description: Deletes an identity provider from Access. operationId: zone-level-access-identity-providers-delete-an-access-identity-provider parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete an Access identity provider response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "202": description: Delete an Access identity provider response content: application/json: schema: $ref: '#/components/schemas/access_id_response' security: - api_email: [] api_key: [] get: tags: - Zone-Level Access identity providers summary: Get an Access identity provider description: Fetches a configured identity provider. operationId: zone-level-access-identity-providers-get-an-access-identity-provider parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Get an Access identity provider response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get an Access identity provider response content: application/json: schema: $ref: '#/components/schemas/access_identity-providers_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Zone-Level Access identity providers summary: Update an Access identity provider description: Updates a configured identity provider. operationId: zone-level-access-identity-providers-update-an-access-identity-provider parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/access_schemas-identity-providers' responses: 4XX: description: Update an Access identity provider response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update an Access identity provider response content: application/json: schema: $ref: '#/components/schemas/access_identity-providers_components-schemas-single_response' security: - api_email: [] api_key: [] /zones/{identifier}/access/organizations: get: tags: - Zone-Level Zero Trust organization summary: Get your Zero Trust organization description: Returns the configuration for your Zero Trust organization. operationId: zone-level-zero-trust-organization-get-your-zero-trust-organization parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_components-schemas-identifier' responses: 4XX: description: Get your Zero Trust organization response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Get your Zero Trust organization response content: application/json: schema: $ref: '#/components/schemas/access_organizations_components-schemas-single_response' security: - api_email: [] api_key: [] post: tags: - Zone-Level Zero Trust organization summary: Create your Zero Trust organization description: Sets up a Zero Trust organization for your account. operationId: zone-level-zero-trust-organization-create-your-zero-trust-organization parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_components-schemas-identifier' requestBody: required: true content: application/json: schema: required: - name - auth_domain properties: auth_domain: $ref: '#/components/schemas/access_auth_domain' is_ui_read_only: $ref: '#/components/schemas/access_is_ui_read_only' login_design: $ref: '#/components/schemas/access_login_design' name: $ref: '#/components/schemas/access_name' ui_read_only_toggle_reason: $ref: '#/components/schemas/access_ui_read_only_toggle_reason' user_seat_expiration_inactive_time: $ref: '#/components/schemas/access_user_seat_expiration_inactive_time' responses: 4XX: description: Create your Zero Trust organization response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Create your Zero Trust organization response content: application/json: schema: $ref: '#/components/schemas/access_organizations_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Zone-Level Zero Trust organization summary: Update your Zero Trust organization description: Updates the configuration for your Zero Trust organization. operationId: zone-level-zero-trust-organization-update-your-zero-trust-organization parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_components-schemas-identifier' requestBody: required: true content: application/json: schema: properties: auth_domain: $ref: '#/components/schemas/access_auth_domain' is_ui_read_only: $ref: '#/components/schemas/access_is_ui_read_only' login_design: $ref: '#/components/schemas/access_login_design' name: $ref: '#/components/schemas/access_name' ui_read_only_toggle_reason: $ref: '#/components/schemas/access_ui_read_only_toggle_reason' user_seat_expiration_inactive_time: $ref: '#/components/schemas/access_user_seat_expiration_inactive_time' responses: 4XX: description: Update your Zero Trust organization response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update your Zero Trust organization response content: application/json: schema: $ref: '#/components/schemas/access_organizations_components-schemas-single_response' security: - api_email: [] api_key: [] /zones/{identifier}/access/organizations/revoke_user: post: tags: - Zone-Level Zero Trust organization summary: Revoke all Access tokens for a user description: Revokes a user's access across all applications. operationId: zone-level-zero-trust-organization-revoke-all-access-tokens-for-a-user parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_components-schemas-identifier' requestBody: required: true content: application/json: schema: required: - email properties: email: type: string description: The email of the user to revoke. example: test@example.com responses: 4xx: description: Revoke all Access tokens for a user response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Revoke all Access tokens for a user response content: application/json: schema: $ref: '#/components/schemas/access_empty_response' security: - api_email: [] api_key: [] /zones/{identifier}/access/service_tokens: get: tags: - Zone-Level Access service tokens summary: List service tokens description: Lists all service tokens. operationId: zone-level-access-service-tokens-list-service-tokens parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: List service tokens response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: List service tokens response content: application/json: schema: $ref: '#/components/schemas/access_components-schemas-response_collection' security: - api_email: [] api_key: [] post: tags: - Zone-Level Access service tokens summary: Create a service token description: Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to create a new service token. operationId: zone-level-access-service-tokens-create-a-service-token parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: required: - name properties: duration: $ref: '#/components/schemas/access_duration' name: $ref: '#/components/schemas/access_service-tokens_components-schemas-name' responses: 4XX: description: Create a service token response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "201": description: Create a service token response content: application/json: schema: $ref: '#/components/schemas/access_create_response' security: - api_email: [] api_key: [] /zones/{identifier}/access/service_tokens/{uuid}: delete: tags: - Zone-Level Access service tokens summary: Delete a service token description: Deletes a service token. operationId: zone-level-access-service-tokens-delete-a-service-token parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: description: Delete a service token response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Delete a service token response content: application/json: schema: $ref: '#/components/schemas/access_service-tokens_components-schemas-single_response' security: - api_email: [] api_key: [] put: tags: - Zone-Level Access service tokens summary: Update a service token description: Updates a configured service token. operationId: zone-level-access-service-tokens-update-a-service-token parameters: - name: uuid in: path required: true schema: $ref: '#/components/schemas/access_uuid' - name: identifier in: path required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: required: true content: application/json: schema: properties: duration: $ref: '#/components/schemas/access_duration' name: $ref: '#/components/schemas/access_service-tokens_components-schemas-name' responses: 4XX: description: Update a service token response failure content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' "200": description: Update a service token response content: application/json: schema: $ref: '#/components/schemas/access_service-tokens_components-schemas-single_response' security: - api_email: [] api_key: [] /zones/{identifier}/subscription: get: tags: - Zone Subscription summary: Zone Subscription Details description: Lists zone subscription details. operationId: zone-subscription-zone-subscription-details parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_schemas-identifier' responses: 4XX: description: Zone Subscription Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' "200": description: Zone Subscription Details response content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single' security: - api_email: [] api_key: [] api_token: [] post: tags: - Zone Subscription summary: Create Zone Subscription description: Create a zone subscription, either plan or add-ons. operationId: zone-subscription-create-zone-subscription parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_schemas-identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_subscription-v2' responses: 4XX: description: Create Zone Subscription response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' "200": description: Create Zone Subscription response content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single' security: - api_email: [] api_key: [] api_token: [] put: tags: - Zone Subscription summary: Update Zone Subscription description: Updates zone subscriptions, either plan or add-ons. operationId: zone-subscription-update-zone-subscription parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_schemas-identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_subscription-v2' responses: 4XX: description: Update Zone Subscription response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' "200": description: Update Zone Subscription response content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}: delete: tags: - Zone summary: Delete Zone description: Deletes an existing zone. operationId: zones-0-delete parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: content: application/json: {} responses: 4XX: description: Delete Zone response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Delete Zone response content: application/json: schema: $ref: '#/components/schemas/zones_api-response-single-id' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Zone summary: Zone Details operationId: zones-0-get parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Zone Details response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Zone Details response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_api-response-common' - type: object properties: result: $ref: '#/components/schemas/zones_zone' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone summary: Edit Zone description: Edits a zone. Only one zone property can be changed at a time. operationId: zones-0-patch parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: type: object example: paused: true properties: paused: $ref: '#/components/schemas/zones_paused' plan: type: object description: | (Deprecated) Please use the `/zones/{zone_id}/subscription` API to update a zone's plan. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans. properties: id: $ref: '#/components/schemas/zones_identifier' type: type: string description: | A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone. enum: - full - partial - secondary example: full vanity_name_servers: $ref: '#/components/schemas/zones_vanity_name_servers' responses: 4XX: description: Edit Zone response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Edit Zone response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_api-response-common' - type: object properties: result: $ref: '#/components/schemas/zones_zone' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/acm/total_tls: get: tags: - Total TLS summary: Total TLS Settings Details description: Get Total TLS Settings for a Zone. operationId: total-tls-total-tls-settings-details parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Total TLS Settings Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_total_tls_settings_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Total TLS Settings Details response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_total_tls_settings_response' security: - api_email: [] api_key: [] post: tags: - Total TLS summary: Enable or Disable Total TLS description: Set Total TLS Settings or disable the feature for a Zone. operationId: total-tls-enable-or-disable-total-tls parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: required: - enabled properties: certificate_authority: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_authority' enabled: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-enabled' responses: 4XX: description: Enable or Disable Total TLS response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_total_tls_settings_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Enable or Disable Total TLS response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_total_tls_settings_response' security: - api_email: [] api_key: [] /zones/{zone_id}/activation_check: put: tags: - Zone summary: Rerun the Activation Check description: |- Triggeres a new activation check for a PENDING Zone. This can be triggered every 5 min for paygo/ent customers, every hour for FREE Zones. operationId: put-zones-zone_id-activation_check parameters: - name: zone_id in: path description: Zone ID required: true schema: $ref: '#/components/schemas/zone-activation_identifier' responses: 4XX: description: Client Error content: application/json: schema: allOf: - $ref: '#/components/schemas/zone-activation_api-response-common-failure' "200": description: Successful Response content: application/json: schema: allOf: - $ref: '#/components/schemas/zone-activation_api-response-single' - type: object properties: result: type: object properties: id: $ref: '#/components/schemas/zone-activation_identifier' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/analytics/latency: get: tags: - Argo Analytics for Zone summary: Argo Analytics for a zone operationId: argo-analytics-for-zone-argo-analytics-for-a-zone parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/argo-analytics_identifier' - name: bins in: query schema: type: string responses: 4XX: description: Argo Analytics for a zone response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/argo-analytics_response_single' - $ref: '#/components/schemas/argo-analytics_api-response-common-failure' "200": description: Argo Analytics for a zone response content: application/json: schema: $ref: '#/components/schemas/argo-analytics_response_single' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/analytics/latency/colos: get: tags: - Argo Analytics for Geolocation summary: Argo Analytics for a zone at different PoPs operationId: argo-analytics-for-geolocation-argo-analytics-for-a-zone-at-different-po-ps parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/argo-analytics_identifier' responses: 4XX: description: Argo Analytics for a zone at different PoPs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/argo-analytics_response_single' - $ref: '#/components/schemas/argo-analytics_api-response-common-failure' "200": description: Argo Analytics for a zone at different PoPs response content: application/json: schema: $ref: '#/components/schemas/argo-analytics_response_single' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/api_gateway/configuration: get: tags: - API Shield Settings summary: Retrieve information about specific configuration properties operationId: api-shield-settings-retrieve-information-about-specific-configuration-properties parameters: - $ref: '#/components/parameters/api-shield_zone_id' - name: properties in: query schema: $ref: '#/components/schemas/api-shield_properties' responses: 4XX: description: Retrieve information about specific configuration properties response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_single_response' - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Retrieve information about specific configuration properties response content: application/json: schema: $ref: '#/components/schemas/api-shield_single_response' security: - api_email: [] api_key: [] api_token: [] put: tags: - API Shield Settings summary: Set configuration properties operationId: api-shield-settings-set-configuration-properties parameters: - $ref: '#/components/parameters/api-shield_zone_id' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/api-shield_configuration' responses: 4XX: description: Set configuration properties response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_default_response' - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Set configuration properties response content: application/json: schema: $ref: '#/components/schemas/api-shield_default_response' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/api_gateway/discovery: get: tags: - API Shield API Discovery summary: Retrieve discovered operations on a zone rendered as OpenAPI schemas description: Retrieve the most up to date view of discovered operations, rendered as OpenAPI schemas operationId: api-shield-api-discovery-retrieve-discovered-operations-on-a-zone-as-openapi parameters: - $ref: '#/components/parameters/api-shield_zone_id' responses: 4XX: description: Retrieve discovered operations on a zone, rendered as OpenAPI schemas response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_schema_response_discovery' - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Retrieve discovered operations on a zone, rendered as OpenAPI schemas response content: application/json: schema: $ref: '#/components/schemas/api-shield_schema_response_discovery' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/api_gateway/discovery/operations: get: tags: - API Shield API Discovery summary: Retrieve discovered operations on a zone description: Retrieve the most up to date view of discovered operations operationId: api-shield-api-discovery-retrieve-discovered-operations-on-a-zone parameters: - $ref: '#/components/parameters/api-shield_zone_id' - $ref: '#/components/parameters/api-shield_page' - $ref: '#/components/parameters/api-shield_per_page' - $ref: '#/components/parameters/api-shield_host_parameter' - $ref: '#/components/parameters/api-shield_method_parameter' - $ref: '#/components/parameters/api-shield_endpoint_parameter' - $ref: '#/components/parameters/api-shield_direction_parameter' - $ref: '#/components/parameters/api-shield_order_parameter' - $ref: '#/components/parameters/api-shield_diff_parameter' - $ref: '#/components/parameters/api-shield_api_discovery_origin_parameter' - $ref: '#/components/parameters/api-shield_api_discovery_state_parameter' responses: 4XX: description: Retrieve discovered operations on a zone response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Retrieve discovered operations on a zone response content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-collection' - properties: result: type: array items: anyOf: - $ref: '#/components/schemas/api-shield_discovery_operation' security: - api_email: [] api_key: [] api_token: [] patch: tags: - API Shield API Discovery summary: Patch discovered operations description: Update the `state` on one or more discovered operations operationId: api-shield-api-patch-discovered-operations parameters: - $ref: '#/components/parameters/api-shield_zone_id' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/api-shield_api_discovery_patch_multiple_request' responses: 4XX: description: Patch discovered operations response failure content: application/json: schema: $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Patch discovered operations response content: application/json: schema: $ref: '#/components/schemas/api-shield_patch_discoveries_response' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/api_gateway/discovery/operations/{operation_id}: patch: tags: - API Shield API Discovery summary: Patch discovered operation description: Update the `state` on a discovered operation operationId: api-shield-api-patch-discovered-operation parameters: - $ref: '#/components/parameters/api-shield_zone_id' - $ref: '#/components/parameters/api-shield_parameters-operation_id' requestBody: required: true content: application/json: schema: type: object properties: state: allOf: - $ref: '#/components/schemas/api-shield_api_discovery_state_patch' responses: 4XX: description: Patch discovered operation response failure content: application/json: schema: $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Patch discovered operation response content: application/json: schema: $ref: '#/components/schemas/api-shield_patch_discovery_response' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/api_gateway/operations: get: tags: - API Shield Endpoint Management summary: Retrieve information about all operations on a zone operationId: api-shield-endpoint-management-retrieve-information-about-all-operations-on-a-zone parameters: - $ref: '#/components/parameters/api-shield_zone_id' - $ref: '#/components/parameters/api-shield_page' - name: per_page in: query description: Number of results to return per page schema: type: number default: 20 minimum: 5 - name: order in: query schema: type: string description: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., `thresholds.suggested_threshold`. enum: - method - host - endpoint - thresholds.$key example: method - $ref: '#/components/parameters/api-shield_direction_parameter' - $ref: '#/components/parameters/api-shield_host_parameter' - $ref: '#/components/parameters/api-shield_method_parameter' - $ref: '#/components/parameters/api-shield_endpoint_parameter' - $ref: '#/components/parameters/api-shield_operation_feature_parameter' responses: 4XX: description: Retrieve information about all operations on a zone response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Retrieve information about all operations on a zone response content: application/json: schema: $ref: '#/components/schemas/api-shield_collection_response_paginated' security: - api_email: [] api_key: [] api_token: [] post: tags: - API Shield Endpoint Management summary: Add operations to a zone description: Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date. operationId: api-shield-endpoint-management-add-operations-to-a-zone parameters: - $ref: '#/components/parameters/api-shield_zone_id' requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/api-shield_basic_operation' responses: 4XX: description: Add operations to a zone response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_collection_response' - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Add operations to a zone response content: application/json: schema: $ref: '#/components/schemas/api-shield_collection_response' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/api_gateway/operations/{operation_id}: delete: tags: - API Shield Endpoint Management summary: Delete an operation operationId: api-shield-endpoint-management-delete-an-operation parameters: - $ref: '#/components/parameters/api-shield_zone_id' - $ref: '#/components/parameters/api-shield_operation_id' responses: 4XX: description: Delete an operation response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_default_response' - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Delete an operation response content: application/json: schema: $ref: '#/components/schemas/api-shield_default_response' security: - api_email: [] api_key: [] api_token: [] get: tags: - API Shield Endpoint Management summary: Retrieve information about an operation operationId: api-shield-endpoint-management-retrieve-information-about-an-operation parameters: - $ref: '#/components/parameters/api-shield_zone_id' - $ref: '#/components/parameters/api-shield_operation_id' - $ref: '#/components/parameters/api-shield_operation_feature_parameter' responses: 4XX: description: Retrieve information about an operation response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_schemas-single_response' - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Retrieve information about an operation response content: application/json: schema: $ref: '#/components/schemas/api-shield_schemas-single_response' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation: get: tags: - API Shield Schema Validation 2.0 summary: Retrieve operation-level schema validation settings description: Retrieves operation-level schema validation settings on the zone operationId: api-shield-schema-validation-retrieve-operation-level-settings parameters: - $ref: '#/components/parameters/api-shield_zone_id' - $ref: '#/components/parameters/api-shield_operation_id' responses: 4XX: description: Operation-level schema validation settings response content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Operation-level schema validation settings response content: application/json: schema: $ref: '#/components/schemas/api-shield_operation_schema_validation_settings' security: - api_email: [] api_key: [] api_token: [] put: tags: - API Shield Schema Validation 2.0 summary: Update operation-level schema validation settings description: Updates operation-level schema validation settings on the zone operationId: api-shield-schema-validation-update-operation-level-settings parameters: - $ref: '#/components/parameters/api-shield_zone_id' - $ref: '#/components/parameters/api-shield_operation_id' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/api-shield_operation_schema_validation_settings' responses: 4XX: description: Update operation-level schema validation settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Update operation-level schema validation settings response content: application/json: schema: $ref: '#/components/schemas/api-shield_operation_schema_validation_settings' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/api_gateway/operations/schema_validation: patch: tags: - API Shield Schema Validation 2.0 summary: Update multiple operation-level schema validation settings description: Updates multiple operation-level schema validation settings on the zone operationId: api-shield-schema-validation-update-multiple-operation-level-settings parameters: - $ref: '#/components/parameters/api-shield_zone_id' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/api-shield_operation_schema_validation_settings_multiple_request' responses: 4XX: description: Update multiple operation-level schema validation settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Update multiple operation-level schema validation settings response content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-single' - properties: result: $ref: '#/components/schemas/api-shield_operation_schema_validation_settings_multiple_request' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/api_gateway/schemas: get: tags: - API Shield Endpoint Management summary: Retrieve operations and features as OpenAPI schemas operationId: api-shield-endpoint-management-retrieve-operations-and-features-as-open-api-schemas parameters: - $ref: '#/components/parameters/api-shield_zone_id' - name: host in: query schema: type: array description: Receive schema only for the given host(s). uniqueItems: true items: type: string example: www.example.com - $ref: '#/components/parameters/api-shield_operation_feature_parameter' responses: 4XX: description: Retrieve operations and features as OpenAPI schemas response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_schema_response_with_thresholds' - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Retrieve operations and features as OpenAPI schemas response content: application/json: schema: $ref: '#/components/schemas/api-shield_schema_response_with_thresholds' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/api_gateway/settings/schema_validation: get: tags: - API Shield Schema Validation 2.0 summary: Retrieve zone level schema validation settings description: Retrieves zone level schema validation settings currently set on the zone operationId: api-shield-schema-validation-retrieve-zone-level-settings parameters: - $ref: '#/components/parameters/api-shield_zone_id' responses: 4XX: description: Zone level schema validation settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Zone level schema validation settings response content: application/json: schema: $ref: '#/components/schemas/api-shield_zone_schema_validation_settings' security: - api_email: [] api_key: [] api_token: [] patch: tags: - API Shield Schema Validation 2.0 summary: Update zone level schema validation settings description: Updates zone level schema validation settings on the zone operationId: api-shield-schema-validation-patch-zone-level-settings parameters: - $ref: '#/components/parameters/api-shield_zone_id' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/api-shield_zone_schema_validation_settings_patch' responses: 4XX: description: Update zone level schema validation settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Update zone level schema validation settings response content: application/json: schema: $ref: '#/components/schemas/api-shield_zone_schema_validation_settings' security: - api_email: [] api_key: [] api_token: [] put: tags: - API Shield Schema Validation 2.0 summary: Update zone level schema validation settings description: Updates zone level schema validation settings on the zone operationId: api-shield-schema-validation-update-zone-level-settings parameters: - $ref: '#/components/parameters/api-shield_zone_id' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/api-shield_zone_schema_validation_settings_put' responses: 4XX: description: Update zone level schema validation settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Update zone level schema validation settings response content: application/json: schema: $ref: '#/components/schemas/api-shield_zone_schema_validation_settings' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/api_gateway/user_schemas: get: tags: - API Shield Schema Validation 2.0 summary: Retrieve information about all schemas on a zone operationId: api-shield-schema-validation-retrieve-information-about-all-schemas parameters: - $ref: '#/components/parameters/api-shield_zone_id' - $ref: '#/components/parameters/api-shield_page' - $ref: '#/components/parameters/api-shield_per_page' - $ref: '#/components/parameters/api-shield_omit_source' - name: validation_enabled in: query schema: $ref: '#/components/schemas/api-shield_validation_enabled' responses: 4XX: description: Retrieve information about all schemas on a zone response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Retrieve information about all schemas on a zone response content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/api-shield_public_schema' security: - api_email: [] api_key: [] api_token: [] post: tags: - API Shield Schema Validation 2.0 summary: Upload a schema to a zone operationId: api-shield-schema-validation-post-schema parameters: - $ref: '#/components/parameters/api-shield_zone_id' requestBody: required: true content: multipart/form-data: schema: type: object required: - file - kind properties: file: type: string format: binary description: Schema file bytes kind: $ref: '#/components/schemas/api-shield_kind' name: type: string description: Name of the schema example: petstore schema validation_enabled: type: string description: Flag whether schema is enabled for validation. enum: - "true" - "false" responses: 4XX: description: Upload a schema response failure content: application/json: schema: $ref: '#/components/schemas/api-shield_schema_upload_failure' "200": description: Upload a schema response content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-single' - properties: result: $ref: '#/components/schemas/api-shield_schema_upload_response' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/api_gateway/user_schemas/{schema_id}: delete: tags: - API Shield Schema Validation 2.0 summary: Delete a schema operationId: api-shield-schema-delete-a-schema parameters: - $ref: '#/components/parameters/api-shield_zone_id' - $ref: '#/components/parameters/api-shield_schema_id' responses: 4XX: description: Delete a schema response failure content: application/json: schema: $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Delete a schema response content: application/json: schema: $ref: '#/components/schemas/api-shield_api-response-single' security: - api_email: [] api_key: [] api_token: [] get: tags: - API Shield Schema Validation 2.0 summary: Retrieve information about a specific schema on a zone operationId: api-shield-schema-validation-retrieve-information-about-specific-schema parameters: - $ref: '#/components/parameters/api-shield_zone_id' - $ref: '#/components/parameters/api-shield_schema_id' - $ref: '#/components/parameters/api-shield_omit_source' responses: 4XX: description: Retrieve information about a specific schema zone response failure content: application/json: schema: $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Retrieve information about a specific schema on a zone response content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-single' - properties: result: $ref: '#/components/schemas/api-shield_public_schema' security: - api_email: [] api_key: [] api_token: [] patch: tags: - API Shield Schema Validation 2.0 summary: Enable validation for a schema operationId: api-shield-schema-validation-enable-validation-for-a-schema parameters: - $ref: '#/components/parameters/api-shield_zone_id' - $ref: '#/components/parameters/api-shield_schema_id' requestBody: required: true content: application/json: schema: type: object properties: validation_enabled: allOf: - $ref: '#/components/schemas/api-shield_validation_enabled' - enum: - true responses: 4XX: description: Enable validation for a schema response failure content: application/json: schema: $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Enable validation for a schema response content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-single' - properties: result: $ref: '#/components/schemas/api-shield_public_schema' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/api_gateway/user_schemas/{schema_id}/operations: get: tags: - API Shield Schema Validation 2.0 summary: Retrieve all operations from a schema. description: Retrieves all operations from the schema. Operations that already exist in API Shield Endpoint Management will be returned as full operations. operationId: api-shield-schema-validation-extract-operations-from-schema parameters: - $ref: '#/components/parameters/api-shield_schema_id' - $ref: '#/components/parameters/api-shield_zone_id' - $ref: '#/components/parameters/api-shield_operation_feature_parameter' - $ref: '#/components/parameters/api-shield_host_parameter' - $ref: '#/components/parameters/api-shield_method_parameter' - $ref: '#/components/parameters/api-shield_endpoint_parameter' - $ref: '#/components/parameters/api-shield_page' - $ref: '#/components/parameters/api-shield_per_page' - name: operation_status in: query description: Filter results by whether operations exist in API Shield Endpoint Management or not. `new` will just return operations from the schema that do not exist in API Shield Endpoint Management. `existing` will just return operations from the schema that already exist in API Shield Endpoint Management. schema: type: string enum: - new - existing example: new responses: 4XX: description: Retrieve all operations from a schema response failure content: application/json: schema: $ref: '#/components/schemas/api-shield_api-response-common-failure' "200": description: Retrieve all operations from a schema response content: application/json: schema: allOf: - $ref: '#/components/schemas/api-shield_api-response-collection' - properties: result: type: array items: anyOf: - $ref: '#/components/schemas/api-shield_operation' - $ref: '#/components/schemas/api-shield_basic_operation' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/argo/smart_routing: get: tags: - Argo Smart Routing summary: Get Argo Smart Routing setting operationId: argo-smart-routing-get-argo-smart-routing-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/argo-config_identifier' responses: 4XX: description: Get Argo Smart Routing setting response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/argo-config_response_single' - $ref: '#/components/schemas/argo-config_api-response-common-failure' "200": description: Get Argo Smart Routing setting response content: application/json: schema: $ref: '#/components/schemas/argo-config_response_single' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Argo Smart Routing summary: Patch Argo Smart Routing setting description: Updates enablement of Argo Smart Routing. operationId: argo-smart-routing-patch-argo-smart-routing-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/argo-config_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/argo-config_patch' responses: 4XX: description: Patch Argo Smart Routing setting response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/argo-config_response_single' - $ref: '#/components/schemas/argo-config_api-response-common-failure' "200": description: Patch Argo Smart Routing setting response content: application/json: schema: $ref: '#/components/schemas/argo-config_response_single' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/argo/tiered_caching: get: tags: - Tiered Caching summary: Get Tiered Caching setting operationId: tiered-caching-get-tiered-caching-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' responses: 4XX: description: Get Tiered Caching setting response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_response_single' - $ref: '#/components/schemas/cache_api-response-common-failure' "200": description: Get Tiered Caching setting response content: application/json: schema: $ref: '#/components/schemas/cache_response_single' security: - api_email: [] api_key: [] patch: tags: - Tiered Caching summary: Patch Tiered Caching setting description: Updates enablement of Tiered Caching operationId: tiered-caching-patch-tiered-caching-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/cache_patch' responses: 4XX: description: Patch Tiered Caching setting response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_response_single' - $ref: '#/components/schemas/cache_api-response-common-failure' "200": description: Patch Tiered Caching setting response content: application/json: schema: $ref: '#/components/schemas/cache_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/bot_management: get: tags: - Bot Settings summary: Get Zone Bot Management Config description: Retrieve a zone's Bot Management Config operationId: bot-management-for-a-zone-get-config parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/bot-management_identifier' responses: 4XX: description: Bot Management config response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/bot-management_bot_management_response_body' - $ref: '#/components/schemas/bot-management_api-response-common-failure' "200": description: Bot Management config response content: application/json: schema: $ref: '#/components/schemas/bot-management_bot_management_response_body' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Bot Settings summary: Update Zone Bot Management Config description: | Updates the Bot Management configuration for a zone. This API is used to update: - **Bot Fight Mode** - **Super Bot Fight Mode** - **Bot Management for Enterprise** See [Bot Plans](https://developers.cloudflare.com/bots/plans/) for more information on the different plans operationId: bot-management-for-a-zone-update-config parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/bot-management_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/bot-management_config_single' responses: 4XX: description: Update Bot Management response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/bot-management_bot_management_response_body' - $ref: '#/components/schemas/bot-management_api-response-common-failure' "200": description: Update Bot Management response content: application/json: schema: $ref: '#/components/schemas/bot-management_bot_management_response_body' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/cache/cache_reserve: get: tags: - Zone Cache Settings summary: Get Cache Reserve setting description: 'Increase cache lifetimes by automatically storing all cacheable files into Cloudflare''s persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.' operationId: zone-cache-settings-get-cache-reserve-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' responses: 4XX: description: Get Cache Reserve setting response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_cache_reserve_response_value' - $ref: '#/components/schemas/cache_api-response-common-failure' examples: Error: $ref: '#/components/examples/cache_dummy_error_response' "200": description: Get Cache Reserve setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_cache_reserve_response_value' examples: "off": $ref: '#/components/examples/cache_cache_reserve_off' security: - api_email: [] api_key: [] patch: tags: - Zone Cache Settings summary: Change Cache Reserve setting description: 'Increase cache lifetimes by automatically storing all cacheable files into Cloudflare''s persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.' operationId: zone-cache-settings-change-cache-reserve-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/cache_cache_reserve_value' responses: 4XX: description: Change Cache Reserve setting response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_cache_reserve_response_value' - $ref: '#/components/schemas/cache_api-response-common-failure' examples: Denied: $ref: '#/components/examples/cache_cache_reserve_denied_clearing' "200": description: Change Cache Reserve setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_cache_reserve_response_value' examples: "off": $ref: '#/components/examples/cache_cache_reserve_off' security: - api_email: [] api_key: [] /zones/{zone_id}/cache/cache_reserve_clear: get: tags: - Zone Cache Settings summary: Get Cache Reserve Clear description: You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation. operationId: zone-cache-settings-get-cache-reserve-clear parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' responses: 4XX: description: Get Cache Reserve Clear failure response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_cache_reserve_clear_response_value' - $ref: '#/components/schemas/cache_api-response-common-failure' examples: Not found: $ref: '#/components/examples/cache_cache_reserve_clear_not_found' "200": description: Get Cache Reserve Clear response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_cache_reserve_clear_response_value' examples: Completed: $ref: '#/components/examples/cache_cache_reserve_clear_completed' In-progress: $ref: '#/components/examples/cache_cache_reserve_clear_in_progress' security: - api_email: [] api_key: [] post: tags: - Zone Cache Settings summary: Start Cache Reserve Clear description: You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation. operationId: zone-cache-settings-start-cache-reserve-clear parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' requestBody: description: The request body is currently not used. required: true content: application/json: example: '{}' responses: 4XX: description: Start Cache Reserve Clear failure response content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_cache_reserve_clear_response_value' - $ref: '#/components/schemas/cache_api-response-common-failure' examples: Rejected: $ref: '#/components/examples/cache_cache_reserve_clear_rejected_cr_on' "200": description: Start Cache Reserve Clear response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_cache_reserve_clear_response_value' examples: In-progress: $ref: '#/components/examples/cache_cache_reserve_clear_in_progress' security: - api_email: [] api_key: [] /zones/{zone_id}/cache/origin_post_quantum_encryption: get: tags: - Origin Post-Quantum summary: Get Origin Post-Quantum Encryption setting description: Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised operationId: zone-cache-settings-get-origin-post-quantum-encryption-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' responses: 4XX: description: Get Origin Post-Quantum Encryption setting response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_origin_post_quantum_encryption_value' - $ref: '#/components/schemas/cache_api-response-common-failure' "200": description: Get Origin Post-Quantum Encryption setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_origin_post_quantum_encryption_value' security: - api_email: [] api_key: [] put: tags: - Origin Post-Quantum summary: Change Origin Post-Quantum Encryption setting description: Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised operationId: zone-cache-settings-change-origin-post-quantum-encryption-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/cache_origin_post_quantum_encryption_value' responses: 4XX: description: Change Origin Post-Quantum Encryption setting response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_origin_post_quantum_encryption_value' - $ref: '#/components/schemas/cache_api-response-common-failure' "200": description: Change Origin Post-Quantum Encryption setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_origin_post_quantum_encryption_value' security: - api_email: [] api_key: [] /zones/{zone_id}/cache/regional_tiered_cache: get: tags: - Zone Cache Settings summary: Get Regional Tiered Cache setting description: Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies. operationId: zone-cache-settings-get-regional-tiered-cache-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' responses: 4XX: description: Get Regional Tiered Cache setting response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_regional_tiered_cache_response_value' - $ref: '#/components/schemas/cache_api-response-common-failure' "200": description: Get Regional Tiered Cache setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_regional_tiered_cache_response_value' security: - api_email: [] api_key: [] patch: tags: - Zone Cache Settings summary: Change Regional Tiered Cache setting description: Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies. operationId: zone-cache-settings-change-regional-tiered-cache-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/cache_regional_tiered_cache_value' responses: 4XX: description: Change Regional Tiered Cache setting response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_regional_tiered_cache_response_value' - $ref: '#/components/schemas/cache_api-response-common-failure' "200": description: Change Regional Tiered Cache setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_regional_tiered_cache_response_value' security: - api_email: [] api_key: [] /zones/{zone_id}/cache/tiered_cache_smart_topology_enable: delete: tags: - Smart Tiered Cache summary: Delete Smart Tiered Cache setting description: Remvoves enablement of Smart Tiered Cache operationId: smart-tiered-cache-delete-smart-tiered-cache-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Smart Tiered Cache setting response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_response_single' - $ref: '#/components/schemas/cache_api-response-common-failure' "200": description: Delete Smart Tiered Cache setting response content: application/json: schema: $ref: '#/components/schemas/cache_response_single' security: - api_email: [] api_key: [] get: tags: - Smart Tiered Cache summary: Get Smart Tiered Cache setting operationId: smart-tiered-cache-get-smart-tiered-cache-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' responses: 4XX: description: Get Smart Tiered Cache setting response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_response_single' - $ref: '#/components/schemas/cache_api-response-common-failure' "200": description: Get Smart Tiered Cache setting response content: application/json: schema: $ref: '#/components/schemas/cache_response_single' security: - api_email: [] api_key: [] patch: tags: - Smart Tiered Cache summary: Patch Smart Tiered Cache setting description: Updates enablement of Tiered Cache operationId: smart-tiered-cache-patch-smart-tiered-cache-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/cache_schemas-patch' responses: 4XX: description: Patch Smart Tiered Cache setting response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_response_single' - $ref: '#/components/schemas/cache_api-response-common-failure' "200": description: Patch Smart Tiered Cache setting response content: application/json: schema: $ref: '#/components/schemas/cache_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/cache/variants: delete: tags: - Zone Cache Settings summary: Delete variants setting description: 'Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ''Vary: Accept'' response header. If the origin server sends ''Vary: Accept'' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.' operationId: zone-cache-settings-delete-variants-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete variants setting response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - properties: result: $ref: '#/components/schemas/cache_variants' - $ref: '#/components/schemas/cache_api-response-common-failure' "200": description: Delete variants setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - properties: result: $ref: '#/components/schemas/cache_variants' security: - api_email: [] api_key: [] get: tags: - Zone Cache Settings summary: Get variants setting description: 'Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ''Vary: Accept'' response header. If the origin server sends ''Vary: Accept'' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.' operationId: zone-cache-settings-get-variants-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' responses: 4XX: description: Get variants setting response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_variants_response_value' - $ref: '#/components/schemas/cache_api-response-common-failure' "200": description: Get variants setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_variants_response_value' security: - api_email: [] api_key: [] patch: tags: - Zone Cache Settings summary: Change variants setting description: 'Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ''Vary: Accept'' response header. If the origin server sends ''Vary: Accept'' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.' operationId: zone-cache-settings-change-variants-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/cache_variants_value' responses: 4XX: description: Change variants setting response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_variants_response_value' - $ref: '#/components/schemas/cache_api-response-common-failure' "200": description: Change variants setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_variants_response_value' security: - api_email: [] api_key: [] /zones/{zone_id}/certificate_authorities/hostname_associations: get: tags: - API Shield Client Certificates for a Zone summary: List Hostname Associations description: List Hostname Associations operationId: client-certificate-for-a-zone-list-hostname-associations parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: mtls_certificate_id in: query schema: type: string description: The UUID to match against for a certificate that was uploaded to the mTLS Certificate Management endpoint. If no mtls_certificate_id is given, the results will be the hostnames associated to your active Cloudflare Managed CA. example: b2134436-2555-4acf-be5b-26c48136575e minLength: 36 maxLength: 36 responses: 4XX: description: List Hostname Associations Response Failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: List Hostname Associations Response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_associations_response' security: - api_email: [] api_key: [] put: tags: - API Shield Client Certificates for a Zone summary: Replace Hostname Associations description: Replace Hostname Associations operationId: client-certificate-for-a-zone-put-hostname-associations parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_association' responses: 4XX: description: Replace Hostname Associations Response Failure content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Replace Hostname Associations Response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_associations_response' security: - api_email: [] api_key: [] /zones/{zone_id}/client_certificates: get: tags: - API Shield Client Certificates for a Zone summary: List Client Certificates description: List all of your Zone's API Shield mTLS Client Certificates by Status and/or using Pagination operationId: client-certificate-for-a-zone-list-client-certificates parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: status in: query schema: description: Client Certitifcate Status to filter results by. enum: - all - active - pending_reactivation - pending_revocation - revoked example: all - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of records per page. default: 20 minimum: 5 maximum: 50 - name: limit in: query schema: type: integer description: Limit to the number of records returned. example: 10 - name: offset in: query schema: type: integer description: Offset the results example: 10 responses: 4XX: description: List Client Certificates Response Failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: List Client Certificates Response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_collection' security: - api_email: [] api_key: [] post: tags: - API Shield Client Certificates for a Zone summary: Create Client Certificate description: Create a new API Shield mTLS Client Certificate operationId: client-certificate-for-a-zone-create-client-certificate parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object required: - csr - validity_days properties: csr: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-csr' validity_days: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-validity_days' responses: 4XX: description: Create Client Certificate Response Failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Create Client Certificate Response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/client_certificates/{client_certificate_id}: delete: tags: - API Shield Client Certificates for a Zone summary: Revoke Client Certificate description: Set a API Shield mTLS Client Certificate to pending_revocation status for processing to revoked status. operationId: client-certificate-for-a-zone-delete-client-certificate parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: client_certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Revoke Client Certificate Response Failure content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Revoke Client Certificate Response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single' security: - api_email: [] api_key: [] get: tags: - API Shield Client Certificates for a Zone summary: Client Certificate Details description: Get Details for a single mTLS API Shield Client Certificate operationId: client-certificate-for-a-zone-client-certificate-details parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: client_certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Client Certificate Details Response Failure content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Client Certificate Details Response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single' security: - api_email: [] api_key: [] patch: tags: - API Shield Client Certificates for a Zone summary: Reactivate Client Certificate description: If a API Shield mTLS Client Certificate is in a pending_revocation state, you may reactivate it with this endpoint. operationId: client-certificate-for-a-zone-edit-client-certificate parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: client_certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Reactivate Client Certificate Response Failure content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Reactivate Client Certificate Response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/custom_certificates: get: tags: - Custom SSL for a Zone summary: List SSL Configurations description: List, search, and filter all of your custom SSL certificates. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates. operationId: custom-ssl-for-a-zone-list-ssl-configurations parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of zones per page. default: 20 minimum: 5 maximum: 50 - name: match in: query schema: type: string description: Whether to match all search requirements or at least one (any). enum: - any - all default: all - name: status in: query schema: description: Status of the zone's custom SSL. enum: - active - expired - deleted - pending - initializing example: active readOnly: true responses: 4XX: description: List SSL Configurations response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: List SSL Configurations response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_collection' security: - api_email: [] api_key: [] post: tags: - Custom SSL for a Zone summary: Create SSL Configuration description: Upload a new SSL certificate for a zone. operationId: custom-ssl-for-a-zone-create-ssl-configuration parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object required: - certificate - private_key properties: bundle_method: $ref: '#/components/schemas/tls-certificates-and-hostnames_bundle_method' certificate: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate' geo_restrictions: $ref: '#/components/schemas/tls-certificates-and-hostnames_geo_restrictions' policy: $ref: '#/components/schemas/tls-certificates-and-hostnames_policy' private_key: $ref: '#/components/schemas/tls-certificates-and-hostnames_private_key' type: $ref: '#/components/schemas/tls-certificates-and-hostnames_type' responses: 4XX: description: Create SSL Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Create SSL Configuration response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/custom_certificates/{custom_certificate_id}: delete: tags: - Custom SSL for a Zone summary: Delete SSL Configuration description: Remove a SSL certificate from a zone. operationId: custom-ssl-for-a-zone-delete-ssl-configuration parameters: - name: custom_certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete SSL Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_id_only' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Delete SSL Configuration response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_id_only' security: - api_email: [] api_key: [] get: tags: - Custom SSL for a Zone summary: SSL Configuration Details operationId: custom-ssl-for-a-zone-ssl-configuration-details parameters: - name: custom_certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: SSL Configuration Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: SSL Configuration Details response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single' security: - api_email: [] api_key: [] patch: tags: - Custom SSL for a Zone summary: Edit SSL Configuration description: 'Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni_custom certificates will result in a new resource id being returned, and the previous one being deleted.' operationId: custom-ssl-for-a-zone-edit-ssl-configuration parameters: - name: custom_certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object properties: bundle_method: $ref: '#/components/schemas/tls-certificates-and-hostnames_bundle_method' certificate: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate' geo_restrictions: $ref: '#/components/schemas/tls-certificates-and-hostnames_geo_restrictions' policy: $ref: '#/components/schemas/tls-certificates-and-hostnames_policy' private_key: $ref: '#/components/schemas/tls-certificates-and-hostnames_private_key' responses: 4XX: description: Edit SSL Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Edit SSL Configuration response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/custom_certificates/prioritize: put: tags: - Custom SSL for a Zone summary: Re-prioritize SSL Certificates description: If a zone has multiple SSL certificates, you can set the order in which they should be used during a request. The higher priority will break ties across overlapping 'legacy_custom' certificates. operationId: custom-ssl-for-a-zone-re-prioritize-ssl-certificates parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: required: - certificates properties: certificates: type: array description: Array of ordered certificates. example: - id: 5a7805061c76ada191ed06f989cc3dac priority: 2 - id: 9a7806061c88ada191ed06f989cc3dac priority: 1 items: type: object properties: id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' priority: $ref: '#/components/schemas/tls-certificates-and-hostnames_priority' responses: 4XX: description: Re-prioritize SSL Certificates response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Re-prioritize SSL Certificates response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_collection' security: - api_email: [] api_key: [] /zones/{zone_id}/custom_hostnames: get: tags: - Custom Hostname for a Zone summary: List Custom Hostnames description: List, search, sort, and filter all of your custom hostnames. operationId: custom-hostname-for-a-zone-list-custom-hostnames parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: hostname in: query schema: type: string description: Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter. example: app.example.com maxLength: 255 - name: id in: query schema: type: string description: Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter. example: 0d89c70d-ad9f-4843-b99f-6cc0252067e9 minLength: 36 maxLength: 36 - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of hostnames per page. default: 20 minimum: 5 maximum: 50 - name: order in: query schema: description: Field to order hostnames by. enum: - ssl - ssl_status default: ssl example: ssl - name: direction in: query schema: description: Direction to order hostnames. enum: - asc - desc example: desc - name: ssl in: query schema: description: Whether to filter hostnames based on if they have SSL enabled. enum: - 0 - 1 default: "0" responses: 4XX: description: List Custom Hostnames response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: List Custom Hostnames response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_collection' security: - api_email: [] api_key: [] post: tags: - Custom Hostname for a Zone summary: Create Custom Hostname description: Add a new custom hostname and request that an SSL certificate be issued for it. One of three validation methods—http, txt, email—should be used, with 'http' recommended if the CNAME is already in place (or will be soon). Specifying 'email' will send an email to the WHOIS contacts on file for the base domain plus hostmaster, postmaster, webmaster, admin, administrator. If http is used and the domain is not already pointing to the Managed CNAME host, the PATCH method must be used once it is (to complete validation). operationId: custom-hostname-for-a-zone-create-custom-hostname parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object required: - hostname - ssl properties: custom_metadata: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_metadata' hostname: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_post' ssl: $ref: '#/components/schemas/tls-certificates-and-hostnames_sslpost' responses: 4XX: description: Create Custom Hostname response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Create Custom Hostname response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/custom_hostnames/{custom_hostname_id}: delete: tags: - Custom Hostname for a Zone summary: Delete Custom Hostname (and any issued SSL certificates) operationId: custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates) parameters: - name: custom_hostname_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Custom Hostname (and any issued SSL certificates) response failure content: application/json: schema: allOf: - type: object properties: id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Delete Custom Hostname (and any issued SSL certificates) response content: application/json: schema: type: object properties: id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' security: - api_email: [] api_key: [] get: tags: - Custom Hostname for a Zone summary: Custom Hostname Details operationId: custom-hostname-for-a-zone-custom-hostname-details parameters: - name: custom_hostname_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Custom Hostname Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Custom Hostname Details response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' security: - api_email: [] api_key: [] patch: tags: - Custom Hostname for a Zone summary: Edit Custom Hostname description: Modify SSL configuration for a custom hostname. When sent with SSL config that matches existing config, used to indicate that hostname should pass domain control validation (DCV). Can also be used to change validation type, e.g., from 'http' to 'email'. operationId: custom-hostname-for-a-zone-edit-custom-hostname parameters: - name: custom_hostname_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object properties: custom_metadata: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_metadata' custom_origin_server: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_server' custom_origin_sni: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_sni' ssl: $ref: '#/components/schemas/tls-certificates-and-hostnames_sslpost' responses: 4XX: description: Edit Custom Hostname response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Edit Custom Hostname response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/custom_hostnames/fallback_origin: delete: tags: - Custom Hostname Fallback Origin for a Zone summary: Delete Fallback Origin for Custom Hostnames operationId: custom-hostname-fallback-origin-for-a-zone-delete-fallback-origin-for-custom-hostnames parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Fallback Origin for Custom Hostnames response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Delete Fallback Origin for Custom Hostnames response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response' security: - api_email: [] api_key: [] get: tags: - Custom Hostname Fallback Origin for a Zone summary: Get Fallback Origin for Custom Hostnames operationId: custom-hostname-fallback-origin-for-a-zone-get-fallback-origin-for-custom-hostnames parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Get Fallback Origin for Custom Hostnames response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Get Fallback Origin for Custom Hostnames response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response' security: - api_email: [] api_key: [] put: tags: - Custom Hostname Fallback Origin for a Zone summary: Update Fallback Origin for Custom Hostnames operationId: custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object required: - origin properties: origin: $ref: '#/components/schemas/tls-certificates-and-hostnames_origin' responses: 4XX: description: Update Fallback Origin for Custom Hostnames response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Update Fallback Origin for Custom Hostnames response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response' security: - api_email: [] api_key: [] /zones/{zone_id}/custom_ns: get: tags: - Account-Level Custom Nameservers Usage for a Zone summary: Get Account Custom Nameserver Related Zone Metadata description: | Get metadata for account-level custom nameservers on a zone. operationId: account-level-custom-nameservers-usage-for-a-zone-get-account-custom-nameserver-related-zone-metadata parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-custom-nameservers_schemas-identifier' responses: 4XX: description: Get Account Custom Nameserver Related Zone Metadata response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_get_response' - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure' "200": description: Get Account Custom Nameserver Related Zone Metadata response content: application/json: schema: $ref: '#/components/schemas/dns-custom-nameservers_get_response' security: - api_email: [] api_key: [] put: tags: - Account-Level Custom Nameservers Usage for a Zone summary: Set Account Custom Nameserver Related Zone Metadata description: | Set metadata for account-level custom nameservers on a zone. If you would like new zones in the account to use account custom nameservers by default, use PUT /accounts/:identifier to set the account setting use_account_custom_ns_by_default to true. operationId: account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-custom-nameservers_schemas-identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dns-custom-nameservers_zone_metadata' responses: 4XX: description: Set Account Custom Nameserver Related Zone Metadata response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-custom-nameservers_schemas-empty_response' - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure' "200": description: Set Account Custom Nameserver Related Zone Metadata response content: application/json: schema: $ref: '#/components/schemas/dns-custom-nameservers_schemas-empty_response' security: - api_email: [] api_key: [] /zones/{zone_id}/dcv_delegation/uuid: get: tags: - DCV Delegation summary: Retrieve the DCV Delegation unique identifier. description: Retrieve the account and zone specific unique identifier used as part of the CNAME target for DCV Delegation. operationId: dcv-delegation-uuid-get parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Retrieve the DCV Delegation unique identifier response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_dcv_delegation_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Retrieve the DCV Delegation unique identifier response. content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_dcv_delegation_response' security: - api_email: [] api_key: [] /zones/{zone_id}/dns_analytics/report: get: tags: - DNS Analytics summary: Table description: |- Retrieves a list of summarised aggregate metrics over a given time period. See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters. operationId: dns-analytics-table parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-analytics_identifier' - name: metrics in: query schema: $ref: '#/components/schemas/dns-analytics_metrics' - name: dimensions in: query schema: $ref: '#/components/schemas/dns-analytics_dimensions' - name: since in: query schema: $ref: '#/components/schemas/dns-analytics_since' - name: until in: query schema: $ref: '#/components/schemas/dns-analytics_until' - name: limit in: query schema: $ref: '#/components/schemas/dns-analytics_limit' - name: sort in: query schema: $ref: '#/components/schemas/dns-analytics_sort' - name: filters in: query schema: $ref: '#/components/schemas/dns-analytics_filters' responses: 4XX: description: Table response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/dns-analytics_api-response-single' - type: object properties: result: $ref: '#/components/schemas/dns-analytics_report' - $ref: '#/components/schemas/dns-analytics_api-response-common-failure' "200": description: Table response content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-analytics_api-response-single' - type: object properties: result: $ref: '#/components/schemas/dns-analytics_report' security: - api_email: [] api_key: [] /zones/{zone_id}/dns_analytics/report/bytime: get: tags: - DNS Analytics summary: By Time description: |- Retrieves a list of aggregate metrics grouped by time interval. See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters. operationId: dns-analytics-by-time parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-analytics_identifier' - name: metrics in: query schema: $ref: '#/components/schemas/dns-analytics_metrics' - name: dimensions in: query schema: $ref: '#/components/schemas/dns-analytics_dimensions' - name: since in: query schema: $ref: '#/components/schemas/dns-analytics_since' - name: until in: query schema: $ref: '#/components/schemas/dns-analytics_until' - name: limit in: query schema: $ref: '#/components/schemas/dns-analytics_limit' - name: sort in: query schema: $ref: '#/components/schemas/dns-analytics_sort' - name: filters in: query schema: $ref: '#/components/schemas/dns-analytics_filters' - name: time_delta in: query schema: $ref: '#/components/schemas/dns-analytics_time_delta' responses: 4XX: description: By Time response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/dns-analytics_api-response-single' - type: object properties: result: $ref: '#/components/schemas/dns-analytics_report_bytime' - $ref: '#/components/schemas/dns-analytics_api-response-common-failure' "200": description: By Time response content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-analytics_api-response-single' - type: object properties: result: $ref: '#/components/schemas/dns-analytics_report_bytime' security: - api_email: [] api_key: [] /zones/{zone_id}/dns_records: get: tags: - DNS Records for a Zone summary: List DNS Records description: List, search, sort, and filter a zones' DNS records. operationId: dns-records-for-a-zone-list-dns-records parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' - name: name in: query schema: $ref: '#/components/schemas/dns-records_name' - name: type in: query schema: $ref: '#/components/schemas/dns-records_type' - name: content in: query schema: $ref: '#/components/schemas/dns-records_content' - name: proxied in: query schema: $ref: '#/components/schemas/dns-records_proxied' - name: match in: query schema: $ref: '#/components/schemas/dns-records_match' - name: comment in: query schema: type: string description: | Exact value of the DNS record comment. This is a convenience alias for `comment.exact`. example: Hello, world - name: comment.present in: query schema: type: string description: | If this parameter is present, only records *with* a comment are returned. - name: comment.absent in: query schema: type: string description: | If this parameter is present, only records *without* a comment are returned. - name: comment.exact in: query schema: type: string description: | Exact value of the DNS record comment. Comment filters are case-insensitive. example: Hello, world - name: comment.contains in: query schema: type: string description: | Substring of the DNS record comment. Comment filters are case-insensitive. example: ello, worl - name: comment.startswith in: query schema: type: string description: | Prefix of the DNS record comment. Comment filters are case-insensitive. example: Hello, w - name: comment.endswith in: query schema: type: string description: | Suffix of the DNS record comment. Comment filters are case-insensitive. example: o, world - name: tag in: query schema: type: string description: | Condition on the DNS record tag. Parameter values can be of the form `:` to search for an exact `name:value` pair, or just `` to search for records with a specific tag name regardless of its value. This is a convenience shorthand for the more powerful `tag.` parameters. Examples: - `tag=important` is equivalent to `tag.present=important` - `tag=team:DNS` is equivalent to `tag.exact=team:DNS` example: team:DNS - name: tag.present in: query schema: type: string description: | Name of a tag which must be present on the DNS record. Tag filters are case-insensitive. example: important - name: tag.absent in: query schema: type: string description: | Name of a tag which must *not* be present on the DNS record. Tag filters are case-insensitive. example: important - name: tag.exact in: query schema: type: string description: | A tag and value, of the form `:`. The API will only return DNS records that have a tag named `` whose value is ``. Tag filters are case-insensitive. example: greeting:Hello, world - name: tag.contains in: query schema: type: string description: | A tag and value, of the form `:`. The API will only return DNS records that have a tag named `` whose value contains ``. Tag filters are case-insensitive. example: greeting:ello, worl - name: tag.startswith in: query schema: type: string description: | A tag and value, of the form `:`. The API will only return DNS records that have a tag named `` whose value starts with ``. Tag filters are case-insensitive. example: greeting:Hello, w - name: tag.endswith in: query schema: type: string description: | A tag and value, of the form `:`. The API will only return DNS records that have a tag named `` whose value ends with ``. Tag filters are case-insensitive. example: greeting:o, world - name: search in: query schema: $ref: '#/components/schemas/dns-records_search' - name: tag_match in: query schema: $ref: '#/components/schemas/dns-records_tag_match' - name: page in: query schema: $ref: '#/components/schemas/dns-records_page' - name: per_page in: query schema: $ref: '#/components/schemas/dns-records_per_page' - name: order in: query schema: $ref: '#/components/schemas/dns-records_order' - name: direction in: query schema: $ref: '#/components/schemas/dns-records_direction' responses: 4xx: description: List DNS Records response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-records_dns_response_collection' - $ref: '#/components/schemas/dns-records_api-response-common-failure' "200": description: List DNS Records response content: application/json: schema: $ref: '#/components/schemas/dns-records_dns_response_collection' security: - api_email: [] api_key: [] post: tags: - DNS Records for a Zone summary: Create DNS Record description: | Create a new DNS record for a zone. Notes: - A/AAAA records cannot exist on the same name as CNAME records. - NS records cannot exist on the same name as any other record type. - Domain names are always represented in Punycode, even if Unicode characters were used when creating the record. operationId: dns-records-for-a-zone-create-dns-record parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dns-records_dns-record' responses: 4xx: description: Create DNS Record response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-records_dns_response_single' - $ref: '#/components/schemas/dns-records_api-response-common-failure' "200": description: Create DNS Record response content: application/json: schema: $ref: '#/components/schemas/dns-records_dns_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/dns_records/{dns_record_id}: delete: tags: - DNS Records for a Zone summary: Delete DNS Record operationId: dns-records-for-a-zone-delete-dns-record parameters: - name: dns_record_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' requestBody: required: true content: application/json: {} responses: 4xx: description: Delete DNS Record response failure content: application/json: schema: allOf: - type: object properties: result: properties: id: $ref: '#/components/schemas/dns-records_identifier' - $ref: '#/components/schemas/dns-records_api-response-common-failure' "200": description: Delete DNS Record response content: application/json: schema: type: object properties: result: properties: id: $ref: '#/components/schemas/dns-records_identifier' security: - api_email: [] api_key: [] get: tags: - DNS Records for a Zone summary: DNS Record Details operationId: dns-records-for-a-zone-dns-record-details parameters: - name: dns_record_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' responses: 4xx: description: DNS Record Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-records_dns_response_single' - $ref: '#/components/schemas/dns-records_api-response-common-failure' "200": description: DNS Record Details response content: application/json: schema: $ref: '#/components/schemas/dns-records_dns_response_single' security: - api_email: [] api_key: [] patch: tags: - DNS Records for a Zone summary: Update DNS Record description: | Update an existing DNS record. Notes: - A/AAAA records cannot exist on the same name as CNAME records. - NS records cannot exist on the same name as any other record type. - Domain names are always represented in Punycode, even if Unicode characters were used when creating the record. operationId: dns-records-for-a-zone-patch-dns-record parameters: - name: dns_record_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dns-records_dns-record' responses: 4xx: description: Patch DNS Record response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-records_dns_response_single' - $ref: '#/components/schemas/dns-records_api-response-common-failure' "200": description: Patch DNS Record response content: application/json: schema: $ref: '#/components/schemas/dns-records_dns_response_single' security: - api_email: [] api_key: [] put: tags: - DNS Records for a Zone summary: Overwrite DNS Record description: | Overwrite an existing DNS record. Notes: - A/AAAA records cannot exist on the same name as CNAME records. - NS records cannot exist on the same name as any other record type. - Domain names are always represented in Punycode, even if Unicode characters were used when creating the record. operationId: dns-records-for-a-zone-update-dns-record parameters: - name: dns_record_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dns-records_dns-record' responses: 4xx: description: Update DNS Record response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-records_dns_response_single' - $ref: '#/components/schemas/dns-records_api-response-common-failure' "200": description: Update DNS Record response content: application/json: schema: $ref: '#/components/schemas/dns-records_dns_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/dns_records/export: get: tags: - DNS Records for a Zone summary: Export DNS Records description: |- You can export your [BIND config](https://en.wikipedia.org/wiki/Zone_file "Zone file") through this endpoint. See [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ "Import and export records") for more information. operationId: dns-records-for-a-zone-export-dns-records parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' responses: 4XX: description: Export DNS Records response failure content: application/json: schema: $ref: '#/components/schemas/dns-records_api-response-common-failure' "200": description: Export DNS Records response content: text/plain: schema: type: string description: Exported BIND zone file. example: | www.example.com. 300 IN A 127.0.0.1 security: - api_email: [] api_key: [] /zones/{zone_id}/dns_records/import: post: tags: - DNS Records for a Zone summary: Import DNS Records description: |- You can upload your [BIND config](https://en.wikipedia.org/wiki/Zone_file "Zone file") through this endpoint. It assumes that cURL is called from a location with bind_config.txt (valid BIND config) present. See [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ "Import and export records") for more information. operationId: dns-records-for-a-zone-import-dns-records parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' requestBody: required: true content: multipart/form-data: schema: type: object required: - file properties: file: type: string description: | BIND config to import. **Tip:** When using cURL, a file can be uploaded using `--form 'file=@bind_config.txt'`. example: www.example.com. 300 IN A 127.0.0.1 proxied: type: string description: |- Whether or not proxiable records should receive the performance and security benefits of Cloudflare. The value should be either `true` or `false`. default: "false" example: "true" responses: 4XX: description: Import DNS Records response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-records_dns_response_import_scan' - $ref: '#/components/schemas/dns-records_api-response-common-failure' "200": description: Import DNS Records response content: application/json: schema: $ref: '#/components/schemas/dns-records_dns_response_import_scan' security: - api_email: [] api_key: [] /zones/{zone_id}/dns_records/scan: post: tags: - DNS Records for a Zone summary: Scan DNS Records description: Scan for common DNS records on your domain and automatically add them to your zone. Useful if you haven't updated your nameservers yet. operationId: dns-records-for-a-zone-scan-dns-records parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-records_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Scan DNS Records response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-records_dns_response_import_scan' - $ref: '#/components/schemas/dns-records_api-response-common-failure' "200": description: Scan DNS Records response content: application/json: schema: $ref: '#/components/schemas/dns-records_dns_response_import_scan' security: - api_email: [] api_key: [] /zones/{zone_id}/dns_settings: get: tags: - DNS Settings for a Zone summary: Show DNS Settings description: Show DNS settings for a zone operationId: dns-settings-for-a-zone-list-dns-settings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-settings_identifier' responses: 4XX: description: Show DNS Settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-settings_dns_response_single' - $ref: '#/components/schemas/dns-settings_api-response-common-failure' "200": description: Show DNS Settings response content: application/json: schema: $ref: '#/components/schemas/dns-settings_dns_response_single' security: - api_email: [] api_key: [] patch: tags: - DNS Settings for a Zone summary: Update DNS Settings description: Update DNS settings for a zone operationId: dns-settings-for-a-zone-update-dns-settings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dns-settings_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dns-settings_dns-settings' responses: 4XX: description: Show DNS Settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dns-settings_dns_response_single' - $ref: '#/components/schemas/dns-settings_api-response-common-failure' "200": description: Show DNS Settings response content: application/json: schema: $ref: '#/components/schemas/dns-settings_dns_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/dnssec: delete: tags: - DNSSEC summary: Delete DNSSEC records description: Delete DNSSEC. operationId: dnssec-delete-dnssec-records parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dnssec_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete DNSSEC records response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dnssec_delete_dnssec_response_single' - $ref: '#/components/schemas/dnssec_api-response-common-failure' "200": description: Delete DNSSEC records response content: application/json: schema: $ref: '#/components/schemas/dnssec_delete_dnssec_response_single' security: - api_email: [] api_key: [] get: tags: - DNSSEC summary: DNSSEC Details description: Details about DNSSEC status and configuration. operationId: dnssec-dnssec-details parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dnssec_identifier' responses: 4XX: description: DNSSEC Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dnssec_dnssec_response_single' - $ref: '#/components/schemas/dnssec_api-response-common-failure' "200": description: DNSSEC Details response content: application/json: schema: $ref: '#/components/schemas/dnssec_dnssec_response_single' security: - api_email: [] api_key: [] patch: tags: - DNSSEC summary: Edit DNSSEC Status description: Enable or disable DNSSEC. operationId: dnssec-edit-dnssec-status parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/dnssec_identifier' requestBody: required: true content: application/json: schema: properties: dnssec_multi_signer: $ref: '#/components/schemas/dnssec_dnssec_multi_signer' dnssec_presigned: $ref: '#/components/schemas/dnssec_dnssec_presigned' status: description: Status of DNSSEC, based on user-desired state and presence of necessary records. enum: - active - disabled example: active responses: 4XX: description: Edit DNSSEC Status response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dnssec_dnssec_response_single' - $ref: '#/components/schemas/dnssec_api-response-common-failure' "200": description: Edit DNSSEC Status response content: application/json: schema: $ref: '#/components/schemas/dnssec_dnssec_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/firewall/access_rules/rules: get: tags: - IP Access rules for a zone summary: List IP Access rules description: Fetches IP Access rules of a zone. You can filter the results using several optional parameters. operationId: ip-access-rules-for-a-zone-list-ip-access-rules parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: filters in: query schema: $ref: '#/components/schemas/firewall_filters' - name: egs-pagination.json in: query schema: $ref: '#/components/schemas/firewall_egs-pagination' - name: page in: query schema: type: number description: Requested page within paginated list of results. example: 1 - name: per_page in: query schema: type: number description: Maximum number of results requested. example: 20 - name: order in: query schema: type: string description: The field used to sort returned rules. enum: - configuration.target - configuration.value - mode example: mode - name: direction in: query schema: type: string description: The direction used to sort returned rules. enum: - asc - desc example: desc responses: 4XX: description: List IP Access rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_rule_collection_response' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List IP Access rules response content: application/json: schema: $ref: '#/components/schemas/firewall_rule_collection_response' security: - api_email: [] api_key: [] post: tags: - IP Access rules for a zone summary: Create an IP Access rule description: |- Creates a new IP Access rule for a zone. Note: To create an IP Access rule that applies to multiple zones, refer to [IP Access rules for a user](#ip-access-rules-for-a-user) or [IP Access rules for an account](#ip-access-rules-for-an-account) as appropriate. operationId: ip-access-rules-for-a-zone-create-an-ip-access-rule parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - mode - configuration - notes properties: configuration: $ref: '#/components/schemas/firewall_configuration' mode: $ref: '#/components/schemas/firewall_schemas-mode' notes: $ref: '#/components/schemas/firewall_notes' responses: 4XX: description: Create an IP Access rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_rule_single_response' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Create an IP Access rule response content: application/json: schema: $ref: '#/components/schemas/firewall_rule_single_response' security: - api_email: [] api_key: [] /zones/{zone_id}/firewall/access_rules/rules/{identifier}: delete: tags: - IP Access rules for a zone summary: Delete an IP Access rule description: |- Deletes an IP Access rule defined at the zone level. Optionally, you can use the `cascade` property to specify that you wish to delete similar rules in other zones managed by the same zone owner. operationId: ip-access-rules-for-a-zone-delete-an-ip-access-rule parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: properties: cascade: type: string description: The level to attempt to delete similar rules defined for other zones with the same owner. The default value is `none`, which will only delete the current rule. Using `basic` will delete rules that match the same action (mode) and configuration, while using `aggressive` will delete rules that match the same configuration. enum: - none - basic - aggressive default: none responses: 4XX: description: Delete an IP Access rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_rule_single_id_response' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Delete an IP Access rule response content: application/json: schema: $ref: '#/components/schemas/firewall_rule_single_id_response' security: - api_email: [] api_key: [] patch: tags: - IP Access rules for a zone summary: Update an IP Access rule description: Updates an IP Access rule defined at the zone level. You can only update the rule action (`mode` parameter) and notes. operationId: ip-access-rules-for-a-zone-update-an-ip-access-rule parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: properties: mode: $ref: '#/components/schemas/firewall_schemas-mode' notes: $ref: '#/components/schemas/firewall_notes' responses: 4XX: description: Update an IP Access rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_rule_single_response' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update an IP Access rule response content: application/json: schema: $ref: '#/components/schemas/firewall_rule_single_response' security: - api_email: [] api_key: [] /zones/{zone_id}/firewall/waf/packages/{package_id}/groups: get: tags: - WAF rule groups summary: List WAF rule groups description: |- Fetches the WAF rule groups in a WAF package. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-rule-groups-list-waf-rule-groups parameters: - name: package_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_schemas-identifier' - name: mode in: query schema: $ref: '#/components/schemas/waf-managed-rules_mode' - name: page in: query schema: type: number description: The page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: The number of rule groups per page. default: 50 minimum: 5 maximum: 100 - name: order in: query schema: description: The field used to sort returned rule groups. enum: - mode - rules_count example: mode - name: direction in: query schema: description: The direction used to sort returned rule groups. enum: - asc - desc example: desc - name: match in: query schema: description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match. enum: - any - all default: all - name: name in: query schema: type: string description: The name of the rule group. example: Project Honey Pot readOnly: true - name: rules_count in: query schema: type: number description: The number of rules in the current rule group. default: 0 example: 10 readOnly: true responses: 4XX: description: List WAF rule groups response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waf-managed-rules_rule_group_response_collection' - $ref: '#/components/schemas/waf-managed-rules_api-response-common-failure' "200": description: List WAF rule groups response content: application/json: schema: $ref: '#/components/schemas/waf-managed-rules_rule_group_response_collection' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}: get: tags: - WAF rule groups summary: Get a WAF rule group description: |- Fetches the details of a WAF rule group. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-rule-groups-get-a-waf-rule-group parameters: - name: group_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_identifier' - name: package_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_schemas-identifier' responses: 4XX: description: Get a WAF rule group response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waf-managed-rules_rule_group_response_single' - $ref: '#/components/schemas/waf-managed-rules_api-response-common-failure' "200": description: Get a WAF rule group response content: application/json: schema: $ref: '#/components/schemas/waf-managed-rules_rule_group_response_single' security: - api_email: [] api_key: [] api_token: [] patch: tags: - WAF rule groups summary: Update a WAF rule group description: |- Updates a WAF rule group. You can update the state (`mode` parameter) of a rule group. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-rule-groups-update-a-waf-rule-group parameters: - name: group_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_identifier' - name: package_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_schemas-identifier' requestBody: required: true content: application/json: schema: properties: mode: $ref: '#/components/schemas/waf-managed-rules_mode' responses: 4XX: description: Update a WAF rule group response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waf-managed-rules_rule_group_response_single' - $ref: '#/components/schemas/waf-managed-rules_api-response-common-failure' "200": description: Update a WAF rule group response content: application/json: schema: $ref: '#/components/schemas/waf-managed-rules_rule_group_response_single' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/firewall/waf/packages/{package_id}/rules: get: tags: - WAF rules summary: List WAF rules description: |- Fetches WAF rules in a WAF package. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-rules-list-waf-rules parameters: - name: package_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_schemas-identifier' - name: mode in: query schema: type: string description: The action/mode a rule has been overridden to perform. enum: - DIS - CHL - BLK - SIM example: CHL - name: group_id in: query schema: $ref: '#/components/schemas/waf-managed-rules_components-schemas-identifier' - name: page in: query schema: type: number description: The page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: The number of rules per page. default: 50 minimum: 5 maximum: 100 - name: order in: query schema: type: string description: The field used to sort returned rules. enum: - priority - group_id - description example: status - name: direction in: query schema: type: string description: The direction used to sort returned rules. enum: - asc - desc example: desc - name: match in: query schema: type: string description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match. enum: - any - all default: all - name: description in: query schema: type: string description: The public description of the WAF rule. example: SQL injection prevention for SELECT statements readOnly: true - name: priority in: query schema: type: string description: The order in which the individual WAF rule is executed within its rule group. readOnly: true responses: 4XX: description: List WAF rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waf-managed-rules_rule_response_collection' - $ref: '#/components/schemas/waf-managed-rules_api-response-common-failure' "200": description: List WAF rules response content: application/json: schema: $ref: '#/components/schemas/waf-managed-rules_rule_response_collection' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id}: get: tags: - WAF rules summary: Get a WAF rule description: |- Fetches the details of a WAF rule in a WAF package. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-rules-get-a-waf-rule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_identifier' - name: package_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_schemas-identifier' responses: 4XX: description: Get a WAF rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waf-managed-rules_rule_response_single' - $ref: '#/components/schemas/waf-managed-rules_api-response-common-failure' "200": description: Get a WAF rule response content: application/json: schema: $ref: '#/components/schemas/waf-managed-rules_rule_response_single' security: - api_email: [] api_key: [] api_token: [] patch: tags: - WAF rules summary: Update a WAF rule description: |- Updates a WAF rule. You can only update the mode/action of the rule. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-rules-update-a-waf-rule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_identifier' - name: package_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waf-managed-rules_schemas-identifier' requestBody: required: true content: application/json: schema: properties: mode: description: The mode/action of the rule when triggered. You must use a value from the `allowed_modes` array of the current rule. enum: - default - disable - simulate - block - challenge - "on" - "off" example: "on" responses: 4XX: description: Update a WAF rule response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/waf-managed-rules_rule_response_single' - properties: result: oneOf: - $ref: '#/components/schemas/waf-managed-rules_anomaly_rule' - $ref: '#/components/schemas/waf-managed-rules_traditional_deny_rule' - $ref: '#/components/schemas/waf-managed-rules_traditional_allow_rule' - $ref: '#/components/schemas/waf-managed-rules_api-response-common-failure' "200": description: Update a WAF rule response content: application/json: schema: allOf: - $ref: '#/components/schemas/waf-managed-rules_rule_response_single' - properties: result: oneOf: - $ref: '#/components/schemas/waf-managed-rules_anomaly_rule' - $ref: '#/components/schemas/waf-managed-rules_traditional_deny_rule' - $ref: '#/components/schemas/waf-managed-rules_traditional_allow_rule' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/healthchecks: get: tags: - Health Checks summary: List Health Checks description: List configured health checks. operationId: health-checks-list-health-checks parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' - $ref: '#/components/parameters/healthchecks_page' - $ref: '#/components/parameters/healthchecks_per_page' responses: 4XX: description: List Health Checks response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/healthchecks_response_collection' - $ref: '#/components/schemas/healthchecks_api-response-common-failure' "200": description: List Health Checks response content: application/json: schema: $ref: '#/components/schemas/healthchecks_response_collection' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Health Checks summary: Create Health Check description: Create a new health check. operationId: health-checks-create-health-check parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/healthchecks_query_healthcheck' responses: 4XX: description: Create Health Check response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/healthchecks_single_response' - $ref: '#/components/schemas/healthchecks_api-response-common-failure' "200": description: Create Health Check response content: application/json: schema: $ref: '#/components/schemas/healthchecks_single_response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/healthchecks/{healthcheck_id}: delete: tags: - Health Checks summary: Delete Health Check description: Delete a health check. operationId: health-checks-delete-health-check parameters: - name: healthcheck_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Health Check response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/healthchecks_id_response' - $ref: '#/components/schemas/healthchecks_api-response-common-failure' "200": description: Delete Health Check response content: application/json: schema: $ref: '#/components/schemas/healthchecks_id_response' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Health Checks summary: Health Check Details description: Fetch a single configured health check. operationId: health-checks-health-check-details parameters: - name: healthcheck_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' responses: 4XX: description: Health Check Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/healthchecks_single_response' - $ref: '#/components/schemas/healthchecks_api-response-common-failure' "200": description: Health Check Details response content: application/json: schema: $ref: '#/components/schemas/healthchecks_single_response' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Health Checks summary: Patch Health Check description: Patch a configured health check. operationId: health-checks-patch-health-check parameters: - name: healthcheck_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/healthchecks_query_healthcheck' responses: 4XX: description: Patch Health Check response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/healthchecks_single_response' - $ref: '#/components/schemas/healthchecks_api-response-common-failure' "200": description: Patch Health Check response content: application/json: schema: $ref: '#/components/schemas/healthchecks_single_response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Health Checks summary: Update Health Check description: Update a configured health check. operationId: health-checks-update-health-check parameters: - name: healthcheck_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/healthchecks_query_healthcheck' responses: 4XX: description: Update Health Check response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/healthchecks_single_response' - $ref: '#/components/schemas/healthchecks_api-response-common-failure' "200": description: Update Health Check response content: application/json: schema: $ref: '#/components/schemas/healthchecks_single_response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/healthchecks/preview: post: tags: - Health Checks summary: Create Preview Health Check description: Create a new preview health check. operationId: health-checks-create-preview-health-check parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/healthchecks_query_healthcheck' responses: 4XX: description: Create Preview Health Check response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/healthchecks_single_response' - $ref: '#/components/schemas/healthchecks_api-response-common-failure' "200": description: Create Preview Health Check response content: application/json: schema: $ref: '#/components/schemas/healthchecks_single_response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/healthchecks/preview/{healthcheck_id}: delete: tags: - Health Checks summary: Delete Preview Health Check description: Delete a health check. operationId: health-checks-delete-preview-health-check parameters: - name: healthcheck_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Preview Health Check response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/healthchecks_id_response' - $ref: '#/components/schemas/healthchecks_api-response-common-failure' "200": description: Delete Preview Health Check response content: application/json: schema: $ref: '#/components/schemas/healthchecks_id_response' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Health Checks summary: Health Check Preview Details description: Fetch a single configured health check preview. operationId: health-checks-health-check-preview-details parameters: - name: healthcheck_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/healthchecks_identifier' responses: 4XX: description: Health Check Preview Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/healthchecks_single_response' - $ref: '#/components/schemas/healthchecks_api-response-common-failure' "200": description: Health Check Preview Details response content: application/json: schema: $ref: '#/components/schemas/healthchecks_single_response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/hold: delete: tags: - Zone Holds summary: Remove Zone Hold description: |- Stop enforcement of a zone hold on the zone, permanently or temporarily, allowing the creation and activation of zones with this zone's hostname. operationId: zones-0-hold-delete parameters: - name: zone_id in: path description: Zone ID required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' - name: hold_after in: query description: |- If `hold_after` is provided, the hold will be temporarily disabled, then automatically re-enabled by the system at the time specified in this RFC3339-formatted timestamp. Otherwise, the hold will be disabled indefinitely. schema: type: string example: "2023-01-31T15:56:36+00:00" responses: 4XX: description: Client Error content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_schemas-api-response-common-failure' "200": description: Successful Response content: application/json: schema: allOf: - type: object properties: result: type: object properties: hold: type: boolean example: false hold_after: type: string include_subdomains: type: string example: false security: - api_token: [] - api_email: [] api_key: [] get: tags: - Zone Holds summary: Get Zone Hold description: Retrieve whether the zone is subject to a zone hold, and metadata about the hold. operationId: zones-0-hold-get parameters: - name: zone_id in: path description: Zone ID required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' responses: 4XX: description: Client Error content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_schemas-api-response-common-failure' "200": description: Successful Response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_api-response-single' - type: object properties: result: type: object properties: hold: type: boolean example: true hold_after: type: string example: "2023-01-31T15:56:36+00:00" include_subdomains: type: string example: false security: - api_token: [] - api_email: [] api_key: [] post: tags: - Zone Holds summary: Create Zone Hold description: Enforce a zone hold on the zone, blocking the creation and activation of zones with this zone's hostname. operationId: zones-0-hold-post parameters: - name: zone_id in: path description: Zone ID required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' - name: include_subdomains in: query description: |- If provided, the zone hold will extend to block any subdomain of the given zone, as well as SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with the hostname 'example.com' and include_subdomains=true will block 'example.com', 'staging.example.com', 'api.staging.example.com', etc. schema: type: boolean example: true responses: 4XX: description: Client Error content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_schemas-api-response-common-failure' "200": description: Successful Response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_api-response-single' - type: object properties: result: type: object properties: hold: type: boolean example: true hold_after: type: string example: "2023-01-31T15:56:36+00:00" include_subdomains: type: string example: true security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/hostnames/settings/{setting_id}: get: tags: - Per-Hostname TLS Settings summary: List TLS setting for hostnames description: List the requested TLS setting for the hostnames under this zone. operationId: per-hostname-tls-settings-list parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: setting_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_setting_id' responses: 4XX: description: List per-hostname TLS settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: List per-hostname TLS settings response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response_collection' security: - api_email: [] api_key: [] /zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}: delete: tags: - Per-Hostname TLS Settings summary: Delete TLS setting for hostname description: Delete the tls setting value for the hostname. operationId: per-hostname-tls-settings-delete parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: setting_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_setting_id' - name: hostname in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname' responses: 4XX: description: Delete TLS setting for hostname response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response_delete' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Delete TLS setting for hostname response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response_delete' security: - api_email: [] api_key: [] put: tags: - Per-Hostname TLS Settings summary: Edit TLS setting for hostname description: Update the tls setting value for the hostname. operationId: per-hostname-tls-settings-put parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: setting_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_setting_id' - name: hostname in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname' requestBody: required: true content: application/json: schema: type: object required: - value properties: value: $ref: '#/components/schemas/tls-certificates-and-hostnames_value' responses: 4XX: description: Edit TLS setting for hostname response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Edit TLS setting for hostname response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response' security: - api_email: [] api_key: [] /zones/{zone_id}/keyless_certificates: get: tags: - Keyless SSL for a Zone summary: List Keyless SSL Configurations description: List all Keyless SSL configurations for a given zone. operationId: keyless-ssl-for-a-zone-list-keyless-ssl-configurations parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: List Keyless SSL Configurations response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: List Keyless SSL Configurations response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_collection' security: - api_email: [] api_key: [] post: tags: - Keyless SSL for a Zone summary: Create Keyless SSL Configuration operationId: keyless-ssl-for-a-zone-create-keyless-ssl-configuration parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object required: - host - port - certificate properties: bundle_method: $ref: '#/components/schemas/tls-certificates-and-hostnames_bundle_method' certificate: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate' host: $ref: '#/components/schemas/tls-certificates-and-hostnames_host' name: $ref: '#/components/schemas/tls-certificates-and-hostnames_name_write' port: $ref: '#/components/schemas/tls-certificates-and-hostnames_port' tunnel: $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_tunnel' responses: 4XX: description: Create Keyless SSL Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Create Keyless SSL Configuration response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/keyless_certificates/{keyless_certificate_id}: delete: tags: - Keyless SSL for a Zone summary: Delete Keyless SSL Configuration operationId: keyless-ssl-for-a-zone-delete-keyless-ssl-configuration parameters: - name: keyless_certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Keyless SSL Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single_id' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Delete Keyless SSL Configuration response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single_id' security: - api_email: [] api_key: [] get: tags: - Keyless SSL for a Zone summary: Get Keyless SSL Configuration description: Get details for one Keyless SSL configuration. operationId: keyless-ssl-for-a-zone-get-keyless-ssl-configuration parameters: - name: keyless_certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Get Keyless SSL Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Get Keyless SSL Configuration response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single' security: - api_email: [] api_key: [] patch: tags: - Keyless SSL for a Zone summary: Edit Keyless SSL Configuration description: 'This will update attributes of a Keyless SSL. Consists of one or more of the following: host,name,port.' operationId: keyless-ssl-for-a-zone-edit-keyless-ssl-configuration parameters: - name: keyless_certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object properties: enabled: $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled_write' host: $ref: '#/components/schemas/tls-certificates-and-hostnames_host' name: $ref: '#/components/schemas/tls-certificates-and-hostnames_name_write' port: $ref: '#/components/schemas/tls-certificates-and-hostnames_port' tunnel: $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_tunnel' responses: 4XX: description: Edit Keyless SSL Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Edit Keyless SSL Configuration response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/load_balancers: get: tags: - Load Balancers summary: List Load Balancers description: List configured load balancers. operationId: load-balancers-list-load-balancers parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier' responses: 4XX: description: List Load Balancers response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-response_collection' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: List Load Balancers response content: application/json: schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-response_collection' security: - api_email: [] api_key: [] api_token: [] post: tags: - Load Balancers summary: Create Load Balancer description: Create a new load balancer. operationId: load-balancers-create-load-balancer parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier' requestBody: required: true content: application/json: schema: required: - name - default_pools - fallback_pool properties: adaptive_routing: $ref: '#/components/schemas/load-balancing_adaptive_routing' country_pools: $ref: '#/components/schemas/load-balancing_country_pools' default_pools: $ref: '#/components/schemas/load-balancing_default_pools' description: $ref: '#/components/schemas/load-balancing_components-schemas-description' fallback_pool: $ref: '#/components/schemas/load-balancing_fallback_pool' location_strategy: $ref: '#/components/schemas/load-balancing_location_strategy' name: $ref: '#/components/schemas/load-balancing_components-schemas-name' pop_pools: $ref: '#/components/schemas/load-balancing_pop_pools' proxied: $ref: '#/components/schemas/load-balancing_proxied' random_steering: $ref: '#/components/schemas/load-balancing_random_steering' region_pools: $ref: '#/components/schemas/load-balancing_region_pools' rules: $ref: '#/components/schemas/load-balancing_rules' session_affinity: $ref: '#/components/schemas/load-balancing_session_affinity' session_affinity_attributes: $ref: '#/components/schemas/load-balancing_session_affinity_attributes' session_affinity_ttl: $ref: '#/components/schemas/load-balancing_session_affinity_ttl' steering_policy: $ref: '#/components/schemas/load-balancing_steering_policy' ttl: $ref: '#/components/schemas/load-balancing_ttl' responses: 4XX: description: Create Load Balancer response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Create Load Balancer response content: application/json: schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/load_balancers/{load_balancer_id}: delete: tags: - Load Balancers summary: Delete Load Balancer description: Delete a configured load balancer. operationId: load-balancers-delete-load-balancer parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier' - name: load_balancer_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Load Balancer response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_components-schemas-id_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Delete Load Balancer response content: application/json: schema: $ref: '#/components/schemas/load-balancing_components-schemas-id_response' security: - api_email: [] api_key: [] api_token: [] get: tags: - Load Balancers summary: Load Balancer Details description: Fetch a single configured load balancer. operationId: load-balancers-load-balancer-details parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier' - name: load_balancer_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier' responses: 4XX: description: Load Balancer Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Load Balancer Details response content: application/json: schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response' security: - api_email: [] api_key: [] api_token: [] patch: tags: - Load Balancers summary: Patch Load Balancer description: Apply changes to an existing load balancer, overwriting the supplied properties. operationId: load-balancers-patch-load-balancer parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier' - name: load_balancer_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier' requestBody: required: true content: application/json: schema: properties: adaptive_routing: $ref: '#/components/schemas/load-balancing_adaptive_routing' country_pools: $ref: '#/components/schemas/load-balancing_country_pools' default_pools: $ref: '#/components/schemas/load-balancing_default_pools' description: $ref: '#/components/schemas/load-balancing_components-schemas-description' enabled: $ref: '#/components/schemas/load-balancing_components-schemas-enabled' fallback_pool: $ref: '#/components/schemas/load-balancing_fallback_pool' location_strategy: $ref: '#/components/schemas/load-balancing_location_strategy' name: $ref: '#/components/schemas/load-balancing_components-schemas-name' pop_pools: $ref: '#/components/schemas/load-balancing_pop_pools' proxied: $ref: '#/components/schemas/load-balancing_proxied' random_steering: $ref: '#/components/schemas/load-balancing_random_steering' region_pools: $ref: '#/components/schemas/load-balancing_region_pools' rules: $ref: '#/components/schemas/load-balancing_rules' session_affinity: $ref: '#/components/schemas/load-balancing_session_affinity' session_affinity_attributes: $ref: '#/components/schemas/load-balancing_session_affinity_attributes' session_affinity_ttl: $ref: '#/components/schemas/load-balancing_session_affinity_ttl' steering_policy: $ref: '#/components/schemas/load-balancing_steering_policy' ttl: $ref: '#/components/schemas/load-balancing_ttl' responses: 4XX: description: Patch Load Balancer response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Patch Load Balancer response content: application/json: schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response' security: - api_email: [] api_key: [] api_token: [] put: tags: - Load Balancers summary: Update Load Balancer description: Update a configured load balancer. operationId: load-balancers-update-load-balancer parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier' - name: load_balancer_id in: path required: true schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier' requestBody: required: true content: application/json: schema: required: - name - default_pools - fallback_pool properties: adaptive_routing: $ref: '#/components/schemas/load-balancing_adaptive_routing' country_pools: $ref: '#/components/schemas/load-balancing_country_pools' default_pools: $ref: '#/components/schemas/load-balancing_default_pools' description: $ref: '#/components/schemas/load-balancing_components-schemas-description' enabled: $ref: '#/components/schemas/load-balancing_components-schemas-enabled' fallback_pool: $ref: '#/components/schemas/load-balancing_fallback_pool' location_strategy: $ref: '#/components/schemas/load-balancing_location_strategy' name: $ref: '#/components/schemas/load-balancing_components-schemas-name' pop_pools: $ref: '#/components/schemas/load-balancing_pop_pools' proxied: $ref: '#/components/schemas/load-balancing_proxied' random_steering: $ref: '#/components/schemas/load-balancing_random_steering' region_pools: $ref: '#/components/schemas/load-balancing_region_pools' rules: $ref: '#/components/schemas/load-balancing_rules' session_affinity: $ref: '#/components/schemas/load-balancing_session_affinity' session_affinity_attributes: $ref: '#/components/schemas/load-balancing_session_affinity_attributes' session_affinity_ttl: $ref: '#/components/schemas/load-balancing_session_affinity_ttl' steering_policy: $ref: '#/components/schemas/load-balancing_steering_policy' ttl: $ref: '#/components/schemas/load-balancing_ttl' responses: 4XX: description: Update Load Balancer response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response' - $ref: '#/components/schemas/load-balancing_api-response-common-failure' "200": description: Update Load Balancer response content: application/json: schema: $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_id}/logpush/datasets/{dataset_id}/fields: get: tags: - Logpush jobs for a zone summary: List fields description: Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions. operationId: get-zones-zone_identifier-logpush-datasets-dataset-fields parameters: - name: dataset_id in: path required: true schema: $ref: '#/components/schemas/logpush_dataset' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' responses: 4XX: description: List fields response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_logpush_field_response_collection' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: List fields response content: application/json: schema: $ref: '#/components/schemas/logpush_logpush_field_response_collection' security: - api_email: [] api_key: [] /zones/{zone_id}/logpush/datasets/{dataset_id}/jobs: get: tags: - Logpush jobs for a zone summary: List Logpush jobs for a dataset description: Lists Logpush jobs for a zone for a dataset. operationId: get-zones-zone_identifier-logpush-datasets-dataset-jobs parameters: - name: dataset_id in: path required: true schema: $ref: '#/components/schemas/logpush_dataset' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' responses: 4XX: description: List Logpush jobs for a dataset response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_logpush_job_response_collection' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: List Logpush jobs for a dataset response content: application/json: schema: $ref: '#/components/schemas/logpush_logpush_job_response_collection' security: - api_email: [] api_key: [] /zones/{zone_id}/logpush/edge: get: tags: - Instant Logs jobs for a zone summary: List Instant Logs jobs description: Lists Instant Logs jobs for a zone. operationId: get-zones-zone_identifier-logpush-edge-jobs parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' responses: 4XX: description: List Instant Logs jobs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_instant_logs_job_response_collection' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: List Instant Logs jobs response content: application/json: schema: $ref: '#/components/schemas/logpush_instant_logs_job_response_collection' security: - api_email: [] api_key: [] post: tags: - Instant Logs jobs for a zone summary: Create Instant Logs job description: Creates a new Instant Logs job for a zone. operationId: post-zones-zone_identifier-logpush-edge-jobs parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: properties: fields: $ref: '#/components/schemas/logpush_fields' filter: $ref: '#/components/schemas/logpush_filter' sample: $ref: '#/components/schemas/logpush_sample' responses: 4XX: description: Create Instant Logs job response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_instant_logs_job_response_single' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Create Instant Logs job response content: application/json: schema: $ref: '#/components/schemas/logpush_instant_logs_job_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/logpush/jobs: get: tags: - Logpush jobs for a zone summary: List Logpush jobs description: Lists Logpush jobs for a zone. operationId: get-zones-zone_identifier-logpush-jobs parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' responses: 4XX: description: List Logpush jobs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_logpush_job_response_collection' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: List Logpush jobs response content: application/json: schema: $ref: '#/components/schemas/logpush_logpush_job_response_collection' security: - api_email: [] api_key: [] post: tags: - Logpush jobs for a zone summary: Create Logpush job description: Creates a new Logpush job for a zone. operationId: post-zones-zone_identifier-logpush-jobs parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: required: - destination_conf properties: dataset: $ref: '#/components/schemas/logpush_dataset' destination_conf: $ref: '#/components/schemas/logpush_destination_conf' enabled: $ref: '#/components/schemas/logpush_enabled' frequency: $ref: '#/components/schemas/logpush_frequency' logpull_options: $ref: '#/components/schemas/logpush_logpull_options' name: $ref: '#/components/schemas/logpush_name' output_options: $ref: '#/components/schemas/logpush_output_options' ownership_challenge: $ref: '#/components/schemas/logpush_ownership_challenge' responses: 4XX: description: Create Logpush job response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_logpush_job_response_single' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Create Logpush job response content: application/json: schema: $ref: '#/components/schemas/logpush_logpush_job_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/logpush/jobs/{job_id}: delete: tags: - Logpush jobs for a zone summary: Delete Logpush job description: Deletes a Logpush job. operationId: delete-zones-zone_identifier-logpush-jobs-job_identifier parameters: - name: job_id in: path required: true schema: $ref: '#/components/schemas/logpush_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Logpush job response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/logpush_api-response-common' - properties: result: type: object example: {} nullable: true - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Delete Logpush job response content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_api-response-common' - properties: result: type: object example: {} nullable: true security: - api_email: [] api_key: [] get: tags: - Logpush jobs for a zone summary: Get Logpush job details description: Gets the details of a Logpush job. operationId: get-zones-zone_identifier-logpush-jobs-job_identifier parameters: - name: job_id in: path required: true schema: $ref: '#/components/schemas/logpush_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' responses: 4XX: description: Get Logpush job details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_logpush_job_response_single' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Get Logpush job details response content: application/json: schema: $ref: '#/components/schemas/logpush_logpush_job_response_single' security: - api_email: [] api_key: [] put: tags: - Logpush jobs for a zone summary: Update Logpush job description: Updates a Logpush job. operationId: put-zones-zone_identifier-logpush-jobs-job_identifier parameters: - name: job_id in: path required: true schema: $ref: '#/components/schemas/logpush_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: properties: destination_conf: $ref: '#/components/schemas/logpush_destination_conf' enabled: $ref: '#/components/schemas/logpush_enabled' frequency: $ref: '#/components/schemas/logpush_frequency' logpull_options: $ref: '#/components/schemas/logpush_logpull_options' output_options: $ref: '#/components/schemas/logpush_output_options' ownership_challenge: $ref: '#/components/schemas/logpush_ownership_challenge' responses: 4XX: description: Update Logpush job response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_logpush_job_response_single' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Update Logpush job response content: application/json: schema: $ref: '#/components/schemas/logpush_logpush_job_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/logpush/ownership: post: tags: - Logpush jobs for a zone summary: Get ownership challenge description: Gets a new ownership challenge sent to your destination. operationId: post-zones-zone_identifier-logpush-ownership parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: required: - destination_conf properties: destination_conf: $ref: '#/components/schemas/logpush_destination_conf' responses: 4XX: description: Get ownership challenge response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_get_ownership_response' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Get ownership challenge response content: application/json: schema: $ref: '#/components/schemas/logpush_get_ownership_response' security: - api_email: [] api_key: [] /zones/{zone_id}/logpush/ownership/validate: post: tags: - Logpush jobs for a zone summary: Validate ownership challenge description: Validates ownership challenge of the destination. operationId: post-zones-zone_identifier-logpush-ownership-validate parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: required: - destination_conf - ownership_challenge properties: destination_conf: $ref: '#/components/schemas/logpush_destination_conf' ownership_challenge: $ref: '#/components/schemas/logpush_ownership_challenge' responses: 4XX: description: Validate ownership challenge response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_validate_ownership_response' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Validate ownership challenge response content: application/json: schema: $ref: '#/components/schemas/logpush_validate_ownership_response' security: - api_email: [] api_key: [] /zones/{zone_id}/logpush/validate/destination/exists: post: tags: - Logpush jobs for a zone summary: Check destination exists description: Checks if there is an existing job with a destination. operationId: post-zones-zone_identifier-logpush-validate-destination-exists parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: required: - destination_conf properties: destination_conf: $ref: '#/components/schemas/logpush_destination_conf' responses: 4XX: description: Check destination exists response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_destination_exists_response' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Check destination exists response content: application/json: schema: $ref: '#/components/schemas/logpush_destination_exists_response' security: - api_email: [] api_key: [] /zones/{zone_id}/logpush/validate/origin: post: tags: - Logpush jobs for a zone summary: Validate origin description: Validates logpull origin with logpull_options. operationId: post-zones-zone_identifier-logpush-validate-origin parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/logpush_identifier' requestBody: required: true content: application/json: schema: required: - logpull_options properties: logpull_options: $ref: '#/components/schemas/logpush_logpull_options' responses: 4XX: description: Validate origin response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/logpush_validate_response' - $ref: '#/components/schemas/logpush_api-response-common-failure' "200": description: Validate origin response content: application/json: schema: $ref: '#/components/schemas/logpush_validate_response' security: - api_email: [] api_key: [] /zones/{zone_id}/managed_headers: get: tags: - Managed Transforms summary: List Managed Transforms description: Fetches a list of all Managed Transforms. operationId: managed-transforms-list-managed-transforms parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_identifier' responses: 4XX: description: List Managed Transforms response failure content: application/json: schema: allOf: - type: object properties: managed_request_headers: $ref: '#/components/schemas/rulesets_request_list' managed_response_headers: $ref: '#/components/schemas/rulesets_request_list' - $ref: '#/components/schemas/rulesets_api-response-common-failure' "200": description: List Managed Transforms response content: application/json: schema: type: object properties: managed_request_headers: $ref: '#/components/schemas/rulesets_request_list' managed_response_headers: $ref: '#/components/schemas/rulesets_request_list' security: - api_email: [] api_key: [] patch: tags: - Managed Transforms summary: Update status of Managed Transforms description: Updates the status of one or more Managed Transforms. operationId: managed-transforms-update-status-of-managed-transforms parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_identifier' requestBody: required: true content: application/json: schema: type: object required: - managed_request_headers - managed_response_headers properties: managed_request_headers: $ref: '#/components/schemas/rulesets_request_list' managed_response_headers: $ref: '#/components/schemas/rulesets_request_list' responses: 4XX: description: Update status of Managed Transforms response failure content: application/json: schema: allOf: - type: object properties: managed_request_headers: $ref: '#/components/schemas/rulesets_response_list' managed_response_headers: $ref: '#/components/schemas/rulesets_response_list' - $ref: '#/components/schemas/rulesets_api-response-common-failure' "200": description: Update status of Managed Transforms response content: application/json: schema: type: object properties: managed_request_headers: $ref: '#/components/schemas/rulesets_response_list' managed_response_headers: $ref: '#/components/schemas/rulesets_response_list' security: - api_email: [] api_key: [] /zones/{zone_id}/origin_tls_client_auth: get: tags: - Zone-Level Authenticated Origin Pulls summary: List Certificates operationId: zone-level-authenticated-origin-pulls-list-certificates parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: List Certificates response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: List Certificates response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_collection' security: - api_email: [] api_key: [] post: tags: - Zone-Level Authenticated Origin Pulls summary: Upload Certificate description: Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use. operationId: zone-level-authenticated-origin-pulls-upload-certificate parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object required: - certificate - private_key properties: certificate: $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate' private_key: $ref: '#/components/schemas/tls-certificates-and-hostnames_private_key' responses: 4XX: description: Upload Certificate response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Upload Certificate response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/origin_tls_client_auth/{certificate_id}: delete: tags: - Zone-Level Authenticated Origin Pulls summary: Delete Certificate operationId: zone-level-authenticated-origin-pulls-delete-certificate parameters: - name: certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Certificate response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Delete Certificate response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single' security: - api_email: [] api_key: [] get: tags: - Zone-Level Authenticated Origin Pulls summary: Get Certificate Details operationId: zone-level-authenticated-origin-pulls-get-certificate-details parameters: - name: certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Get Certificate Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Get Certificate Details response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/origin_tls_client_auth/hostnames: put: tags: - Per-hostname Authenticated Origin Pull summary: Enable or Disable a Hostname for Client Authentication description: 'Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter *enabled* to invalidate the association.' operationId: per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: required: - config properties: config: $ref: '#/components/schemas/tls-certificates-and-hostnames_config' responses: 4XX: description: Enable or Disable a Hostname for Client Authentication response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_aop_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Enable or Disable a Hostname for Client Authentication response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_aop_response_collection' security: - api_email: [] api_key: [] /zones/{zone_id}/origin_tls_client_auth/hostnames/{hostname}: get: tags: - Per-hostname Authenticated Origin Pull summary: Get the Hostname Status for Client Authentication operationId: per-hostname-authenticated-origin-pull-get-the-hostname-status-for-client-authentication parameters: - name: hostname in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostname' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Get the Hostname Status for Client Authentication response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_aop_single_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Get the Hostname Status for Client Authentication response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_aop_single_response' security: - api_email: [] api_key: [] /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates: get: tags: - Per-hostname Authenticated Origin Pull summary: List Certificates operationId: per-hostname-authenticated-origin-pull-list-certificates parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: List Certificates response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: List Certificates response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_collection' security: - api_email: [] api_key: [] post: tags: - Per-hostname Authenticated Origin Pull summary: Upload a Hostname Client Certificate description: Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed. operationId: per-hostname-authenticated-origin-pull-upload-a-hostname-client-certificate parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object required: - certificate - private_key properties: certificate: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate' private_key: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-private_key' responses: 4XX: description: Upload a Hostname Client Certificate response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Upload a Hostname Client Certificate response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}: delete: tags: - Per-hostname Authenticated Origin Pull summary: Delete Hostname Client Certificate operationId: per-hostname-authenticated-origin-pull-delete-hostname-client-certificate parameters: - name: certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Hostname Client Certificate response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Delete Hostname Client Certificate response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single' security: - api_email: [] api_key: [] get: tags: - Per-hostname Authenticated Origin Pull summary: Get the Hostname Client Certificate description: Get the certificate by ID to be used for client authentication on a hostname. operationId: per-hostname-authenticated-origin-pull-get-the-hostname-client-certificate parameters: - name: certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Get the Hostname Client Certificate response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Get the Hostname Client Certificate response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/origin_tls_client_auth/settings: get: tags: - Zone-Level Authenticated Origin Pulls summary: Get Enablement Setting for Zone description: Get whether zone-level authenticated origin pulls is enabled or not. It is false by default. operationId: zone-level-authenticated-origin-pulls-get-enablement-setting-for-zone parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Get Enablement Setting for Zone response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Get Enablement Setting for Zone response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled_response' security: - api_email: [] api_key: [] put: tags: - Zone-Level Authenticated Origin Pulls summary: Set Enablement for Zone description: Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use. operationId: zone-level-authenticated-origin-pulls-set-enablement-for-zone parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object required: - enabled properties: enabled: $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled' responses: 4XX: description: Set Enablement for Zone response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Set Enablement for Zone response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled_response' security: - api_email: [] api_key: [] /zones/{zone_id}/page_shield: get: tags: - Page Shield summary: Get Page Shield settings description: Fetches the Page Shield settings. operationId: page-shield-get-page-shield-settings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/page-shield_identifier' responses: 4XX: description: Get Page Shield settings response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/page-shield_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/page-shield_get-zone-settings-response' - $ref: '#/components/schemas/page-shield_api-response-common-failure' "200": description: Get Page Shield settings response content: application/json: schema: allOf: - $ref: '#/components/schemas/page-shield_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/page-shield_get-zone-settings-response' security: - api_email: [] api_key: [] put: tags: - Page Shield summary: Update Page Shield settings description: Updates Page Shield settings. operationId: page-shield-update-page-shield-settings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/page-shield_identifier' requestBody: required: true content: application/json: schema: properties: enabled: $ref: '#/components/schemas/page-shield_enabled' use_cloudflare_reporting_endpoint: $ref: '#/components/schemas/page-shield_use_cloudflare_reporting_endpoint' use_connection_url_path: $ref: '#/components/schemas/page-shield_use_connection_url_path' responses: 4XX: description: Update Page Shield settings response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/page-shield_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/page-shield_update-zone-settings-response' - $ref: '#/components/schemas/page-shield_api-response-common-failure' "200": description: Update Page Shield settings response content: application/json: schema: allOf: - $ref: '#/components/schemas/page-shield_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/page-shield_update-zone-settings-response' security: - api_email: [] api_key: [] /zones/{zone_id}/page_shield/connections: get: tags: - Page Shield summary: List Page Shield connections description: Lists all connections detected by Page Shield. operationId: page-shield-list-page-shield-connections parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/page-shield_identifier' - name: exclude_urls in: query schema: type: string description: | Excludes connections whose URL contains one of the URL-encoded URLs separated by commas. example: blog.cloudflare.com,www.example - name: urls in: query schema: type: string description: | Includes connections whose URL contain one or more URL-encoded URLs separated by commas. example: blog.cloudflare.com,www.example - name: hosts in: query schema: type: string description: | Includes connections that match one or more URL-encoded hostnames separated by commas. Wildcards are supported at the start and end of each hostname to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match example: blog.cloudflare.com,www.example*,*cloudflare.com - name: page in: query schema: type: string description: | The current page number of the paginated results. We additionally support a special value "all". When "all" is used, the API will return all the connections with the applied filters in a single page. Additionally, when using this value, the API will not return the categorisation data for the URL and domain of the connections. This feature is best-effort and it may only work for zones with a low number of connections example: 2 - name: per_page in: query schema: type: number description: The number of results per page. example: 100 minimum: 1 maximum: 100 - name: order_by in: query schema: type: string description: The field used to sort returned connections. enum: - first_seen_at - last_seen_at example: first_seen_at - name: direction in: query schema: type: string description: The direction used to sort returned connections. enum: - asc - desc example: asc - name: prioritize_malicious in: query schema: type: boolean description: When true, malicious connections appear first in the returned connections. example: true - name: exclude_cdn_cgi in: query schema: type: boolean description: When true, excludes connections seen in a `/cdn-cgi` path from the returned connections. The default value is true. example: true - name: status in: query schema: type: string description: 'Filters the returned connections using a comma-separated list of connection statuses. Accepted values: `active`, `infrequent`, and `inactive`. The default value is `active`.' example: active,inactive - name: page_url in: query schema: type: string description: | Includes connections that match one or more page URLs (separated by commas) where they were last seen Wildcards are supported at the start and end of each page URL to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match example: example.com/page,*/checkout,example.com/*,*checkout* - name: export in: query schema: type: string description: Export the list of connections as a file. Cannot be used with per_page or page options. enum: - csv example: csv responses: 4XX: description: List Page Shield connections response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/page-shield_list-zone-connections-response' - $ref: '#/components/schemas/page-shield_api-response-common-failure' "200": description: List Page Shield connections response content: application/json: schema: $ref: '#/components/schemas/page-shield_list-zone-connections-response' security: - api_email: [] api_key: [] /zones/{zone_id}/page_shield/connections/{connection_id}: get: tags: - Page Shield summary: Get a Page Shield connection description: Fetches a connection detected by Page Shield by connection ID. operationId: page-shield-get-a-page-shield-connection parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/page-shield_identifier' - name: connection_id in: path required: true schema: $ref: '#/components/schemas/page-shield_resource_id' responses: 4XX: description: Get a Page Shield connection response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/page-shield_get-zone-connection-response' - $ref: '#/components/schemas/page-shield_api-response-common-failure' "200": description: Get a Page Shield connection response content: application/json: schema: $ref: '#/components/schemas/page-shield_get-zone-connection-response' security: - api_email: [] api_key: [] /zones/{zone_id}/page_shield/policies: get: tags: - Page Shield summary: List Page Shield policies description: Lists all Page Shield policies. operationId: page-shield-list-page-shield-policies parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/page-shield_identifier' responses: 4XX: description: List Page Shield policies response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/page-shield_list-zone-policies-response' - $ref: '#/components/schemas/page-shield_api-response-common-failure' "200": description: List Page Shield policies response content: application/json: schema: $ref: '#/components/schemas/page-shield_list-zone-policies-response' security: - api_email: [] api_key: [] post: tags: - Page Shield summary: Create a Page Shield policy description: Create a Page Shield policy. operationId: page-shield-create-a-page-shield-policy parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/page-shield_identifier' requestBody: required: true content: application/json: schema: properties: action: $ref: '#/components/schemas/page-shield_pageshield-policy-action' description: $ref: '#/components/schemas/page-shield_pageshield-policy-description' enabled: $ref: '#/components/schemas/page-shield_pageshield-policy-enabled' expression: $ref: '#/components/schemas/page-shield_pageshield-policy-expression' value: $ref: '#/components/schemas/page-shield_pageshield-policy-value' responses: 4XX: description: Create a Page Shield policy response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/page-shield_get-zone-policy-response' - $ref: '#/components/schemas/page-shield_api-response-common-failure' "200": description: Create a Page Shield policy response content: application/json: schema: $ref: '#/components/schemas/page-shield_get-zone-policy-response' security: - api_email: [] api_key: [] /zones/{zone_id}/page_shield/policies/{policy_id}: delete: tags: - Page Shield summary: Delete a Page Shield policy description: Delete a Page Shield policy by ID. operationId: page-shield-delete-a-page-shield-policy parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/page-shield_identifier' - name: policy_id in: path required: true schema: $ref: '#/components/schemas/page-shield_policy_id' responses: 4XX: description: Delete a Page Shield policy response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/page-shield_get-zone-policy-response' - $ref: '#/components/schemas/page-shield_api-response-common-failure' "204": description: Delete a Page Shield policy response security: - api_email: [] api_key: [] get: tags: - Page Shield summary: Get a Page Shield policy description: Fetches a Page Shield policy by ID. operationId: page-shield-get-a-page-shield-policy parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/page-shield_identifier' - name: policy_id in: path required: true schema: $ref: '#/components/schemas/page-shield_policy_id' responses: 4XX: description: Get a Page Shield policy response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/page-shield_get-zone-policy-response' - $ref: '#/components/schemas/page-shield_api-response-common-failure' "200": description: Get a Page Shield policy response content: application/json: schema: $ref: '#/components/schemas/page-shield_get-zone-policy-response' security: - api_email: [] api_key: [] put: tags: - Page Shield summary: Update a Page Shield policy description: Update a Page Shield policy by ID. operationId: page-shield-update-a-page-shield-policy parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/page-shield_identifier' - name: policy_id in: path required: true schema: $ref: '#/components/schemas/page-shield_policy_id' requestBody: required: true content: application/json: schema: properties: action: $ref: '#/components/schemas/page-shield_pageshield-policy-action' description: $ref: '#/components/schemas/page-shield_pageshield-policy-description' enabled: $ref: '#/components/schemas/page-shield_pageshield-policy-enabled' expression: $ref: '#/components/schemas/page-shield_pageshield-policy-expression' value: $ref: '#/components/schemas/page-shield_pageshield-policy-value' responses: 4XX: description: Update a Page Shield policy response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/page-shield_get-zone-policy-response' - $ref: '#/components/schemas/page-shield_api-response-common-failure' "200": description: Update a Page Shield policy response content: application/json: schema: $ref: '#/components/schemas/page-shield_get-zone-policy-response' security: - api_email: [] api_key: [] /zones/{zone_id}/page_shield/scripts: get: tags: - Page Shield summary: List Page Shield scripts description: Lists all scripts detected by Page Shield. operationId: page-shield-list-page-shield-scripts parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/page-shield_identifier' - name: exclude_urls in: query schema: type: string description: | Excludes scripts whose URL contains one of the URL-encoded URLs separated by commas. example: blog.cloudflare.com,www.example - name: urls in: query schema: type: string description: | Includes scripts whose URL contain one or more URL-encoded URLs separated by commas. example: blog.cloudflare.com,www.example - name: hosts in: query schema: type: string description: | Includes scripts that match one or more URL-encoded hostnames separated by commas. Wildcards are supported at the start and end of each hostname to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match example: blog.cloudflare.com,www.example*,*cloudflare.com - name: page in: query schema: type: string description: | The current page number of the paginated results. We additionally support a special value "all". When "all" is used, the API will return all the scripts with the applied filters in a single page. Additionally, when using this value, the API will not return the script versions or categorisation data for the URL and domain of the scripts. This feature is best-effort and it may only work for zones with a low number of scripts example: 2 - name: per_page in: query schema: type: number description: The number of results per page. example: 100 minimum: 1 maximum: 100 - name: order_by in: query schema: type: string description: The field used to sort returned scripts. enum: - first_seen_at - last_seen_at example: first_seen_at - name: direction in: query schema: type: string description: The direction used to sort returned scripts. enum: - asc - desc example: asc - name: prioritize_malicious in: query schema: type: boolean description: When true, malicious scripts appear first in the returned scripts. example: true - name: exclude_cdn_cgi in: query schema: type: boolean description: When true, excludes scripts seen in a `/cdn-cgi` path from the returned scripts. The default value is true. default: true example: true - name: exclude_duplicates in: query schema: type: boolean description: | When true, excludes duplicate scripts. We consider a script duplicate of another if their javascript content matches and they share the same url host and zone hostname. In such case, we return the most recent script for the URL host and zone hostname combination. default: true example: true - name: status in: query schema: type: string description: 'Filters the returned scripts using a comma-separated list of scripts statuses. Accepted values: `active`, `infrequent`, and `inactive`. The default value is `active`.' example: active,inactive - name: page_url in: query schema: type: string description: | Includes scripts that match one or more page URLs (separated by commas) where they were last seen Wildcards are supported at the start and end of each page URL to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match example: example.com/page,*/checkout,example.com/*,*checkout* - name: export in: query schema: type: string description: Export the list of scripts as a file. Cannot be used with per_page or page options. enum: - csv example: csv responses: 4XX: description: List Page Shield scripts response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/page-shield_list-zone-scripts-response' - $ref: '#/components/schemas/page-shield_api-response-common-failure' "200": description: List Page Shield scripts response content: application/json: schema: $ref: '#/components/schemas/page-shield_list-zone-scripts-response' security: - api_email: [] api_key: [] /zones/{zone_id}/page_shield/scripts/{script_id}: get: tags: - Page Shield summary: Get a Page Shield script description: Fetches a script detected by Page Shield by script ID. operationId: page-shield-get-a-page-shield-script parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/page-shield_identifier' - name: script_id in: path required: true schema: $ref: '#/components/schemas/page-shield_resource_id' responses: 4XX: description: Get a Page Shield script response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/page-shield_get-zone-script-response' - $ref: '#/components/schemas/page-shield_api-response-common-failure' "200": description: Get a Page Shield script response content: application/json: schema: $ref: '#/components/schemas/page-shield_get-zone-script-response' security: - api_email: [] api_key: [] /zones/{zone_id}/pagerules: get: tags: - Page Rules summary: List Page Rules description: Fetches Page Rules in a zone. operationId: page-rules-list-page-rules parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' - name: order in: query schema: type: string description: The field used to sort returned Page Rules. enum: - status - priority default: priority example: status - name: direction in: query schema: type: string description: The direction used to sort returned Page Rules. enum: - asc - desc default: desc example: desc - name: match in: query schema: type: string description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match. enum: - any - all default: all - name: status in: query schema: type: string description: The status of the Page Rule. enum: - active - disabled default: disabled example: active responses: 4XX: description: List Page Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_pagerule_response_collection' - $ref: '#/components/schemas/zones_schemas-api-response-common-failure' "200": description: List Page Rules response content: application/json: schema: $ref: '#/components/schemas/zones_pagerule_response_collection' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Page Rules summary: Create a Page Rule description: Creates a new Page Rule. operationId: page-rules-create-a-page-rule parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' requestBody: required: true content: application/json: schema: type: object required: - targets - actions properties: actions: $ref: '#/components/schemas/zones_actions' priority: $ref: '#/components/schemas/zones_priority' status: $ref: '#/components/schemas/zones_status' targets: $ref: '#/components/schemas/zones_targets' responses: 4XX: description: Create a Page Rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_pagerule_response_single' - $ref: '#/components/schemas/zones_schemas-api-response-common-failure' "200": description: Create a Page Rule response content: application/json: schema: $ref: '#/components/schemas/zones_pagerule_response_single' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/pagerules/{pagerule_id}: delete: tags: - Page Rules summary: Delete a Page Rule description: Deletes an existing Page Rule. operationId: page-rules-delete-a-page-rule parameters: - name: pagerule_id in: path required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a Page Rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_schemas-api-response-single-id' - $ref: '#/components/schemas/zones_schemas-api-response-common-failure' "200": description: Delete a Page Rule response content: application/json: schema: $ref: '#/components/schemas/zones_schemas-api-response-single-id' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Page Rules summary: Get a Page Rule description: Fetches the details of a Page Rule. operationId: page-rules-get-a-page-rule parameters: - name: pagerule_id in: path required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' responses: 4XX: description: Get a Page Rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_pagerule_response_single' - $ref: '#/components/schemas/zones_schemas-api-response-common-failure' "200": description: Get a Page Rule response content: application/json: schema: $ref: '#/components/schemas/zones_pagerule_response_single' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Page Rules summary: Edit a Page Rule description: Updates one or more fields of an existing Page Rule. operationId: page-rules-edit-a-page-rule parameters: - name: pagerule_id in: path required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' requestBody: required: true content: application/json: schema: type: object properties: actions: $ref: '#/components/schemas/zones_actions' priority: $ref: '#/components/schemas/zones_priority' status: $ref: '#/components/schemas/zones_status' targets: $ref: '#/components/schemas/zones_targets' responses: 4XX: description: Edit a Page Rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_pagerule_response_single' - $ref: '#/components/schemas/zones_schemas-api-response-common-failure' "200": description: Edit a Page Rule response content: application/json: schema: $ref: '#/components/schemas/zones_pagerule_response_single' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Page Rules summary: Update a Page Rule description: Replaces the configuration of an existing Page Rule. The configuration of the updated Page Rule will exactly match the data passed in the API request. operationId: page-rules-update-a-page-rule parameters: - name: pagerule_id in: path required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' requestBody: required: true content: application/json: schema: type: object required: - targets - actions properties: actions: $ref: '#/components/schemas/zones_actions' priority: $ref: '#/components/schemas/zones_priority' status: $ref: '#/components/schemas/zones_status' targets: $ref: '#/components/schemas/zones_targets' responses: 4XX: description: Update a Page Rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_pagerule_response_single' - $ref: '#/components/schemas/zones_schemas-api-response-common-failure' "200": description: Update a Page Rule response content: application/json: schema: $ref: '#/components/schemas/zones_pagerule_response_single' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/pagerules/settings: get: tags: - Available Page Rules settings summary: List available Page Rules settings description: Returns a list of settings (and their details) that Page Rules can apply to matching requests. operationId: available-page-rules-settings-list-available-page-rules-settings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_schemas-identifier' responses: 4XX: description: List available Page Rules settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_pagerule_settings_response_collection' - $ref: '#/components/schemas/zones_schemas-api-response-common-failure' "200": description: List available Page Rules settings response content: application/json: schema: $ref: '#/components/schemas/zones_pagerule_settings_response_collection' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/purge_cache: post: tags: - Zone summary: Purge Cached Content description: | ### Purge All Cached Content Removes ALL files from Cloudflare's cache. All tiers can purge everything. ### Purge Cached Content by URL Granularly removes one or more files from Cloudflare's cache by specifying URLs. All tiers can purge by URL. To purge files with custom cache keys, include the headers used to compute the cache key as in the example. If you have a device type or geo in your cache key, you will need to include the CF-Device-Type or CF-IPCountry headers. If you have lang in your cache key, you will need to include the Accept-Language header. **NB:** When including the Origin header, be sure to include the **scheme** and **hostname**. The port number can be omitted if it is the default port (80 for http, 443 for https), but must be included otherwise. **NB:** For Zones on Free/Pro/Business plan, you may purge up to 30 URLs in one API call. For Zones on Enterprise plan, you may purge up to 500 URLs in one API call. ### Purge Cached Content by Tag, Host or Prefix Granularly removes one or more files from Cloudflare's cache either by specifying the host, the associated Cache-Tag, or a Prefix. Only Enterprise customers are permitted to purge by Tag, Host or Prefix. **NB:** Cache-Tag, host, and prefix purging each have a rate limit of 30,000 purge API calls in every 24 hour period. You may purge up to 30 tags, hosts, or prefixes in one API call. This rate limit can be raised for customers who need to purge at higher volume. operationId: zone-purge parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache-purge_identifier' requestBody: required: true content: application/json: schema: anyOf: - $ref: '#/components/schemas/cache-purge_Flex' - $ref: '#/components/schemas/cache-purge_Everything' - $ref: '#/components/schemas/cache-purge_Files' responses: 4xx: description: Purge Cached Content failure content: application/json: schema: allOf: - $ref: '#/components/schemas/cache-purge_api-response-single-id' - $ref: '#/components/schemas/cache-purge_api-response-common-failure' "200": description: Purge Cached Content content: application/json: schema: $ref: '#/components/schemas/cache-purge_api-response-single-id' security: - api_email: [] api_key: [] /zones/{zone_id}/rulesets: get: tags: - Zone Rulesets summary: List zone rulesets description: Fetches all rulesets at the zone level. operationId: listZoneRulesets parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' responses: 4XX: $ref: '#/components/responses/rulesets_Failure' "200": $ref: '#/components/responses/rulesets_Rulesets' security: - api_token: [] - api_email: [] api_key: [] - api_email: [] api_key: [] post: tags: - Zone Rulesets summary: Create a zone ruleset description: Creates a ruleset at the zone level. operationId: createZoneRuleset parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' requestBody: $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: [] /zones/{zone_id}/rulesets/{ruleset_id}: delete: tags: - Zone Rulesets summary: Delete a zone ruleset description: Deletes all versions of an existing zone ruleset. operationId: deleteZoneRuleset parameters: - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' responses: 4XX: $ref: '#/components/responses/rulesets_Failure' "204": $ref: '#/components/responses/rulesets_Empty' security: - api_token: [] - api_email: [] api_key: [] - api_email: [] api_key: [] get: tags: - Zone Rulesets summary: Get a zone ruleset description: Fetches the latest version of a zone ruleset. operationId: getZoneRuleset parameters: - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' responses: 4XX: $ref: '#/components/responses/rulesets_Failure' "200": $ref: '#/components/responses/rulesets_Ruleset' security: - api_token: [] - api_email: [] api_key: [] - api_email: [] api_key: [] put: tags: - Zone Rulesets summary: Update a zone ruleset description: Updates a zone ruleset, creating a new version. operationId: updateZoneRuleset parameters: - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' requestBody: $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: [] /zones/{zone_id}/rulesets/{ruleset_id}/rules: post: tags: - Zone Rulesets summary: Create a zone ruleset rule description: Adds a new rule to a zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default. operationId: createZoneRulesetRule parameters: - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' requestBody: $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: [] /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}: delete: tags: - Zone Rulesets summary: Delete a zone ruleset rule description: Deletes an existing rule from a zone ruleset. operationId: deleteZoneRulesetRule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RuleId' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' responses: 4XX: $ref: '#/components/responses/rulesets_Failure' "200": $ref: '#/components/responses/rulesets_Ruleset' security: - api_token: [] - api_email: [] api_key: [] - api_email: [] api_key: [] patch: tags: - Zone Rulesets summary: Update a zone ruleset rule description: Updates an existing rule in a zone ruleset. operationId: updateZoneRulesetRule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RuleId' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' requestBody: $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: [] /zones/{zone_id}/rulesets/{ruleset_id}/versions: get: tags: - Zone Rulesets summary: List a zone ruleset's versions description: Fetches the versions of a zone ruleset. operationId: listZoneRulesetVersions parameters: - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' responses: 4XX: $ref: '#/components/responses/rulesets_Failure' "200": $ref: '#/components/responses/rulesets_Rulesets' security: - api_token: [] - api_email: [] api_key: [] - api_email: [] api_key: [] /zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}: delete: tags: - Zone Rulesets summary: Delete a zone ruleset version description: Deletes an existing version of a zone ruleset. operationId: deleteZoneRulesetVersion parameters: - name: ruleset_version in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetVersion' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' responses: 4XX: $ref: '#/components/responses/rulesets_Failure' "204": $ref: '#/components/responses/rulesets_Empty' security: - api_token: [] - api_email: [] api_key: [] - api_email: [] api_key: [] get: tags: - Zone Rulesets summary: Get a zone ruleset version description: Fetches a specific version of a zone ruleset. operationId: getZoneRulesetVersion parameters: - name: ruleset_version in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetVersion' - name: ruleset_id in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetId' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' responses: 4XX: $ref: '#/components/responses/rulesets_Failure' "200": $ref: '#/components/responses/rulesets_Ruleset' security: - api_token: [] - api_email: [] api_key: [] - api_email: [] api_key: [] /zones/{zone_id}/rulesets/phases/{phase}/entrypoint: get: tags: - Transform Rules summary: List Transform Rules description: Fetches all Transform Rules in a zone. operationId: transform-rules-list-transform-rules parameters: - name: phase in: path required: true schema: $ref: '#/components/schemas/firewall_phase' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' responses: 4XX: description: List Transform Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_transform-rules_components-schemas-ruleset' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List Transform Rules response content: application/json: schema: $ref: '#/components/schemas/firewall_transform-rules_components-schemas-ruleset' security: - api_email: [] api_key: [] put: tags: - Transform Rules summary: Update Transform Rules description: Updates the Transform Rules of a zone. operationId: transform-rules-update-transform-rules parameters: - name: phase in: path required: true schema: $ref: '#/components/schemas/firewall_phase' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/firewall_update_ruleset' responses: 4XX: description: Update Transform Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update Transform Rules response content: application/json: schema: $ref: '#/components/schemas/firewall_api-response-single' security: - api_email: [] api_key: [] /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint: get: tags: - Zone Rulesets summary: Get a zone entry point ruleset description: Fetches the latest version of the zone entry point ruleset for a given phase. operationId: getZoneEntrypointRuleset parameters: - name: ruleset_phase in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetPhase' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' responses: 4XX: $ref: '#/components/responses/rulesets_Failure' "200": $ref: '#/components/responses/rulesets_Ruleset' security: - api_token: [] - api_email: [] api_key: [] - api_email: [] api_key: [] put: tags: - Zone Rulesets summary: Update a zone entry point ruleset description: Updates a zone entry point ruleset, creating a new version. operationId: updateZoneEntrypointRuleset parameters: - name: ruleset_phase in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetPhase' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' requestBody: $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: [] /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions: get: tags: - Zone Rulesets summary: List a zone entry point ruleset's versions description: Fetches the versions of a zone entry point ruleset. operationId: listZoneEntrypointRulesetVersions parameters: - name: ruleset_phase in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetPhase' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' responses: 4XX: $ref: '#/components/responses/rulesets_Failure' "200": $ref: '#/components/responses/rulesets_Rulesets' security: - api_token: [] - api_email: [] api_key: [] - api_email: [] api_key: [] /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}: get: tags: - Zone Rulesets summary: Get a zone entry point ruleset version description: Fetches a specific version of a zone entry point ruleset. operationId: getZoneEntrypointRulesetVersion parameters: - name: ruleset_version in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetVersion' - name: ruleset_phase in: path required: true schema: $ref: '#/components/schemas/rulesets_RulesetPhase' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_ZoneId' responses: 4XX: $ref: '#/components/responses/rulesets_Failure' "200": $ref: '#/components/responses/rulesets_Ruleset' security: - api_token: [] - api_email: [] api_key: [] - api_email: [] api_key: [] /zones/{zone_id}/rulesets/phases/http_config_settings/entrypoint: get: tags: - Config Rules summary: List Config Rules description: Fetches all Config Rules in a zone. operationId: config-rules-list-config-rules parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' responses: 4XX: description: List Config Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_components-schemas-ruleset' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List Config Rules response content: application/json: schema: $ref: '#/components/schemas/firewall_components-schemas-ruleset' security: - api_email: [] api_key: [] put: tags: - Config Rules summary: Update Config Rules description: Updates the Config Rules of a zone. operationId: config-rules-update-config-rules parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/firewall_update_ruleset' responses: 4XX: description: Update Config Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update Config Rules response content: application/json: schema: $ref: '#/components/schemas/firewall_api-response-single' security: - api_email: [] api_key: [] /zones/{zone_id}/rulesets/phases/http_request_cache_settings/entrypoint: get: tags: - Cache Rules summary: List Cache Rules description: Fetches all Cache Rules in a zone. operationId: cache-rules-list-cache-rules parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' responses: 4XX: description: List Cache Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_cache-rules_components-schemas-ruleset' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List Cache Rules response content: application/json: schema: $ref: '#/components/schemas/firewall_cache-rules_components-schemas-ruleset' security: - api_email: [] api_key: [] put: tags: - Cache Rules summary: Update Cache Rules description: Updates the Cache Rules of a zone. operationId: cache-rules-update-cache-rules parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/firewall_update_ruleset' responses: 4XX: description: Update Cache Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update Cache Rules response content: application/json: schema: $ref: '#/components/schemas/firewall_api-response-single' security: - api_email: [] api_key: [] /zones/{zone_id}/rulesets/phases/http_request_dynamic_redirect/entrypoint: get: tags: - Single Redirect Rules summary: List Single Redirect Rules description: Fetches all Single Redirect Rules in a zone. operationId: single-redirect-rules-list-single-redirect-rules parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' responses: 4XX: description: List Single Redirect Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_schemas-ruleset' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List Single Redirect Rules response content: application/json: schema: $ref: '#/components/schemas/firewall_schemas-ruleset' security: - api_email: [] api_key: [] put: tags: - Single Redirect Rules summary: Update Single Redirect Rules description: Updates the Single Redirect Rules of a zone. operationId: single-redirect-rules-update-single-redirect-rules parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/firewall_update_ruleset' responses: 4XX: description: Update Single Redirect Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update Single Redirect Rules response content: application/json: schema: $ref: '#/components/schemas/firewall_api-response-single' security: - api_email: [] api_key: [] /zones/{zone_id}/rulesets/phases/http_request_origin/entrypoint: get: tags: - Origin Rules summary: List Origin Rules description: Fetches all Origin Rules in a zone. operationId: origin-rules-list-origin-rules parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' responses: 4XX: description: List Origin Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_ruleset' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List Origin Rules response content: application/json: schema: $ref: '#/components/schemas/firewall_ruleset' security: - api_email: [] api_key: [] put: tags: - Origin Rules summary: Update Origin Rules description: Updates the Origin Rules of a zone. operationId: origin-rules-update-origin-rules parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/firewall_update_ruleset' responses: 4XX: description: Update Origin Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_api-response-single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update Origin Rules response content: application/json: schema: $ref: '#/components/schemas/firewall_api-response-single' security: - api_email: [] api_key: [] /zones/{zone_id}/secondary_dns/force_axfr: post: tags: - Secondary DNS (Secondary Zone) summary: Force AXFR description: Sends AXFR zone transfer request to primary nameserver(s). operationId: secondary-dns-(-secondary-zone)-force-axfr parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Force AXFR response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_force_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Force AXFR response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_force_response' security: - api_email: [] api_key: [] /zones/{zone_id}/secondary_dns/incoming: delete: tags: - Secondary DNS (Secondary Zone) summary: Delete Secondary Zone Configuration description: Delete secondary zone configuration for incoming zone transfers. operationId: secondary-dns-(-secondary-zone)-delete-secondary-zone-configuration parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Secondary Zone Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_id_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Delete Secondary Zone Configuration response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_id_response' security: - api_email: [] api_key: [] get: tags: - Secondary DNS (Secondary Zone) summary: Secondary Zone Configuration Details description: Get secondary zone configuration for incoming zone transfers. operationId: secondary-dns-(-secondary-zone)-secondary-zone-configuration-details parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' responses: 4XX: description: Secondary Zone Configuration Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_single_response_incoming' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Secondary Zone Configuration Details response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_single_response_incoming' security: - api_email: [] api_key: [] post: tags: - Secondary DNS (Secondary Zone) summary: Create Secondary Zone Configuration description: Create secondary zone configuration for incoming zone transfers. operationId: secondary-dns-(-secondary-zone)-create-secondary-zone-configuration parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/secondary-dns_dns-secondary-secondary-zone' responses: 4XX: description: Create Secondary Zone Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_single_response_incoming' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Create Secondary Zone Configuration response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_single_response_incoming' security: - api_email: [] api_key: [] put: tags: - Secondary DNS (Secondary Zone) summary: Update Secondary Zone Configuration description: Update secondary zone configuration for incoming zone transfers. operationId: secondary-dns-(-secondary-zone)-update-secondary-zone-configuration parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/secondary-dns_dns-secondary-secondary-zone' responses: 4XX: description: Update Secondary Zone Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_single_response_incoming' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Update Secondary Zone Configuration response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_single_response_incoming' security: - api_email: [] api_key: [] /zones/{zone_id}/secondary_dns/outgoing: delete: tags: - Secondary DNS (Primary Zone) summary: Delete Primary Zone Configuration description: Delete primary zone configuration for outgoing zone transfers. operationId: secondary-dns-(-primary-zone)-delete-primary-zone-configuration parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Primary Zone Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_id_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Delete Primary Zone Configuration response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_id_response' security: - api_email: [] api_key: [] get: tags: - Secondary DNS (Primary Zone) summary: Primary Zone Configuration Details description: Get primary zone configuration for outgoing zone transfers. operationId: secondary-dns-(-primary-zone)-primary-zone-configuration-details parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' responses: 4XX: description: Primary Zone Configuration Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_single_response_outgoing' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Primary Zone Configuration Details response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_single_response_outgoing' security: - api_email: [] api_key: [] post: tags: - Secondary DNS (Primary Zone) summary: Create Primary Zone Configuration description: Create primary zone configuration for outgoing zone transfers. operationId: secondary-dns-(-primary-zone)-create-primary-zone-configuration parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/secondary-dns_single_request_outgoing' responses: 4XX: description: Create Primary Zone Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_single_response_outgoing' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Create Primary Zone Configuration response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_single_response_outgoing' security: - api_email: [] api_key: [] put: tags: - Secondary DNS (Primary Zone) summary: Update Primary Zone Configuration description: Update primary zone configuration for outgoing zone transfers. operationId: secondary-dns-(-primary-zone)-update-primary-zone-configuration parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/secondary-dns_single_request_outgoing' responses: 4XX: description: Update Primary Zone Configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_single_response_outgoing' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Update Primary Zone Configuration response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_single_response_outgoing' security: - api_email: [] api_key: [] /zones/{zone_id}/secondary_dns/outgoing/disable: post: tags: - Secondary DNS (Primary Zone) summary: Disable Outgoing Zone Transfers description: Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone. operationId: secondary-dns-(-primary-zone)-disable-outgoing-zone-transfers parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Disable Outgoing Zone Transfers response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_disable_transfer_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Disable Outgoing Zone Transfers response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_disable_transfer_response' security: - api_email: [] api_key: [] /zones/{zone_id}/secondary_dns/outgoing/enable: post: tags: - Secondary DNS (Primary Zone) summary: Enable Outgoing Zone Transfers description: Enable outgoing zone transfers for primary zone. operationId: secondary-dns-(-primary-zone)-enable-outgoing-zone-transfers parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Enable Outgoing Zone Transfers response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_enable_transfer_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Enable Outgoing Zone Transfers response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_enable_transfer_response' security: - api_email: [] api_key: [] /zones/{zone_id}/secondary_dns/outgoing/force_notify: post: tags: - Secondary DNS (Primary Zone) summary: Force DNS NOTIFY description: Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone. operationId: secondary-dns-(-primary-zone)-force-dns-notify parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Force DNS NOTIFY response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_schemas-force_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Force DNS NOTIFY response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_schemas-force_response' security: - api_email: [] api_key: [] /zones/{zone_id}/secondary_dns/outgoing/status: get: tags: - Secondary DNS (Primary Zone) summary: Get Outgoing Zone Transfer Status description: Get primary zone transfer status. operationId: secondary-dns-(-primary-zone)-get-outgoing-zone-transfer-status parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/secondary-dns_identifier' responses: 4XX: description: Get Outgoing Zone Transfer Status response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/secondary-dns_enable_transfer_response' - $ref: '#/components/schemas/secondary-dns_api-response-common-failure' "200": description: Get Outgoing Zone Transfer Status response content: application/json: schema: $ref: '#/components/schemas/secondary-dns_enable_transfer_response' security: - api_email: [] api_key: [] /zones/{zone_id}/settings: get: tags: - Zone Settings summary: Get all Zone settings description: Available settings for your user in relation to a zone. operationId: zone-settings-get-all-zone-settings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get all Zone settings response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get all Zone settings response content: application/json: schema: $ref: '#/components/schemas/zones_zone_settings_response_collection' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Edit zone settings info description: Edit settings for a zone. operationId: zone-settings-edit-zone-settings-info parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - items properties: items: type: array description: One or more zone setting objects. Must contain an ID and a value. example: - id: always_online value: "on" - id: browser_cache_ttl value: 18000 - id: ip_geolocation value: "off" minItems: 1 items: $ref: '#/components/schemas/zones_setting' responses: 4XX: description: Edit zone settings info response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Edit zone settings info response content: application/json: schema: $ref: '#/components/schemas/zones_zone_settings_response_collection' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/0rtt: get: tags: - Zone Settings summary: Get 0-RTT session resumption setting description: Gets 0-RTT session resumption setting. operationId: zone-settings-get-0-rtt-session-resumption-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get 0-RTT session resumption setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get 0-RTT session resumption setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_0rtt' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change 0-RTT session resumption setting description: Changes the 0-RTT session resumption setting. operationId: zone-settings-change-0-rtt-session-resumption-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_0rtt_value' responses: 4XX: description: Change 0-RTT session resumption setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change 0-RTT session resumption setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_0rtt' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/advanced_ddos: get: tags: - Zone Settings summary: Get Advanced DDOS setting description: Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones. operationId: zone-settings-get-advanced-ddos-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Advanced DDOS setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Advanced DDOS setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_advanced_ddos' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/always_online: get: tags: - Zone Settings summary: Get Always Online setting description: When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information. operationId: zone-settings-get-always-online-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Always Online setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Always Online setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_always_online' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Always Online setting description: When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information. operationId: zone-settings-change-always-online-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_always_online_value' responses: 4XX: description: Change Always Online setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Always Online setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_always_online' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/always_use_https: get: tags: - Zone Settings summary: Get Always Use HTTPS setting description: Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule. operationId: zone-settings-get-always-use-https-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Always Use HTTPS setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Always Use HTTPS setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_always_use_https' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Always Use HTTPS setting description: Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule. operationId: zone-settings-change-always-use-https-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_always_use_https_value' responses: 4XX: description: Change Always Use HTTPS setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Always Use HTTPS setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_always_use_https' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/automatic_https_rewrites: get: tags: - Zone Settings summary: Get Automatic HTTPS Rewrites setting description: Enable the Automatic HTTPS Rewrites feature for this zone. operationId: zone-settings-get-automatic-https-rewrites-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Automatic HTTPS Rewrites setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Automatic HTTPS Rewrites setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_automatic_https_rewrites' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Automatic HTTPS Rewrites setting description: Enable the Automatic HTTPS Rewrites feature for this zone. operationId: zone-settings-change-automatic-https-rewrites-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_automatic_https_rewrites_value' responses: 4XX: description: Change Automatic HTTPS Rewrites setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Automatic HTTPS Rewrites setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_automatic_https_rewrites' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/automatic_platform_optimization: get: tags: - Zone Settings summary: Get Automatic Platform Optimization for WordPress setting description: | [Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts. operationId: zone-settings-get-automatic_platform_optimization-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Automatic Platform Optimization for WordPress setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Automatic Platform Optimization for WordPress setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_automatic_platform_optimization' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Automatic Platform Optimization for WordPress setting description: | [Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts. operationId: zone-settings-change-automatic_platform_optimization-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_automatic_platform_optimization' responses: 4XX: description: Change Automatic Platform Optimization for WordPress setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Automatic Platform Optimization for WordPress setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_automatic_platform_optimization' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/brotli: get: tags: - Zone Settings summary: Get Brotli setting description: When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. operationId: zone-settings-get-brotli-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Brotli setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Brotli setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_brotli' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Brotli setting description: When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. operationId: zone-settings-change-brotli-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_brotli_value' responses: 4XX: description: Change Brotli setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Brotli setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_brotli' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/browser_cache_ttl: get: tags: - Zone Settings summary: Get Browser Cache TTL setting description: Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276). operationId: zone-settings-get-browser-cache-ttl-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Browser Cache TTL setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Browser Cache TTL setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_browser_cache_ttl' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Browser Cache TTL setting description: Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276). operationId: zone-settings-change-browser-cache-ttl-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_browser_cache_ttl_value' responses: 4XX: description: Change Browser Cache TTL setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Browser Cache TTL setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_browser_cache_ttl' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/browser_check: get: tags: - Zone Settings summary: Get Browser Check setting description: Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086). operationId: zone-settings-get-browser-check-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Browser Check setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Browser Check setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_browser_check' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Browser Check setting description: Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086). operationId: zone-settings-change-browser-check-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_browser_check_value' responses: 4XX: description: Change Browser Check setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Browser Check setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_browser_check' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/cache_level: get: tags: - Zone Settings summary: Get Cache Level setting description: Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256). operationId: zone-settings-get-cache-level-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Cache Level setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Cache Level setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_cache_level' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Cache Level setting description: Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256). operationId: zone-settings-change-cache-level-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_cache_level_value' responses: 4XX: description: Change Cache Level setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Cache Level setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_cache_level' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/challenge_ttl: get: tags: - Zone Settings summary: Get Challenge TTL setting description: Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136). operationId: zone-settings-get-challenge-ttl-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Challenge TTL setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Challenge TTL setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_challenge_ttl' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Challenge TTL setting description: Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136). operationId: zone-settings-change-challenge-ttl-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_challenge_ttl_value' responses: 4XX: description: Change Challenge TTL setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Challenge TTL setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_challenge_ttl' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/ciphers: get: tags: - Zone Settings summary: Get ciphers setting description: Gets ciphers setting. operationId: zone-settings-get-ciphers-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get ciphers setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get ciphers setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_ciphers' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change ciphers setting description: Changes ciphers setting. operationId: zone-settings-change-ciphers-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_ciphers_value' responses: 4XX: description: Change ciphers setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change ciphers setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_ciphers' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/development_mode: get: tags: - Zone Settings summary: Get Development Mode setting description: Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off. operationId: zone-settings-get-development-mode-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Development Mode setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Development Mode setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_development_mode' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Development Mode setting description: Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off. operationId: zone-settings-change-development-mode-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_development_mode_value' responses: 4XX: description: Change Development Mode setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Development Mode setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_development_mode' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/early_hints: get: tags: - Zone Settings summary: Get Early Hints setting description: When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information. operationId: zone-settings-get-early-hints-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Early Hints setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Early Hints setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_early_hints' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Early Hints setting description: When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information. operationId: zone-settings-change-early-hints-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_early_hints_value' responses: 4XX: description: Change Early Hints setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Early Hints setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_early_hints' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/email_obfuscation: get: tags: - Zone Settings summary: Get Email Obfuscation setting description: Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016). operationId: zone-settings-get-email-obfuscation-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Email Obfuscation setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Email Obfuscation setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_email_obfuscation' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Email Obfuscation setting description: Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016). operationId: zone-settings-change-email-obfuscation-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_email_obfuscation_value' responses: 4XX: description: Change Email Obfuscation setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Email Obfuscation setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_email_obfuscation' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/fonts: get: tags: - Zone Settings summary: Get Cloudflare Fonts setting description: | Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain, boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information. operationId: zone-settings-get-fonts-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' responses: 4XX: description: Get Cloudflare Fonts setting response failure content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' "200": description: Get Cloudflare Fonts setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_cloudflare_fonts' security: - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Cloudflare Fonts setting description: | Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain, boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information. operationId: zone-settings-change-fonts-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/speed_cloudflare_fonts_value' responses: 4XX: description: Change Cloudflare Fonts setting response failure content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' "200": description: Change Cloudflare Fonts setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_cloudflare_fonts' security: - api_email: [] api_key: [] /zones/{zone_id}/settings/h2_prioritization: get: tags: - Zone Settings summary: Get HTTP/2 Edge Prioritization setting description: | Gets HTTP/2 Edge Prioritization setting. operationId: zone-settings-get-h2_prioritization-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get HTTP/2 Edge Prioritization setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get HTTP/2 Edge Prioritization setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_h2_prioritization' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change HTTP/2 Edge Prioritization setting description: | Gets HTTP/2 Edge Prioritization setting. operationId: zone-settings-change-h2_prioritization-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_h2_prioritization' responses: 4XX: description: Change HTTP/2 Edge Prioritization setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change HTTP/2 Edge Prioritization setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_h2_prioritization' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/hotlink_protection: get: tags: - Zone Settings summary: Get Hotlink Protection setting description: When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026). operationId: zone-settings-get-hotlink-protection-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Hotlink Protection setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Hotlink Protection setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_hotlink_protection' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Hotlink Protection setting description: When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026). operationId: zone-settings-change-hotlink-protection-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_hotlink_protection_value' responses: 4XX: description: Change Hotlink Protection setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Hotlink Protection setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_hotlink_protection' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/http2: get: tags: - Zone Settings summary: Get HTTP2 setting description: Value of the HTTP2 setting. operationId: zone-settings-get-h-t-t-p-2-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get HTTP2 setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get HTTP2 setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_http2' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change HTTP2 setting description: Value of the HTTP2 setting. operationId: zone-settings-change-h-t-t-p-2-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_http2_value' responses: 4XX: description: Change HTTP2 setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change HTTP2 setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_http2' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/http3: get: tags: - Zone Settings summary: Get HTTP3 setting description: Value of the HTTP3 setting. operationId: zone-settings-get-h-t-t-p-3-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get HTTP3 setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get HTTP3 setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_http3' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change HTTP3 setting description: Value of the HTTP3 setting. operationId: zone-settings-change-h-t-t-p-3-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_http3_value' responses: 4XX: description: Change HTTP3 setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change HTTP3 setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_http3' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/image_resizing: get: tags: - Zone Settings summary: Get Image Resizing setting description: | Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information. operationId: zone-settings-get-image_resizing-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Image Resizing setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Image Resizing setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_image_resizing' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Image Resizing setting description: | Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information. operationId: zone-settings-change-image_resizing-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_image_resizing' responses: 4XX: description: Change Image Resizing setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Image Resizing setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_image_resizing' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/ip_geolocation: get: tags: - Zone Settings summary: Get IP Geolocation setting description: Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236). operationId: zone-settings-get-ip-geolocation-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get IP Geolocation setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get IP Geolocation setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_ip_geolocation' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change IP Geolocation setting description: Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236). operationId: zone-settings-change-ip-geolocation-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_ip_geolocation_value' responses: 4XX: description: Change IP Geolocation setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change IP Geolocation setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_ip_geolocation' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/ipv6: get: tags: - Zone Settings summary: Get IPv6 setting description: Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). operationId: zone-settings-get-i-pv6-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get IPv6 setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get IPv6 setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_ipv6' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change IPv6 setting description: Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). operationId: zone-settings-change-i-pv6-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_ipv6_value' responses: 4XX: description: Change IPv6 setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change IPv6 setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_ipv6' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/min_tls_version: get: tags: - Zone Settings summary: Get Minimum TLS Version setting description: Gets Minimum TLS Version setting. operationId: zone-settings-get-minimum-tls-version-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Minimum TLS Version setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Minimum TLS Version setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_min_tls_version' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Minimum TLS Version setting description: Changes Minimum TLS Version setting. operationId: zone-settings-change-minimum-tls-version-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_min_tls_version_value' responses: 4XX: description: Change Minimum TLS Version setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Minimum TLS Version setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_min_tls_version' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/minify: get: tags: - Zone Settings summary: Get Minify setting description: Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information. operationId: zone-settings-get-minify-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Minify setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Minify setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_minify' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Minify setting description: Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information. operationId: zone-settings-change-minify-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_minify_value' responses: 4XX: description: Change Minify setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Minify setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_minify' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/mirage: get: tags: - Zone Settings summary: Get Mirage setting description: | Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information. operationId: zone-settings-get-mirage-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Mirage setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Mirage setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_mirage' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Mirage setting description: Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information. operationId: zone-settings-change-web-mirage-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_mirage_value' responses: 4XX: description: Change Mirage setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Mirage setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_mirage' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/mobile_redirect: get: tags: - Zone Settings summary: Get Mobile Redirect setting description: Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information. operationId: zone-settings-get-mobile-redirect-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Mobile Redirect setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Mobile Redirect setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_mobile_redirect' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Mobile Redirect setting description: Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information. operationId: zone-settings-change-mobile-redirect-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_mobile_redirect_value' responses: 4XX: description: Change Mobile Redirect setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Mobile Redirect setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_mobile_redirect' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/nel: get: tags: - Zone Settings summary: Get Network Error Logging setting description: | Enable Network Error Logging reporting on your zone. (Beta) operationId: zone-settings-get-nel-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Network Error Logging setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Network Error Logging setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_nel' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Network Error Logging setting description: Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/nel-solving-mobile-speed) for more information. operationId: zone-settings-change-nel-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_nel' responses: 4XX: description: Change Network Error Logging setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Network Error Logging setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_nel' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/opportunistic_encryption: get: tags: - Zone Settings summary: Get Opportunistic Encryption setting description: Gets Opportunistic Encryption setting. operationId: zone-settings-get-opportunistic-encryption-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Opportunistic Encryption setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Opportunistic Encryption setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_opportunistic_encryption' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Opportunistic Encryption setting description: Changes Opportunistic Encryption setting. operationId: zone-settings-change-opportunistic-encryption-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_opportunistic_encryption_value' responses: 4XX: description: Change Opportunistic Encryption setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Opportunistic Encryption setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_opportunistic_encryption' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/opportunistic_onion: get: tags: - Zone Settings summary: Get Opportunistic Onion setting description: Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes. operationId: zone-settings-get-opportunistic-onion-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Opportunistic Onion setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Opportunistic Onion setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_opportunistic_onion' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Opportunistic Onion setting description: Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes. operationId: zone-settings-change-opportunistic-onion-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_opportunistic_onion_value' responses: 4XX: description: Change Opportunistic Onion setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Opportunistic Onion setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_opportunistic_onion' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/orange_to_orange: get: tags: - Zone Settings summary: Get Orange to Orange (O2O) setting description: | Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. operationId: zone-settings-get-orange_to_orange-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Orange to Orange (O2O) setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Orange to Orange (O2O) setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_orange_to_orange' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Orange to Orange (O2O) setting description: | Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. operationId: zone-settings-change-orange_to_orange-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_orange_to_orange' responses: 4XX: description: Change Orange to Orange (O2O) setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Orange to Orange (O2O) setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_orange_to_orange' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/origin_error_page_pass_thru: get: tags: - Zone Settings summary: Get Enable Error Pages On setting description: Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones. operationId: zone-settings-get-enable-error-pages-on-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Enable Error Pages On setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Enable Error Pages On setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_origin_error_page_pass_thru' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Enable Error Pages On setting description: Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones. operationId: zone-settings-change-enable-error-pages-on-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_origin_error_page_pass_thru_value' responses: 4XX: description: Change Enable Error Pages On setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Enable Error Pages On setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_origin_error_page_pass_thru' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/origin_max_http_version: get: tags: - Zone Cache Settings summary: Get Origin Max HTTP Version Setting description: Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except ENT where it is "1" operationId: zone-cache-settings-get-origin-max-http-version-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' responses: 4XX: description: Get Origin Max HTTP Version Setting Response Failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_origin_max_http_version_response_value' - $ref: '#/components/schemas/cache_api-response-common-failure' examples: Error: $ref: '#/components/examples/cache_dummy_error_response' "200": description: Get Origin Max HTTP Version Setting Response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_origin_max_http_version_response_value' examples: max_http_version_2: $ref: '#/components/examples/cache_origin_max_http_version_2' security: - api_email: [] api_key: [] patch: tags: - Zone Cache Settings summary: Change Origin Max HTTP Version Setting description: Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except ENT where it is "1" operationId: zone-cache-settings-change-origin-max-http-version-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/cache_origin_max_http_version_value' responses: 4XX: description: Change Origin Max HTTP Version Response Failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_origin_max_http_version_response_value' - $ref: '#/components/schemas/cache_api-response-common-failure' examples: Error: $ref: '#/components/examples/cache_dummy_error_response' "200": description: Change Origin Max HTTP Version Setting Response content: application/json: schema: allOf: - $ref: '#/components/schemas/cache_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache_origin_max_http_version_response_value' examples: max_http_version_2: $ref: '#/components/examples/cache_origin_max_http_version_2' security: - api_email: [] api_key: [] /zones/{zone_id}/settings/polish: get: tags: - Zone Settings summary: Get Polish setting description: | Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/polish-solving-mobile-speed) for more information. operationId: zone-settings-get-polish-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Polish setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Polish setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_polish' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Polish setting description: Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/polish-solving-mobile-speed) for more information. operationId: zone-settings-change-polish-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_polish' responses: 4XX: description: Change Polish setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Polish setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_polish' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/prefetch_preload: get: tags: - Zone Settings summary: Get prefetch preload setting description: Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. operationId: zone-settings-get-prefetch-preload-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get prefetch preload setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get prefetch preload setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_prefetch_preload' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change prefetch preload setting description: Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. operationId: zone-settings-change-prefetch-preload-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_prefetch_preload_value' responses: 4XX: description: Change prefetch preload setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change prefetch preload setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_prefetch_preload' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/proxy_read_timeout: get: tags: - Zone Settings summary: Get Proxy Read Timeout setting description: | Maximum time between two read operations from origin. operationId: zone-settings-get-proxy_read_timeout-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Proxy Read Timeout setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Proxy Read Timeout setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_proxy_read_timeout' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Proxy Read Timeout setting description: | Maximum time between two read operations from origin. operationId: zone-settings-change-proxy_read_timeout-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_proxy_read_timeout' responses: 4XX: description: Change Proxy Read Timeout setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Proxy Read Timeout setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_proxy_read_timeout' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/pseudo_ipv4: get: tags: - Zone Settings summary: Get Pseudo IPv4 setting description: Value of the Pseudo IPv4 setting. operationId: zone-settings-get-pseudo-i-pv4-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Pseudo IPv4 setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Pseudo IPv4 setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_pseudo_ipv4' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Pseudo IPv4 setting description: Value of the Pseudo IPv4 setting. operationId: zone-settings-change-pseudo-i-pv4-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_pseudo_ipv4_value' responses: 4XX: description: Change Pseudo IPv4 setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Pseudo IPv4 setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_pseudo_ipv4' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/response_buffering: get: tags: - Zone Settings summary: Get Response Buffering setting description: Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones. operationId: zone-settings-get-response-buffering-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Response Buffering setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Response Buffering setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_response_buffering' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Response Buffering setting description: Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones. operationId: zone-settings-change-response-buffering-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_response_buffering_value' responses: 4XX: description: Change Response Buffering setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Response Buffering setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_response_buffering' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/rocket_loader: get: tags: - Zone Settings summary: Get Rocket Loader setting description: | Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information. operationId: zone-settings-get-rocket_loader-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Rocket Loader setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Rocket Loader setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_rocket_loader' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Rocket Loader setting description: | Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information. operationId: zone-settings-change-rocket_loader-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_rocket_loader' responses: 4XX: description: Change Rocket Loader setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Rocket Loader setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_rocket_loader' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/security_header: get: tags: - Zone Settings summary: Get Security Header (HSTS) setting description: Cloudflare security header for a zone. operationId: zone-settings-get-security-header-(-hsts)-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Security Header (HSTS) setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Security Header (HSTS) setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_security_header' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Security Header (HSTS) setting description: Cloudflare security header for a zone. operationId: zone-settings-change-security-header-(-hsts)-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_security_header_value' responses: 4XX: description: Change Security Header (HSTS) setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Security Header (HSTS) setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_security_header' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/security_level: get: tags: - Zone Settings summary: Get Security Level setting description: Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056). operationId: zone-settings-get-security-level-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Security Level setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Security Level setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_security_level' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Security Level setting description: Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056). operationId: zone-settings-change-security-level-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_security_level_value' responses: 4XX: description: Change Security Level setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Security Level setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_security_level' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/server_side_exclude: get: tags: - Zone Settings summary: Get Server Side Exclude setting description: 'If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won''t see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won''t see the SSE tags in your HTML source when it''s served through Cloudflare. SSE will still function in this case, as Cloudflare''s HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor''s computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).' operationId: zone-settings-get-server-side-exclude-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Server Side Exclude setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Server Side Exclude setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_server_side_exclude' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Server Side Exclude setting description: 'If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won''t see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won''t see the SSE tags in your HTML source when it''s served through Cloudflare. SSE will still function in this case, as Cloudflare''s HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor''s computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).' operationId: zone-settings-change-server-side-exclude-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_server_side_exclude_value' responses: 4XX: description: Change Server Side Exclude setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Server Side Exclude setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_server_side_exclude' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/sort_query_string_for_cache: get: tags: - Zone Settings summary: Get Enable Query String Sort setting description: Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones. operationId: zone-settings-get-enable-query-string-sort-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Enable Query String Sort setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Enable Query String Sort setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_sort_query_string_for_cache' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Enable Query String Sort setting description: Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones. operationId: zone-settings-change-enable-query-string-sort-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_sort_query_string_for_cache_value' responses: 4XX: description: Change Enable Query String Sort setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Enable Query String Sort setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_sort_query_string_for_cache' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/ssl: get: tags: - Zone Settings summary: Get SSL setting description: 'SSL encrypts your visitor''s connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don''t need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).' operationId: zone-settings-get-ssl-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get SSL setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get SSL setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_ssl' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change SSL setting description: 'SSL encrypts your visitor''s connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don''t need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).' operationId: zone-settings-change-ssl-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_ssl_value' responses: 4XX: description: Change SSL setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change SSL setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_ssl' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/ssl_recommender: get: tags: - Zone Settings summary: Get SSL/TLS Recommender enrollment setting description: | Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. operationId: zone-settings-get-ssl_recommender-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get SSL/TLS Recommender enrollment setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get SSL/TLS Recommender enrollment setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_ssl_recommender' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change SSL/TLS Recommender enrollment setting description: | Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. operationId: zone-settings-change-ssl_recommender-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_ssl_recommender' responses: 4XX: description: Change SSL/TLS Recommender enrollment setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change SSL/TLS Recommender enrollment setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_ssl_recommender' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/tls_1_3: get: tags: - Zone Settings summary: Get TLS 1.3 setting enabled for a zone description: Gets TLS 1.3 setting enabled for a zone. operationId: zone-settings-get-tls-1.-3-setting-enabled-for-a-zone parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get TLS 1.3 setting enabled for a zone response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get TLS 1.3 setting enabled for a zone response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_tls_1_3' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change TLS 1.3 setting description: Changes TLS 1.3 setting. operationId: zone-settings-change-tls-1.-3-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_tls_1_3_value' responses: 4XX: description: Change TLS 1.3 setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change TLS 1.3 setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_tls_1_3' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/tls_client_auth: get: tags: - Zone Settings summary: Get TLS Client Auth setting description: TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). operationId: zone-settings-get-tls-client-auth-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get TLS Client Auth setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get TLS Client Auth setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_tls_client_auth' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change TLS Client Auth setting description: TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). operationId: zone-settings-change-tls-client-auth-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_tls_client_auth_value' responses: 4XX: description: Change TLS Client Auth setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change TLS Client Auth setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_tls_client_auth' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/true_client_ip_header: get: tags: - Zone Settings summary: Get True Client IP setting description: Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones. operationId: zone-settings-get-true-client-ip-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get True Client IP setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get True Client IP setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_true_client_ip_header' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change True Client IP setting description: Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones. operationId: zone-settings-change-true-client-ip-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_true_client_ip_header_value' responses: 4XX: description: Change True Client IP setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change True Client IP setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_true_client_ip_header' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/waf: get: tags: - Zone Settings summary: Get Web Application Firewall (WAF) setting description: The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016). operationId: zone-settings-get-web-application-firewall-(-waf)-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get Web Application Firewall (WAF) setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get Web Application Firewall (WAF) setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_waf' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change Web Application Firewall (WAF) setting description: The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016). operationId: zone-settings-change-web-application-firewall-(-waf)-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_waf_value' responses: 4XX: description: Change Web Application Firewall (WAF) setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change Web Application Firewall (WAF) setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_waf' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/webp: get: tags: - Zone Settings summary: Get WebP setting description: When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image. operationId: zone-settings-get-web-p-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get WebP setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get WebP setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_webp' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change WebP setting description: When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image. operationId: zone-settings-change-web-p-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_webp_value' responses: 4XX: description: Change WebP setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change WebP setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_webp' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/websockets: get: tags: - Zone Settings summary: Get WebSockets setting description: Gets Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets). operationId: zone-settings-get-web-sockets-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: 4XX: description: Get WebSockets setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Get WebSockets setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_websockets' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Zone Settings summary: Change WebSockets setting description: Changes Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets). operationId: zone-settings-change-web-sockets-setting parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: required: - value properties: value: $ref: '#/components/schemas/zones_websockets_value' responses: 4XX: description: Change WebSockets setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure' "200": description: Change WebSockets setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_zone_settings_response_single' - properties: result: $ref: '#/components/schemas/zones_websockets' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/zaraz/config: get: tags: - Zaraz summary: Get Zaraz configuration description: Gets latest Zaraz configuration for a zone. It can be preview or published configuration, whichever was the last updated. Secret variables values will not be included. operationId: get-zones-zone_identifier-zaraz-config parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zaraz_identifier' responses: 4XX: description: Get Zaraz configuration response failure content: application/json: schema: $ref: '#/components/schemas/zaraz_api-response-common-failure' "200": description: Get Zaraz configuration response content: application/json: schema: $ref: '#/components/schemas/zaraz_zaraz-config-response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Zaraz summary: Update Zaraz configuration description: Updates Zaraz configuration for a zone. operationId: put-zones-zone_identifier-zaraz-config parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zaraz_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/zaraz_zaraz-config-body' responses: 4XX: description: Update Zaraz configuration response failure content: application/json: schema: $ref: '#/components/schemas/zaraz_api-response-common-failure' "200": description: Update Zaraz configuration response content: application/json: schema: $ref: '#/components/schemas/zaraz_zaraz-config-response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/zaraz/default: get: tags: - Zaraz summary: Get default Zaraz configuration description: Gets default Zaraz configuration for a zone. operationId: get-zones-zone_identifier-zaraz-default parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zaraz_identifier' responses: 4XX: description: Get Zaraz default configuration response failure content: application/json: schema: $ref: '#/components/schemas/zaraz_api-response-common-failure' "200": description: Get Zaraz default configuration response content: application/json: schema: $ref: '#/components/schemas/zaraz_zaraz-config-response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/zaraz/export: get: tags: - Zaraz summary: Export Zaraz configuration description: Exports full current published Zaraz configuration for a zone, secret variables included. operationId: get-zones-zone_identifier-zaraz-export parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zaraz_identifier' responses: 4XX: description: Get Zaraz configuration response failure content: application/json: schema: $ref: '#/components/schemas/zaraz_api-response-common-failure' "200": description: Get Zaraz configuration response headers: Content-Disposition: parameter: schema: type: string example: attachment; filename=zaraz-2023-11-10-23-00.json content: application/json: schema: $ref: '#/components/schemas/zaraz_zaraz-config-return' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/zaraz/history: get: tags: - Zaraz summary: List Zaraz historical configuration records description: Lists a history of published Zaraz configuration records for a zone. operationId: get-zones-zone_identifier-zaraz-history parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zaraz_identifier' - name: offset in: query description: Ordinal number to start listing the results with. Default value is 0. schema: type: integer minimum: 0 example: 0 - name: limit in: query description: Maximum amount of results to list. Default value is 10. schema: type: integer minimum: 1 example: 10 - name: sortField in: query description: The field to sort by. Default is updated_at. schema: type: string enum: - id - user_id - description - created_at - updated_at example: updated_at - name: sortOrder in: query description: Sorting order. Default is DESC. schema: type: string enum: - DESC - ASC example: DESC responses: 4XX: description: List Zaraz historical configuration records failure content: application/json: schema: $ref: '#/components/schemas/zaraz_api-response-common-failure' "200": description: List Zaraz historical configuration records response content: application/json: schema: $ref: '#/components/schemas/zaraz_zaraz-history-response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Zaraz summary: Restore Zaraz historical configuration by ID description: Restores a historical published Zaraz configuration by ID for a zone. operationId: put-zones-zone_identifier-zaraz-history parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zaraz_identifier' requestBody: required: true content: application/json: schema: type: integer description: ID of the Zaraz configuration to restore. example: 12345 minimum: 1 responses: 4XX: description: Restore Zaraz historical configuration by ID failure content: application/json: schema: $ref: '#/components/schemas/zaraz_api-response-common-failure' "200": description: Restore Zaraz historical configuration by ID response content: application/json: schema: $ref: '#/components/schemas/zaraz_zaraz-config-response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/zaraz/history/configs: get: tags: - Zaraz summary: Get Zaraz historical configurations by ID(s) description: Gets a history of published Zaraz configurations by ID(s) for a zone. operationId: get-zones-zone_identifier-zaraz-config-history parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zaraz_identifier' - name: ids in: query description: Comma separated list of Zaraz configuration IDs style: form explode: false required: true schema: type: array items: type: integer example: - 12345 - 23456 responses: 4XX: description: Get Zaraz historical configurations by ID(s) failure content: application/json: schema: $ref: '#/components/schemas/zaraz_api-response-common-failure' "200": description: Get Zaraz historical configurations by ID(s) response content: application/json: schema: $ref: '#/components/schemas/zaraz_zaraz-config-history-response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/zaraz/publish: post: tags: - Zaraz summary: Publish Zaraz preview configuration description: Publish current Zaraz preview configuration for a zone. operationId: post-zones-zone_identifier-zaraz-publish parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zaraz_identifier' requestBody: content: application/json: schema: type: string description: Zaraz configuration description. example: Config with enabled ecommerce tracking responses: 4XX: description: Update Zaraz workflow response failure content: application/json: schema: $ref: '#/components/schemas/zaraz_api-response-common-failure' "200": description: Update Zaraz workflow response content: application/json: schema: allOf: - $ref: '#/components/schemas/zaraz_api-response-common' - properties: result: type: string example: Config has been published successfully security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/settings/zaraz/workflow: get: tags: - Zaraz summary: Get Zaraz workflow description: Gets Zaraz workflow for a zone. operationId: get-zones-zone_identifier-zaraz-workflow parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zaraz_identifier' responses: 4XX: description: Get Zaraz workflow response failure content: application/json: schema: $ref: '#/components/schemas/zaraz_api-response-common-failure' "200": description: Get Zaraz workflow response content: application/json: schema: $ref: '#/components/schemas/zaraz_zaraz-workflow-response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Zaraz summary: Update Zaraz workflow description: Updates Zaraz workflow for a zone. operationId: put-zones-zone_identifier-zaraz-workflow parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zaraz_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/zaraz_zaraz-workflow' responses: 4XX: description: Update Zaraz workflow response failure content: application/json: schema: $ref: '#/components/schemas/zaraz_api-response-common-failure' "200": description: Update Zaraz workflow response content: application/json: schema: $ref: '#/components/schemas/zaraz_zaraz-workflow-response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/speed_api/availabilities: get: tags: - Observatory summary: Get quota and availability description: Retrieves quota for all plans, as well as the current zone quota. operationId: speed-get-availabilities parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/observatory_identifier' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/observatory_api-response-common-failure' "200": description: Page test availability content: application/json: schema: $ref: '#/components/schemas/observatory_availabilities-response' security: - api_email: [] api_key: [] /zones/{zone_id}/speed_api/pages: get: tags: - Observatory summary: List tested webpages description: Lists all webpages which have been tested. operationId: speed-list-pages parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/observatory_identifier' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/observatory_api-response-common-failure' "200": description: List of pages content: application/json: schema: $ref: '#/components/schemas/observatory_pages-response-collection' security: - api_email: [] api_key: [] /zones/{zone_id}/speed_api/pages/{url}/tests: delete: tags: - Observatory summary: Delete all page tests description: Deletes all tests for a specific webpage from a specific region. Deleted tests are still counted as part of the quota. operationId: speed-delete-tests parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/observatory_identifier' - name: url in: path required: true schema: $ref: '#/components/schemas/observatory_url' - name: region in: query schema: $ref: '#/components/schemas/observatory_region' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/observatory_api-response-common-failure' "200": description: Number of deleted tests content: application/json: schema: $ref: '#/components/schemas/observatory_count-response' security: - api_email: [] api_key: [] get: tags: - Observatory summary: List page test history description: Test history (list of tests) for a specific webpage. operationId: speed-list-test-history parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/observatory_identifier' - name: url in: path required: true schema: $ref: '#/components/schemas/observatory_url' - name: page in: query schema: type: integer example: 1 - name: per_page in: query schema: type: integer example: 20 minimum: 5 maximum: 50 - name: region in: query schema: $ref: '#/components/schemas/observatory_region' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/observatory_api-response-common-failure' "200": description: List of test history for a page content: application/json: schema: $ref: '#/components/schemas/observatory_page-test-response-collection' security: - api_email: [] api_key: [] post: tags: - Observatory summary: Start page test description: Starts a test for a specific webpage, in a specific region. operationId: speed-create-test parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/observatory_identifier' - name: url in: path required: true schema: $ref: '#/components/schemas/observatory_url' requestBody: content: application/json: schema: type: object properties: region: $ref: '#/components/schemas/observatory_region' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/observatory_api-response-common-failure' "200": description: Page test details content: application/json: schema: $ref: '#/components/schemas/observatory_page-test-response-single' security: - api_email: [] api_key: [] /zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}: get: tags: - Observatory summary: Get a page test result description: Retrieves the result of a specific test. operationId: speed-get-test parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/observatory_identifier' - name: url in: path required: true schema: $ref: '#/components/schemas/observatory_url' - name: test_id in: path required: true schema: type: string responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/observatory_api-response-common-failure' "200": description: Page test result content: application/json: schema: $ref: '#/components/schemas/observatory_page-test-response-single' security: - api_email: [] api_key: [] /zones/{zone_id}/speed_api/pages/{url}/trend: get: tags: - Observatory summary: List core web vital metrics trend description: Lists the core web vital metrics trend over time for a specific page. operationId: speed-list-page-trend parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/observatory_identifier' - name: url in: path required: true schema: $ref: '#/components/schemas/observatory_url' - name: region in: query required: true schema: $ref: '#/components/schemas/observatory_region' - name: deviceType in: query required: true schema: $ref: '#/components/schemas/observatory_device_type' - name: start in: query required: true schema: $ref: '#/components/schemas/observatory_timestamp' - name: end in: query schema: $ref: '#/components/schemas/observatory_timestamp' - name: tz in: query description: The timezone of the start and end timestamps. required: true schema: type: string example: America/Chicago - name: metrics in: query description: A comma-separated list of metrics to include in the results. required: true schema: type: string example: performanceScore,ttfb,fcp,si,lcp,tti,tbt,cls responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/observatory_api-response-common-failure' "200": description: Page trend content: application/json: schema: $ref: '#/components/schemas/observatory_trend-response' security: - api_email: [] api_key: [] /zones/{zone_id}/speed_api/schedule/{url}: delete: tags: - Observatory summary: Delete scheduled page test description: Deletes a scheduled test for a page. operationId: speed-delete-test-schedule parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/observatory_identifier' - name: url in: path required: true schema: $ref: '#/components/schemas/observatory_url' - name: region in: query schema: $ref: '#/components/schemas/observatory_region' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/observatory_api-response-common-failure' "200": description: Number of deleted tests content: application/json: schema: $ref: '#/components/schemas/observatory_count-response' security: - api_email: [] api_key: [] get: tags: - Observatory summary: Get a page test schedule description: Retrieves the test schedule for a page in a specific region. operationId: speed-get-scheduled-test parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/observatory_identifier' - name: url in: path required: true schema: $ref: '#/components/schemas/observatory_url' - name: region in: query schema: $ref: '#/components/schemas/observatory_region' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/observatory_api-response-common-failure' "200": description: Page test schedule content: application/json: schema: $ref: '#/components/schemas/observatory_schedule-response-single' security: - api_email: [] api_key: [] post: tags: - Observatory summary: Create scheduled page test description: Creates a scheduled test for a page. operationId: speed-create-scheduled-test parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/observatory_identifier' - name: url in: path required: true schema: $ref: '#/components/schemas/observatory_url' - name: region in: query schema: $ref: '#/components/schemas/observatory_region' responses: 4XX: description: Failure response content: application/json: schema: $ref: '#/components/schemas/observatory_api-response-common-failure' "200": description: Page test schedule content: application/json: schema: $ref: '#/components/schemas/observatory_create-schedule-response' security: - api_email: [] api_key: [] /zones/{zone_id}/ssl/analyze: post: tags: - Analyze Certificate summary: Analyze Certificate description: Returns the set of hostnames, the signature algorithm, and the expiration date of the certificate. operationId: analyze-certificate-analyze-certificate parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object properties: bundle_method: $ref: '#/components/schemas/tls-certificates-and-hostnames_bundle_method' certificate: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate' responses: 4XX: description: Analyze Certificate response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_analyze_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Analyze Certificate response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_analyze_response' security: - api_email: [] api_key: [] /zones/{zone_id}/ssl/certificate_packs: get: tags: - Certificate Packs summary: List Certificate Packs description: For a given zone, list all active certificate packs. operationId: certificate-packs-list-certificate-packs parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: status in: query schema: description: Include Certificate Packs of all statuses, not just active ones. enum: - all example: all responses: 4XX: description: List Certificate Packs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_pack_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: List Certificate Packs response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_pack_response_collection' security: - api_email: [] api_key: [] /zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}: delete: tags: - Certificate Packs summary: Delete Advanced Certificate Manager Certificate Pack description: For a given zone, delete an advanced certificate pack. operationId: certificate-packs-delete-advanced-certificate-manager-certificate-pack parameters: - name: certificate_pack_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Advanced Certificate Manager Certificate Pack response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_delete_advanced_certificate_pack_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Delete Advanced Certificate Manager Certificate Pack response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_delete_advanced_certificate_pack_response_single' security: - api_email: [] api_key: [] get: tags: - Certificate Packs summary: Get Certificate Pack description: For a given zone, get a certificate pack. operationId: certificate-packs-get-certificate-pack parameters: - name: certificate_pack_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Get Certificate Pack response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_pack_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Get Certificate Pack response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_pack_response_single' security: - api_email: [] api_key: [] patch: tags: - Certificate Packs summary: Restart Validation for Advanced Certificate Manager Certificate Pack description: For a given zone, restart validation for an advanced certificate pack. This is only a validation operation for a Certificate Pack in a validation_timed_out status. operationId: certificate-packs-restart-validation-for-advanced-certificate-manager-certificate-pack parameters: - name: certificate_pack_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Restart Validation for Advanced Certificate Manager Certificate Pack response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_certificate_pack_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Restart Validation for Advanced Certificate Manager Certificate Pack response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_certificate_pack_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/ssl/certificate_packs/order: post: tags: - Certificate Packs summary: Order Advanced Certificate Manager Certificate Pack description: For a given zone, order an advanced certificate pack. operationId: certificate-packs-order-advanced-certificate-manager-certificate-pack parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object required: - type - hosts - validation_method - validity_days - certificate_authority properties: certificate_authority: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_authority' cloudflare_branding: $ref: '#/components/schemas/tls-certificates-and-hostnames_cloudflare_branding' hosts: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hosts' type: $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_type' validation_method: $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_method' validity_days: $ref: '#/components/schemas/tls-certificates-and-hostnames_validity_days' responses: 4XX: description: Order Advanced Certificate Manager Certificate Pack response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_certificate_pack_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Order Advanced Certificate Manager Certificate Pack response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_certificate_pack_response_single' security: - api_email: [] api_key: [] /zones/{zone_id}/ssl/certificate_packs/quota: get: tags: - Certificate Packs summary: Get Certificate Pack Quotas description: For a given zone, list certificate pack quotas. operationId: certificate-packs-get-certificate-pack-quotas parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Get Certificate Pack Quotas response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_pack_quota_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Get Certificate Pack Quotas response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_pack_quota_response' security: - api_email: [] api_key: [] /zones/{zone_id}/ssl/universal/settings: get: tags: - Universal SSL Settings for a Zone summary: Universal SSL Settings Details description: Get Universal SSL Settings for a Zone. operationId: universal-ssl-settings-for-a-zone-universal-ssl-settings-details parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: description: Universal SSL Settings Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_universal_settings_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Universal SSL Settings Details response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_universal_settings_response' security: - api_email: [] api_key: [] patch: tags: - Universal SSL Settings for a Zone summary: Edit Universal SSL Settings description: Patch Universal SSL Settings for a Zone. operationId: universal-ssl-settings-for-a-zone-edit-universal-ssl-settings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_universal' responses: 4XX: description: Edit Universal SSL Settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_universal_settings_response' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Edit Universal SSL Settings response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_universal_settings_response' security: - api_email: [] api_key: [] /zones/{zone_id}/ssl/verification: get: tags: - SSL Verification summary: SSL Verification Details description: Get SSL Verification Info for a Zone. operationId: ssl-verification-ssl-verification-details parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: retry in: query schema: description: Immediately retry SSL Verification. enum: - true example: true responses: 4XX: description: SSL Verification Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_verification_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: SSL Verification Details response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_verification_response_collection' security: - api_email: [] api_key: [] /zones/{zone_id}/ssl/verification/{certificate_pack_id}: patch: tags: - SSL Verification summary: Edit SSL Certificate Pack Validation Method description: Edit SSL validation method for a certificate pack. A PATCH request will request an immediate validation check on any certificate, and return the updated status. If a validation method is provided, the validation will be immediately attempted using that method. operationId: ssl-verification-edit-ssl-certificate-pack-validation-method parameters: - name: certificate_pack_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_cert_pack_uuid' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-validation_method' responses: 4XX: description: Edit SSL Certificate Pack Validation Method response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_validation_method_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' "200": description: Edit SSL Certificate Pack Validation Method response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_validation_method_response_collection' security: - api_email: [] api_key: [] /zones/{zone_id}/url_normalization: get: tags: - URL Normalization summary: Get URL normalization settings description: Fetches the current URL normalization settings. operationId: url-normalization-get-url-normalization-settings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_identifier' responses: 4XX: description: Get URL normalization settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/rulesets_schemas-response_model' - $ref: '#/components/schemas/rulesets_api-response-common-failure' "200": description: Get URL normalization settings response content: application/json: schema: $ref: '#/components/schemas/rulesets_schemas-response_model' security: - api_email: [] api_key: [] put: tags: - URL Normalization summary: Update URL normalization settings description: Updates the URL normalization settings. operationId: url-normalization-update-url-normalization-settings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/rulesets_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/rulesets_schemas-request_model' responses: 4XX: description: Update URL normalization settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/rulesets_schemas-response_model' - $ref: '#/components/schemas/rulesets_api-response-common-failure' "200": description: Update URL normalization settings response content: application/json: schema: $ref: '#/components/schemas/rulesets_schemas-response_model' security: - api_email: [] api_key: [] /zones/{zone_id}/waiting_rooms: get: tags: - Waiting Room summary: List waiting rooms description: Lists waiting rooms. operationId: waiting-room-list-waiting-rooms parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' - $ref: '#/components/parameters/waitingroom_page' - $ref: '#/components/parameters/waitingroom_per_page' responses: 4XX: description: List waiting rooms response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_response_collection' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: List waiting rooms response content: application/json: schema: $ref: '#/components/schemas/waitingroom_response_collection' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Waiting Room summary: Create waiting room description: Creates a new waiting room. operationId: waiting-room-create-waiting-room parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/waitingroom_query_waitingroom' responses: 4XX: description: Create waiting room response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_single_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Create waiting room response content: application/json: schema: $ref: '#/components/schemas/waitingroom_single_response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/waiting_rooms/{waiting_room_id}: delete: tags: - Waiting Room summary: Delete waiting room description: Deletes a waiting room. operationId: waiting-room-delete-waiting-room parameters: - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete waiting room response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_waiting_room_id_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Delete waiting room response content: application/json: schema: $ref: '#/components/schemas/waitingroom_waiting_room_id_response' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Waiting Room summary: Waiting room details description: Fetches a single configured waiting room. operationId: waiting-room-waiting-room-details parameters: - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' responses: 4XX: description: Waiting room details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_single_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Waiting room details response content: application/json: schema: $ref: '#/components/schemas/waitingroom_single_response' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Waiting Room summary: Patch waiting room description: Patches a configured waiting room. operationId: waiting-room-patch-waiting-room parameters: - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/waitingroom_query_waitingroom' responses: 4XX: description: Patch waiting room response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_single_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Patch waiting room response content: application/json: schema: $ref: '#/components/schemas/waitingroom_single_response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Waiting Room summary: Update waiting room description: Updates a configured waiting room. operationId: waiting-room-update-waiting-room parameters: - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/waitingroom_query_waitingroom' responses: 4XX: description: Update waiting room response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_single_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Update waiting room response content: application/json: schema: $ref: '#/components/schemas/waitingroom_single_response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events: get: tags: - Waiting Room summary: List events description: Lists events for a waiting room. operationId: waiting-room-list-events parameters: - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' - $ref: '#/components/parameters/waitingroom_page' - $ref: '#/components/parameters/waitingroom_per_page' responses: 4XX: description: List events response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_event_response_collection' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: List events response content: application/json: schema: $ref: '#/components/schemas/waitingroom_event_response_collection' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Waiting Room summary: Create event description: Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time. operationId: waiting-room-create-event parameters: - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/waitingroom_query_event' responses: 4XX: description: Create event response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_event_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Create event response content: application/json: schema: $ref: '#/components/schemas/waitingroom_event_response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}: delete: tags: - Waiting Room summary: Delete event description: Deletes an event for a waiting room. operationId: waiting-room-delete-event parameters: - name: event_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_event_id' - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete event response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_event_id_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Delete event response content: application/json: schema: $ref: '#/components/schemas/waitingroom_event_id_response' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Waiting Room summary: Event details description: Fetches a single configured event for a waiting room. operationId: waiting-room-event-details parameters: - name: event_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_event_id' - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' responses: 4XX: description: Event details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_event_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Event details response content: application/json: schema: $ref: '#/components/schemas/waitingroom_event_response' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Waiting Room summary: Patch event description: Patches a configured event for a waiting room. operationId: waiting-room-patch-event parameters: - name: event_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_event_id' - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/waitingroom_query_event' responses: 4XX: description: Patch event response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_event_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Patch event response content: application/json: schema: $ref: '#/components/schemas/waitingroom_event_response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Waiting Room summary: Update event description: Updates a configured event for a waiting room. operationId: waiting-room-update-event parameters: - name: event_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_event_id' - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/waitingroom_query_event' responses: 4XX: description: Update event response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_event_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Update event response content: application/json: schema: $ref: '#/components/schemas/waitingroom_event_response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}/details: get: tags: - Waiting Room summary: Preview active event details description: Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values. operationId: waiting-room-preview-active-event-details parameters: - name: event_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_event_id' - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' responses: 4XX: description: Preview active event details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_event_details_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Preview active event details response content: application/json: schema: $ref: '#/components/schemas/waitingroom_event_details_response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules: get: tags: - Waiting Room summary: List Waiting Room Rules description: Lists rules for a waiting room. operationId: waiting-room-list-waiting-room-rules parameters: - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' responses: 4XX: description: List Waiting Room Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_rules_response_collection' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: List Waiting Room Rules response content: application/json: schema: $ref: '#/components/schemas/waitingroom_rules_response_collection' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Waiting Room summary: Create Waiting Room Rule description: Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room. operationId: waiting-room-create-waiting-room-rule parameters: - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/waitingroom_create_rule' responses: 4XX: description: Create Waiting Room Rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_rules_response_collection' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Create Waiting Room Rule response content: application/json: schema: $ref: '#/components/schemas/waitingroom_rules_response_collection' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Waiting Room summary: Replace Waiting Room Rules description: Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room. operationId: waiting-room-replace-waiting-room-rules parameters: - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/waitingroom_update_rules' responses: 4XX: description: Replace Waiting Room Rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_rules_response_collection' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Replace Waiting Room Rules response content: application/json: schema: $ref: '#/components/schemas/waitingroom_rules_response_collection' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}: delete: tags: - Waiting Room summary: Delete Waiting Room Rule description: Deletes a rule for a waiting room. operationId: waiting-room-delete-waiting-room-rule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_rule_id' - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Waiting Room Rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_rules_response_collection' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Delete Waiting Room Rule response content: application/json: schema: $ref: '#/components/schemas/waitingroom_rules_response_collection' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Waiting Room summary: Patch Waiting Room Rule description: Patches a rule for a waiting room. operationId: waiting-room-patch-waiting-room-rule parameters: - name: rule_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_rule_id' - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/waitingroom_patch_rule' responses: 4XX: description: Patch Waiting Room Rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_rules_response_collection' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Patch Waiting Room Rule response content: application/json: schema: $ref: '#/components/schemas/waitingroom_rules_response_collection' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/waiting_rooms/{waiting_room_id}/status: get: tags: - Waiting Room summary: Get waiting room status description: "Fetches the status of a configured waiting room. Response fields include:\n1. `status`: String indicating the status of the waiting room. The possible status are:\n\t- **not_queueing** indicates that the configured thresholds have not been met and all users are going through to the origin.\n\t- **queueing** indicates that the thresholds have been met and some users are held in the waiting room.\n\t- **event_prequeueing** indicates that an event is active and is currently prequeueing users before it starts.\n2. `event_id`: String of the current event's `id` if an event is active, otherwise an empty string.\n3. `estimated_queued_users`: Integer of the estimated number of users currently waiting in the queue.\n4. `estimated_total_active_users`: Integer of the estimated number of users currently active on the origin.\n5. `max_estimated_time_minutes`: Integer of the maximum estimated time currently presented to the users." operationId: waiting-room-get-waiting-room-status parameters: - name: waiting_room_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_waiting_room_id' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' responses: 4XX: description: Get waiting room status response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_status_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Get waiting room status response content: application/json: schema: $ref: '#/components/schemas/waitingroom_status_response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/waiting_rooms/preview: post: tags: - Waiting Room summary: Create a custom waiting room page preview description: "Creates a waiting room page preview. Upload a custom waiting room page for preview. You will receive a preview URL in the form `http://waitingrooms.dev/preview/`. You can use the following query parameters to change the state of the preview:\n1. `force_queue`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll).\n2. `queue_is_full`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n3. `queueing_method`: The queueing method currently used by the waiting room.\n\t- **fifo** indicates a FIFO queue.\n\t- **random** indicates a Random queue.\n\t- **passthrough** indicates a Passthrough queue. Keep in mind that the waiting room page will only be displayed if `force_queue=true` or `event=prequeueing` — for other cases the request will pass through to the origin. For our preview, this will be a fake origin website returning \"Welcome\". \n\t- **reject** indicates a Reject queue.\n4. `event`: Used to preview a waiting room event.\n\t- **none** indicates no event is occurring.\n\t- **prequeueing** indicates that an event is prequeueing (between `prequeue_start_time` and `event_start_time`).\n\t- **started** indicates that an event has started (between `event_start_time` and `event_end_time`).\n5. `shuffle_at_event_start`: Boolean indicating if the event will shuffle users in the prequeue when it starts. This can only be set to **true** if an event is active (`event` is not **none**).\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/?force_queue=false&queue_is_full=false&queueing_method=random&event=started&shuffle_at_event_start=true`\n6. `waitTime`: Non-zero, positive integer indicating the estimated wait time in minutes. The default value is 10 minutes.\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/?waitTime=50` to configure the estimated wait time as 50 minutes." operationId: waiting-room-create-a-custom-waiting-room-page-preview parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/waitingroom_query_preview' responses: 4XX: description: Create a custom waiting room page preview response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_preview_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: Create a custom waiting room page preview response content: application/json: schema: $ref: '#/components/schemas/waitingroom_preview_response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/waiting_rooms/settings: get: tags: - Waiting Room summary: Get zone-level Waiting Room settings operationId: waiting-room-get-zone-settings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' responses: 4XX: description: The current zone-level Waiting Room settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_zone_settings_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: The current zone-level Waiting Room settings content: application/json: schema: $ref: '#/components/schemas/waitingroom_zone_settings_response' security: - api_token: [] - api_email: [] api_key: [] patch: tags: - Waiting Room summary: Patch zone-level Waiting Room settings operationId: waiting-room-patch-zone-settings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/waitingroom_zone_settings' responses: 4XX: description: The zone-level Waiting Room settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_zone_settings_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: The updated zone-level Waiting Room settings content: application/json: schema: $ref: '#/components/schemas/waitingroom_zone_settings_response' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Waiting Room summary: Update zone-level Waiting Room settings operationId: waiting-room-update-zone-settings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/waitingroom_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/waitingroom_zone_settings' responses: 4XX: description: The zone-level Waiting Room settings response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/waitingroom_zone_settings_response' - $ref: '#/components/schemas/waitingroom_api-response-common-failure' "200": description: The updated zone-level Waiting Room settings content: application/json: schema: $ref: '#/components/schemas/waitingroom_zone_settings_response' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/workers/filters: get: tags: - Worker Filters (Deprecated) summary: List Filters operationId: worker-filters-(-deprecated)-list-filters parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: List Filters response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_filter-response-collection' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: List Filters response content: application/json: schema: $ref: '#/components/schemas/workers_filter-response-collection' deprecated: true security: - api_token: [] - api_email: [] api_key: [] post: tags: - Worker Filters (Deprecated) summary: Create Filter operationId: worker-filters-(-deprecated)-create-filter parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers_filter-no-id' responses: 4XX: description: Create Filter response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-single-id' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Create Filter response content: application/json: schema: $ref: '#/components/schemas/workers_api-response-single-id' deprecated: true security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/workers/filters/{filter_id}: delete: tags: - Worker Filters (Deprecated) summary: Delete Filter operationId: worker-filters-(-deprecated)-delete-filter parameters: - name: filter_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Filter response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-single-id' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Delete Filter response content: application/json: schema: $ref: '#/components/schemas/workers_api-response-single-id' deprecated: true security: - api_token: [] - api_email: [] api_key: [] put: tags: - Worker Filters (Deprecated) summary: Update Filter operationId: worker-filters-(-deprecated)-update-filter parameters: - name: filter_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers_filter-no-id' responses: 4XX: description: Update Filter response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_filter-response-single' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Update Filter response content: application/json: schema: $ref: '#/components/schemas/workers_filter-response-single' deprecated: true security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/workers/routes: get: tags: - Worker Routes summary: List Routes description: Returns routes for a zone. operationId: worker-routes-list-routes parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: List Routes response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_route-response-collection' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: List Routes response content: application/json: schema: $ref: '#/components/schemas/workers_route-response-collection' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Worker Routes summary: Create Route description: Creates a route that maps a URL pattern to a Worker. operationId: worker-routes-create-route parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers_route-no-id' responses: 4XX: description: Create Route response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-single' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Create Route response content: application/json: schema: $ref: '#/components/schemas/workers_api-response-single' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/workers/routes/{route_id}: delete: tags: - Worker Routes summary: Delete Route description: Deletes a route. operationId: worker-routes-delete-route parameters: - name: route_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Route response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-single' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Delete Route response content: application/json: schema: $ref: '#/components/schemas/workers_api-response-single' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Worker Routes summary: Get Route description: Returns information about a route, including URL pattern and Worker. operationId: worker-routes-get-route parameters: - name: route_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: Get Route response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_route-response-single' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Get Route response content: application/json: schema: $ref: '#/components/schemas/workers_route-response-single' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Worker Routes summary: Update Route description: Updates the URL pattern or Worker associated with a route. operationId: worker-routes-update-route parameters: - name: route_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/workers_route-no-id' responses: 4XX: description: Update Route response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_route-response-single' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Update Route response content: application/json: schema: $ref: '#/components/schemas/workers_route-response-single' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/workers/script: delete: tags: - Worker Script (Deprecated) summary: Delete Worker description: Delete your Worker. This call has no response body on a successful delete. operationId: worker-script-(-deprecated)-delete-worker parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Worker response failure. content: application/json: {} "200": description: Delete Worker response. content: application/json: {} deprecated: true security: - api_token: [] - api_email: [] api_key: [] get: tags: - Worker Script (Deprecated) summary: Download Worker description: Fetch raw script content for your worker. Note this is the original script content, not JSON encoded. operationId: worker-script-(-deprecated)-download-worker parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: Download Worker response failure content: undefined: schema: example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) }) "200": description: Download Worker response content: undefined: schema: example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) }) deprecated: true security: - api_token: [] - api_email: [] api_key: [] put: tags: - Worker Script (Deprecated) summary: Upload Worker description: Upload a worker, or a new version of a worker. operationId: worker-script-(-deprecated)-upload-worker parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: required: true content: application/javascript: schema: example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) }) responses: 4XX: description: Upload Worker response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_schemas-script-response-single' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: Upload Worker response content: application/json: schema: $ref: '#/components/schemas/workers_schemas-script-response-single' deprecated: true security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_id}/workers/script/bindings: get: tags: - Worker Binding (Deprecated) summary: List Bindings description: List the bindings for a Workers script. operationId: worker-binding-(-deprecated)-list-bindings parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: description: List Bindings response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/workers_api-response-common' - type: object properties: result: type: array items: $ref: '#/components/schemas/workers_schemas-binding' - $ref: '#/components/schemas/workers_api-response-common-failure' "200": description: List Bindings response content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_api-response-common' - type: object properties: result: type: array items: $ref: '#/components/schemas/workers_schemas-binding' deprecated: true security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_identifier}/analytics/colos: get: tags: - Zone Analytics (Deprecated) summary: Get analytics by Co-locations description: 'This view provides a breakdown of analytics data by datacenter. Note: This is available to Enterprise customers only.' operationId: zone-analytics-(-deprecated)-get-analytics-by-co-locations parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/data-zone-analytics-api_identifier' - name: until in: query schema: $ref: '#/components/schemas/data-zone-analytics-api_until' - name: since in: query schema: anyOf: - type: string - type: integer description: |- The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year. Ranges that the Cloudflare web application provides will provide the following period length for each point: - Last 60 minutes (from -59 to -1): 1 minute resolution - Last 7 hours (from -419 to -60): 15 minutes resolution - Last 15 hours (from -899 to -420): 30 minutes resolution - Last 72 hours (from -4320 to -900): 1 hour resolution - Older than 3 days (-525600 to -4320): 1 day resolution. default: -10080 example: "2015-01-01T12:23:00Z" - name: continuous in: query schema: type: boolean description: |- When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data. The API response _may not represent the requested time window_. default: true responses: 4XX: description: Get analytics by Co-locations response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_colo_response' - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure' "200": description: Get analytics by Co-locations response content: application/json: schema: $ref: '#/components/schemas/data-zone-analytics-api_colo_response' deprecated: true security: - api_email: [] api_key: [] api_token: [] /zones/{zone_identifier}/analytics/dashboard: get: tags: - Zone Analytics (Deprecated) summary: Get dashboard description: The dashboard view provides both totals and timeseries data for the given zone and time period across the entire Cloudflare network. operationId: zone-analytics-(-deprecated)-get-dashboard parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/data-zone-analytics-api_identifier' - name: until in: query schema: $ref: '#/components/schemas/data-zone-analytics-api_until' - name: since in: query schema: anyOf: - type: string - type: integer description: |- The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year. Ranges that the Cloudflare web application provides will provide the following period length for each point: - Last 60 minutes (from -59 to -1): 1 minute resolution - Last 7 hours (from -419 to -60): 15 minutes resolution - Last 15 hours (from -899 to -420): 30 minutes resolution - Last 72 hours (from -4320 to -900): 1 hour resolution - Older than 3 days (-525600 to -4320): 1 day resolution. default: -10080 example: "2015-01-01T12:23:00Z" - name: continuous in: query schema: type: boolean description: |- When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data. The API response _may not represent the requested time window_. default: true responses: 4XX: description: Get dashboard response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_dashboard_response' - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure' "200": description: Get dashboard response content: application/json: schema: $ref: '#/components/schemas/data-zone-analytics-api_dashboard_response' deprecated: true security: - api_email: [] api_key: [] api_token: [] /zones/{zone_identifier}/available_plans: get: tags: - Zone Rate Plan summary: List Available Plans description: Lists available plans the zone can subscribe to. operationId: zone-rate-plan-list-available-plans parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_identifier' responses: 4XX: description: List Available Plans response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/bill-subs-api_available-rate-plan' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' "200": description: List Available Plans response content: application/json: schema: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/bill-subs-api_available-rate-plan' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_identifier}/available_plans/{plan_identifier}: get: tags: - Zone Rate Plan summary: Available Plan Details description: Details of the available plan that the zone can subscribe to. operationId: zone-rate-plan-available-plan-details parameters: - name: plan_identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_identifier' responses: 4XX: description: Available Plan Details response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-single' - properties: result: $ref: '#/components/schemas/bill-subs-api_available-rate-plan' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' "200": description: Available Plan Details response content: application/json: schema: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-single' - properties: result: $ref: '#/components/schemas/bill-subs-api_available-rate-plan' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_identifier}/available_rate_plans: get: tags: - Zone Rate Plan summary: List Available Rate Plans description: Lists all rate plans the zone can subscribe to. operationId: zone-rate-plan-list-available-rate-plans parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/bill-subs-api_identifier' responses: 4XX: description: List Available Rate Plans response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/bill-subs-api_plan_response_collection' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' "200": description: List Available Rate Plans response content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_plan_response_collection' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_identifier}/custom_pages: get: tags: - Custom pages for a zone summary: List custom pages description: Fetches all the custom pages at the zone level. operationId: custom-pages-for-a-zone-list-custom-pages parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/custom-pages_identifier' responses: 4xx: description: List custom pages response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/custom-pages_custom_pages_response_collection' - $ref: '#/components/schemas/custom-pages_api-response-common-failure' "200": description: List custom pages response content: application/json: schema: $ref: '#/components/schemas/custom-pages_custom_pages_response_collection' security: - api_email: [] api_key: [] - api_token: [] /zones/{zone_identifier}/custom_pages/{identifier}: get: tags: - Custom pages for a zone summary: Get a custom page description: Fetches the details of a custom page. operationId: custom-pages-for-a-zone-get-a-custom-page parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/custom-pages_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/custom-pages_identifier' responses: 4xx: description: Get a custom page response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/custom-pages_custom_pages_response_single' - $ref: '#/components/schemas/custom-pages_api-response-common-failure' "200": description: Get a custom page response content: application/json: schema: $ref: '#/components/schemas/custom-pages_custom_pages_response_single' security: - api_email: [] api_key: [] - api_token: [] put: tags: - Custom pages for a zone summary: Update a custom page description: Updates the configuration of an existing custom page. operationId: custom-pages-for-a-zone-update-a-custom-page parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/custom-pages_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/custom-pages_identifier' requestBody: required: true content: application/json: schema: required: - url - state properties: state: $ref: '#/components/schemas/custom-pages_state' url: $ref: '#/components/schemas/custom-pages_url' responses: 4xx: description: Update a custom page response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/custom-pages_custom_pages_response_single' - $ref: '#/components/schemas/custom-pages_api-response-common-failure' "200": description: Update a custom page response content: application/json: schema: $ref: '#/components/schemas/custom-pages_custom_pages_response_single' security: - api_email: [] api_key: [] - api_token: [] /zones/{zone_identifier}/email/routing: get: tags: - Email Routing settings summary: Get Email Routing settings description: Get information about the settings for your Email Routing zone. operationId: email-routing-settings-get-email-routing-settings parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' responses: "200": description: Get Email Routing settings response content: application/json: schema: $ref: '#/components/schemas/email_email_settings_response_single' security: - api_email: [] api_key: [] /zones/{zone_identifier}/email/routing/disable: post: tags: - Email Routing settings summary: Disable Email Routing description: Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work. operationId: email-routing-settings-disable-email-routing parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' requestBody: required: true content: application/json: {} responses: "200": description: Disable Email Routing response content: application/json: schema: $ref: '#/components/schemas/email_email_settings_response_single' security: - api_email: [] api_key: [] /zones/{zone_identifier}/email/routing/dns: get: tags: - Email Routing settings summary: Email Routing - DNS settings description: Show the DNS records needed to configure your Email Routing zone. operationId: email-routing-settings-email-routing-dns-settings parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' responses: "200": description: Email Routing - DNS settings response content: application/json: schema: $ref: '#/components/schemas/email_dns_settings_response_collection' security: - api_email: [] api_key: [] /zones/{zone_identifier}/email/routing/enable: post: tags: - Email Routing settings summary: Enable Email Routing description: Enable you Email Routing zone. Add and lock the necessary MX and SPF records. operationId: email-routing-settings-enable-email-routing parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' requestBody: required: true content: application/json: {} responses: "200": description: Enable Email Routing response content: application/json: schema: $ref: '#/components/schemas/email_email_settings_response_single' security: - api_email: [] api_key: [] /zones/{zone_identifier}/email/routing/rules: get: tags: - Email Routing routing rules summary: List routing rules description: Lists existing routing rules. operationId: email-routing-routing-rules-list-routing-rules parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Maximum number of results per page. default: 20 minimum: 5 maximum: 50 - name: enabled in: query schema: type: boolean description: Filter by enabled routing rules. enum: - true - false example: true responses: "200": description: List routing rules response content: application/json: schema: $ref: '#/components/schemas/email_rules_response_collection' security: - api_email: [] api_key: [] post: tags: - Email Routing routing rules summary: Create routing rule description: Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address). operationId: email-routing-routing-rules-create-routing-rule parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/email_create_rule_properties' responses: "200": description: Create routing rule response content: application/json: schema: $ref: '#/components/schemas/email_rule_response_single' security: - api_email: [] api_key: [] /zones/{zone_identifier}/email/routing/rules/{rule_identifier}: delete: tags: - Email Routing routing rules summary: Delete routing rule description: Delete a specific routing rule. operationId: email-routing-routing-rules-delete-routing-rule parameters: - name: rule_identifier in: path required: true schema: $ref: '#/components/schemas/email_rule_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' responses: "200": description: Delete routing rule response content: application/json: schema: $ref: '#/components/schemas/email_rule_response_single' security: - api_email: [] api_key: [] get: tags: - Email Routing routing rules summary: Get routing rule description: Get information for a specific routing rule already created. operationId: email-routing-routing-rules-get-routing-rule parameters: - name: rule_identifier in: path required: true schema: $ref: '#/components/schemas/email_rule_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' responses: "200": description: Get routing rule response content: application/json: schema: $ref: '#/components/schemas/email_rule_response_single' security: - api_email: [] api_key: [] put: tags: - Email Routing routing rules summary: Update routing rule description: Update actions and matches, or enable/disable specific routing rules. operationId: email-routing-routing-rules-update-routing-rule parameters: - name: rule_identifier in: path required: true schema: $ref: '#/components/schemas/email_rule_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/email_update_rule_properties' responses: "200": description: Update routing rule response content: application/json: schema: $ref: '#/components/schemas/email_rule_response_single' security: - api_email: [] api_key: [] /zones/{zone_identifier}/email/routing/rules/catch_all: get: tags: - Email Routing routing rules summary: Get catch-all rule description: Get information on the default catch-all routing rule. operationId: email-routing-routing-rules-get-catch-all-rule parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' responses: "200": description: Get catch-all rule response content: application/json: schema: $ref: '#/components/schemas/email_catch_all_rule_response_single' security: - api_email: [] api_key: [] put: tags: - Email Routing routing rules summary: Update catch-all rule description: Enable or disable catch-all routing rule, or change action to forward to specific destination address. operationId: email-routing-routing-rules-update-catch-all-rule parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/email_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/email_update_catch_all_rule_properties' responses: "200": description: Update catch-all rule response content: application/json: schema: $ref: '#/components/schemas/email_catch_all_rule_response_single' security: - api_email: [] api_key: [] /zones/{zone_identifier}/filters: delete: tags: - Filters summary: Delete filters description: Deletes one or more existing filters. operationId: filters-delete-filters parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: type: object required: - id properties: id: $ref: '#/components/schemas/firewall_filters_components-schemas-id' responses: 4XX: description: Delete filters response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-delete-response-collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Delete filters response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-delete-response-collection' deprecated: true security: - api_email: [] api_key: [] get: tags: - Filters summary: List filters description: Fetches filters in a zone. You can filter the results using several optional parameters. operationId: filters-list-filters parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: paused in: query schema: $ref: '#/components/schemas/firewall_filters_components-schemas-paused' - name: expression in: query schema: type: string description: A case-insensitive string to find in the expression. example: php - name: description in: query schema: type: string description: A case-insensitive string to find in the description. example: browsers - name: ref in: query schema: type: string description: The filter ref (a short reference tag) to search for. Must be an exact match. example: FIL-100 - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of filters per page. default: 25 minimum: 5 maximum: 100 - name: id in: query schema: type: string description: The unique identifier of the filter. example: 372e67954025e0ba6aaa6d586b9e0b61 readOnly: true minLength: 32 maxLength: 32 responses: 4XX: description: List filters response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-response-collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List filters response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-response-collection' deprecated: true security: - api_email: [] api_key: [] post: tags: - Filters summary: Create filters description: Creates one or more filters. operationId: filters-create-filters parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - expression responses: 4XX: description: Create filters response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-response-collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Create filters response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-response-collection' deprecated: true security: - api_email: [] api_key: [] put: tags: - Filters summary: Update filters description: Updates one or more existing filters. operationId: filters-update-filters parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - id responses: 4XX: description: Update filters response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-response-collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update filters response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-response-collection' deprecated: true security: - api_email: [] api_key: [] /zones/{zone_identifier}/filters/{id}: delete: tags: - Filters summary: Delete a filter description: Deletes an existing filter. operationId: filters-delete-a-filter parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_filters_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a filter response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-delete-response-single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Delete a filter response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-delete-response-single' deprecated: true security: - api_email: [] api_key: [] get: tags: - Filters summary: Get a filter description: Fetches the details of a filter. operationId: filters-get-a-filter parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_filters_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' responses: 4XX: description: Get a filter response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-response-single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Get a filter response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-response-single' deprecated: true security: - api_email: [] api_key: [] put: tags: - Filters summary: Update a filter description: Updates an existing filter. operationId: filters-update-a-filter parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_filters_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - id responses: 4XX: description: Update a filter response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-response-single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update a filter response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-response-single' deprecated: true security: - api_email: [] api_key: [] /zones/{zone_identifier}/firewall/lockdowns: get: tags: - Zone Lockdown summary: List Zone Lockdown rules description: Fetches Zone Lockdown rules. You can filter the results using several optional parameters. operationId: zone-lockdown-list-zone-lockdown-rules parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: description in: query schema: $ref: '#/components/schemas/firewall_schemas-description_search' - name: modified_on in: query schema: $ref: '#/components/schemas/firewall_modified_on' - name: ip in: query schema: $ref: '#/components/schemas/firewall_ip_search' - name: priority in: query schema: $ref: '#/components/schemas/firewall_schemas-priority' - name: uri_search in: query schema: $ref: '#/components/schemas/firewall_uri_search' - name: ip_range_search in: query schema: $ref: '#/components/schemas/firewall_ip_range_search' - name: per_page in: query schema: type: number description: The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`. default: 20 minimum: 1 maximum: 1000 - name: created_on in: query schema: type: string format: date-time description: The timestamp of when the rule was created. example: "2014-01-01T05:20:00.12345Z" readOnly: true - name: description_search in: query schema: type: string description: A string to search for in the description of existing rules. example: endpoints - name: ip_search in: query schema: type: string description: A single IP address to search for in existing rules. example: 1.2.3.4 responses: 4XX: description: List Zone Lockdown rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_zonelockdown_response_collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List Zone Lockdown rules response content: application/json: schema: $ref: '#/components/schemas/firewall_zonelockdown_response_collection' security: - api_email: [] api_key: [] post: tags: - Zone Lockdown summary: Create a Zone Lockdown rule description: Creates a new Zone Lockdown rule. operationId: zone-lockdown-create-a-zone-lockdown-rule parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - urls - configurations responses: 4XX: description: Create a Zone Lockdown rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_zonelockdown_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Create a Zone Lockdown rule response content: application/json: schema: $ref: '#/components/schemas/firewall_zonelockdown_response_single' security: - api_email: [] api_key: [] /zones/{zone_identifier}/firewall/lockdowns/{id}: delete: tags: - Zone Lockdown summary: Delete a Zone Lockdown rule description: Deletes an existing Zone Lockdown rule. operationId: zone-lockdown-delete-a-zone-lockdown-rule parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_lockdowns_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a Zone Lockdown rule response failure content: application/json: schema: allOf: - type: object properties: result: properties: id: $ref: '#/components/schemas/firewall_lockdowns_components-schemas-id' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Delete a Zone Lockdown rule response content: application/json: schema: type: object properties: result: properties: id: $ref: '#/components/schemas/firewall_lockdowns_components-schemas-id' security: - api_email: [] api_key: [] get: tags: - Zone Lockdown summary: Get a Zone Lockdown rule description: Fetches the details of a Zone Lockdown rule. operationId: zone-lockdown-get-a-zone-lockdown-rule parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_lockdowns_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' responses: 4XX: description: Get a Zone Lockdown rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_zonelockdown_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Get a Zone Lockdown rule response content: application/json: schema: $ref: '#/components/schemas/firewall_zonelockdown_response_single' security: - api_email: [] api_key: [] put: tags: - Zone Lockdown summary: Update a Zone Lockdown rule description: Updates an existing Zone Lockdown rule. operationId: zone-lockdown-update-a-zone-lockdown-rule parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_lockdowns_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - urls - configurations responses: 4XX: description: Update a Zone Lockdown rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_zonelockdown_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update a Zone Lockdown rule response content: application/json: schema: $ref: '#/components/schemas/firewall_zonelockdown_response_single' security: - api_email: [] api_key: [] /zones/{zone_identifier}/firewall/rules: delete: tags: - Firewall rules summary: Delete firewall rules description: Deletes existing firewall rules. operationId: firewall-rules-delete-firewall-rules parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: type: object required: - id properties: id: $ref: '#/components/schemas/firewall_firewall-rules_components-schemas-id' responses: 4XX: description: Delete firewall rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-rules-response-collection-delete' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Delete firewall rules response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-rules-response-collection-delete' deprecated: true security: - api_email: [] api_key: [] get: tags: - Firewall rules summary: List firewall rules description: Fetches firewall rules in a zone. You can filter the results using several optional parameters. operationId: firewall-rules-list-firewall-rules parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: description in: query schema: type: string description: A case-insensitive string to find in the description. example: mir - name: action in: query schema: type: string description: The action to search for. Must be an exact match. example: block - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: Number of firewall rules per page. default: 25 minimum: 5 maximum: 100 - name: id in: query schema: type: string description: The unique identifier of the firewall rule. example: 372e67954025e0ba6aaa6d586b9e0b60 readOnly: true maxLength: 32 - name: paused in: query schema: type: boolean description: When true, indicates that the firewall rule is currently paused. example: false responses: 4XX: description: List firewall rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-rules-response-collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List firewall rules response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-rules-response-collection' deprecated: true security: - api_email: [] api_key: [] patch: tags: - Firewall rules summary: Update priority of firewall rules description: Updates the priority of existing firewall rules. operationId: firewall-rules-update-priority-of-firewall-rules parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - id responses: 4XX: description: Update priority of firewall rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-rules-response-collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update priority of firewall rules response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-rules-response-collection' deprecated: true security: - api_email: [] api_key: [] post: tags: - Firewall rules summary: Create firewall rules description: Create one or more firewall rules. operationId: firewall-rules-create-firewall-rules parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - filter - action responses: 4XX: description: Create firewall rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-rules-response-collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Create firewall rules response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-rules-response-collection' deprecated: true security: - api_email: [] api_key: [] put: tags: - Firewall rules summary: Update firewall rules description: Updates one or more existing firewall rules. operationId: firewall-rules-update-firewall-rules parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - id responses: 4XX: description: Update firewall rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-rules-response-collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update firewall rules response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-rules-response-collection' deprecated: true security: - api_email: [] api_key: [] /zones/{zone_identifier}/firewall/rules/{id}: delete: tags: - Firewall rules summary: Delete a firewall rule description: Deletes an existing firewall rule. operationId: firewall-rules-delete-a-firewall-rule parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_firewall-rules_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: type: object properties: delete_filter_if_unused: $ref: '#/components/schemas/firewall_delete_filter_if_unused' responses: 4XX: description: Delete a firewall rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-rules-single-response-delete' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Delete a firewall rule response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-rules-single-response-delete' deprecated: true security: - api_email: [] api_key: [] get: tags: - Firewall rules summary: Get a firewall rule description: Fetches the details of a firewall rule. operationId: firewall-rules-get-a-firewall-rule parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_firewall-rules_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: id in: query schema: $ref: '#/components/schemas/firewall_firewall-rules_components-schemas-id' responses: 4XX: description: Get a firewall rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-rules-single-response' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Get a firewall rule response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-rules-single-response' deprecated: true security: - api_email: [] api_key: [] patch: tags: - Firewall rules summary: Update priority of a firewall rule description: Updates the priority of an existing firewall rule. operationId: firewall-rules-update-priority-of-a-firewall-rule parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_firewall-rules_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - id responses: 4XX: description: Update priority of a firewall rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-rules-response-collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update priority of a firewall rule response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-rules-response-collection' deprecated: true security: - api_email: [] api_key: [] put: tags: - Firewall rules summary: Update a firewall rule description: Updates an existing firewall rule. operationId: firewall-rules-update-a-firewall-rule parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_firewall-rules_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - id - filter - action responses: 4XX: description: Update a firewall rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_filter-rules-single-response' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update a firewall rule response content: application/json: schema: $ref: '#/components/schemas/firewall_filter-rules-single-response' deprecated: true security: - api_email: [] api_key: [] /zones/{zone_identifier}/firewall/ua_rules: get: tags: - User Agent Blocking rules summary: List User Agent Blocking rules description: Fetches User Agent Blocking rules in a zone. You can filter the results using several optional parameters. operationId: user-agent-blocking-rules-list-user-agent-blocking-rules parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: page in: query schema: type: number description: Page number of paginated results. default: 1 minimum: 1 - name: description in: query schema: $ref: '#/components/schemas/firewall_description_search' - name: description_search in: query schema: $ref: '#/components/schemas/firewall_description_search' - name: per_page in: query schema: type: number description: The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`. default: 20 minimum: 1 maximum: 1000 - name: ua_search in: query schema: type: string description: A string to search for in the user agent values of existing rules. example: Safari responses: 4XX: description: List User Agent Blocking rules response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_firewalluablock_response_collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List User Agent Blocking rules response content: application/json: schema: $ref: '#/components/schemas/firewall_firewalluablock_response_collection' security: - api_email: [] api_key: [] post: tags: - User Agent Blocking rules summary: Create a User Agent Blocking rule description: Creates a new User Agent Blocking rule in a zone. operationId: user-agent-blocking-rules-create-a-user-agent-blocking-rule parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - mode - configuration responses: 4XX: description: Create a User Agent Blocking rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_firewalluablock_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Create a User Agent Blocking rule response content: application/json: schema: $ref: '#/components/schemas/firewall_firewalluablock_response_single' security: - api_email: [] api_key: [] /zones/{zone_identifier}/firewall/ua_rules/{id}: delete: tags: - User Agent Blocking rules summary: Delete a User Agent Blocking rule description: Deletes an existing User Agent Blocking rule. operationId: user-agent-blocking-rules-delete-a-user-agent-blocking-rule parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a User Agent Blocking rule response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/firewall_firewalluablock_response_single' - type: object properties: result: properties: id: $ref: '#/components/schemas/firewall_components-schemas-id' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Delete a User Agent Blocking rule response content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_firewalluablock_response_single' - type: object properties: result: properties: id: $ref: '#/components/schemas/firewall_components-schemas-id' security: - api_email: [] api_key: [] get: tags: - User Agent Blocking rules summary: Get a User Agent Blocking rule description: Fetches the details of a User Agent Blocking rule. operationId: user-agent-blocking-rules-get-a-user-agent-blocking-rule parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' responses: 4XX: description: Get a User Agent Blocking rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_firewalluablock_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Get a User Agent Blocking rule response content: application/json: schema: $ref: '#/components/schemas/firewall_firewalluablock_response_single' security: - api_email: [] api_key: [] put: tags: - User Agent Blocking rules summary: Update a User Agent Blocking rule description: Updates an existing User Agent Blocking rule. operationId: user-agent-blocking-rules-update-a-user-agent-blocking-rule parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_components-schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - id - mode - configuration responses: 4XX: description: Update a User Agent Blocking rule response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_firewalluablock_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update a User Agent Blocking rule response content: application/json: schema: $ref: '#/components/schemas/firewall_firewalluablock_response_single' security: - api_email: [] api_key: [] /zones/{zone_identifier}/firewall/waf/overrides: get: tags: - WAF overrides summary: List WAF overrides description: |- Fetches the URI-based WAF overrides in a zone. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-overrides-list-waf-overrides parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: page in: query schema: type: number description: The page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: The number of WAF overrides per page. default: 50 minimum: 5 maximum: 100 responses: 4XX: description: List WAF overrides response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_override_response_collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List WAF overrides response content: application/json: schema: $ref: '#/components/schemas/firewall_override_response_collection' deprecated: true security: - api_email: [] api_key: [] post: tags: - WAF overrides summary: Create a WAF override description: |- Creates a URI-based WAF override for a zone. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-overrides-create-a-waf-override parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - urls responses: 4XX: description: Create a WAF override response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_override_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Create a WAF override response content: application/json: schema: $ref: '#/components/schemas/firewall_override_response_single' deprecated: true security: - api_email: [] api_key: [] /zones/{zone_identifier}/firewall/waf/overrides/{id}: delete: tags: - WAF overrides summary: Delete a WAF override description: |- Deletes an existing URI-based WAF override. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-overrides-delete-a-waf-override parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a WAF override response failure content: application/json: schema: allOf: - type: object properties: result: properties: id: $ref: '#/components/schemas/firewall_schemas-id' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Delete a WAF override response content: application/json: schema: type: object properties: result: properties: id: $ref: '#/components/schemas/firewall_schemas-id' deprecated: true security: - api_email: [] api_key: [] get: tags: - WAF overrides summary: Get a WAF override description: |- Fetches the details of a URI-based WAF override. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-overrides-get-a-waf-override parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' responses: 4XX: description: Get a WAF override response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_override_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Get a WAF override response content: application/json: schema: $ref: '#/components/schemas/firewall_override_response_single' deprecated: true security: - api_email: [] api_key: [] put: tags: - WAF overrides summary: Update WAF override description: |- Updates an existing URI-based WAF override. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-overrides-update-waf-override parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_schemas-id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - id - urls - rules - rewrite_action responses: 4XX: description: Update WAF override response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_override_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update WAF override response content: application/json: schema: $ref: '#/components/schemas/firewall_override_response_single' deprecated: true security: - api_email: [] api_key: [] /zones/{zone_identifier}/firewall/waf/packages: get: tags: - WAF packages summary: List WAF packages description: |- Fetches WAF packages for a zone. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-packages-list-waf-packages parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: page in: query schema: type: number description: The page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: The number of packages per page. default: 50 minimum: 5 maximum: 100 - name: order in: query schema: type: string description: The field used to sort returned packages. enum: - name example: status - name: direction in: query schema: type: string description: The direction used to sort returned packages. enum: - asc - desc example: desc - name: match in: query schema: type: string description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match. enum: - any - all default: all - name: name in: query schema: type: string description: The name of the WAF package. example: USER readOnly: true responses: 4XX: description: List WAF packages response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_package_response_collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List WAF packages response content: application/json: schema: $ref: '#/components/schemas/firewall_package_response_collection' deprecated: true security: - api_email: [] api_key: [] /zones/{zone_identifier}/firewall/waf/packages/{identifier}: get: tags: - WAF packages summary: Get a WAF package description: |- Fetches the details of a WAF package. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-packages-get-a-waf-package parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' responses: 4XX: description: Get a WAF package response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_package_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Get a WAF package response content: application/json: schema: $ref: '#/components/schemas/firewall_package_response_single' deprecated: true security: - api_email: [] api_key: [] patch: tags: - WAF packages summary: Update a WAF package description: |- Updates a WAF package. You can update the sensitivity and the action of an anomaly detection WAF package. **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/). operationId: waf-packages-update-a-waf-package parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: type: object properties: action_mode: $ref: '#/components/schemas/firewall_action_mode' sensitivity: $ref: '#/components/schemas/firewall_sensitivity' responses: 4XX: description: Update a WAF package response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/firewall_package_response_single' - properties: result: $ref: '#/components/schemas/firewall_anomaly_package' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update a WAF package response content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_package_response_single' - properties: result: $ref: '#/components/schemas/firewall_anomaly_package' deprecated: true security: - api_email: [] api_key: [] /zones/{zone_identifier}/logs/control/retention/flag: get: tags: - Logs Received summary: Get log retention flag description: Gets log retention flag for Logpull API. operationId: logs-received-get-log-retention-flag parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/data-zone-analytics-api_identifier' responses: 4XX: description: Get log retention flag response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_flag_response' - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure' "200": description: Get log retention flag response content: application/json: schema: $ref: '#/components/schemas/data-zone-analytics-api_flag_response' security: - api_email: [] api_key: [] api_token: [] post: tags: - Logs Received summary: Update log retention flag description: Updates log retention flag for Logpull API. operationId: logs-received-update-log-retention-flag parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/data-zone-analytics-api_identifier' requestBody: required: true content: application/json: schema: type: object required: - flag properties: flag: $ref: '#/components/schemas/data-zone-analytics-api_flag' responses: 4XX: description: Update log retention flag response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_flag_response' - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure' "200": description: Update log retention flag response content: application/json: schema: $ref: '#/components/schemas/data-zone-analytics-api_flag_response' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_identifier}/logs/rayids/{ray_identifier}: get: tags: - Logs Received summary: Get logs RayIDs description: The `/rayids` api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique). operationId: logs-received-get-logs-ray-i-ds parameters: - name: ray_identifier in: path required: true schema: $ref: '#/components/schemas/data-zone-analytics-api_ray_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/data-zone-analytics-api_identifier' - name: timestamps in: query schema: $ref: '#/components/schemas/data-zone-analytics-api_timestamps' - name: fields in: query schema: type: string description: 'The `/received` route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. Most customers require only a small subset of fields, but that subset varies from customer to customer; 2. Flat schema is much easier to work with downstream (importing into BigTable etc); 3. Performance (time to process, file size). If `?fields=` is not specified, default field set is returned. This default field set may change at any time. When `?fields=` is provided, each record is returned with the specified fields. `fields` must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified does not matter, and the order of fields in the response is not specified.' example: ClientIP,RayID,EdgeStartTimestamp responses: 4XX: description: Get logs RayIDs response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_logs' - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure' "200": description: Get logs RayIDs response content: application/json: schema: $ref: '#/components/schemas/data-zone-analytics-api_logs' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_identifier}/logs/received: get: tags: - Logs Received summary: Get logs received description: 'The `/received` api route allows customers to retrieve their edge HTTP logs. The basic access pattern is "give me all the logs for zone Z for minute M", where the minute M refers to the time records were received at Cloudflare''s central data center. `start` is inclusive, and `end` is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: `start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z`, then `start=2018-05-20T10:01:00Z&end=2018-05-20T10:02:00Z` and so on; the overlap will be handled properly.' operationId: logs-received-get-logs-received parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/data-zone-analytics-api_identifier' - name: end in: query required: true schema: $ref: '#/components/schemas/data-zone-analytics-api_end' - name: sample in: query schema: $ref: '#/components/schemas/data-zone-analytics-api_sample' - name: timestamps in: query schema: $ref: '#/components/schemas/data-zone-analytics-api_timestamps' - name: count in: query schema: type: integer description: When `?count=` is provided, the response will contain up to `count` results. Since results are not sorted, you are likely to get different data for repeated requests. `count` must be an integer > 0. minimum: 1 - name: fields in: query schema: type: string description: 'The `/received` route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. Most customers require only a small subset of fields, but that subset varies from customer to customer; 2. Flat schema is much easier to work with downstream (importing into BigTable etc); 3. Performance (time to process, file size). If `?fields=` is not specified, default field set is returned. This default field set may change at any time. When `?fields=` is provided, each record is returned with the specified fields. `fields` must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified does not matter, and the order of fields in the response is not specified.' example: ClientIP,RayID,EdgeStartTimestamp - name: start in: query schema: anyOf: - type: string - type: integer description: Sets the (inclusive) beginning of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than seven days. example: "2018-05-20T10:00:00Z" responses: 4XX: description: Get logs received response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_logs' - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure' "200": description: Get logs received response content: application/json: schema: $ref: '#/components/schemas/data-zone-analytics-api_logs' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_identifier}/logs/received/fields: get: tags: - Logs Received summary: List fields description: Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions. operationId: logs-received-list-fields parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/data-zone-analytics-api_identifier' responses: 4XX: description: List fields response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/data-zone-analytics-api_fields_response' - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure' "200": description: List fields response content: application/json: schema: $ref: '#/components/schemas/data-zone-analytics-api_fields_response' security: - api_email: [] api_key: [] api_token: [] /zones/{zone_identifier}/rate_limits: get: tags: - Rate limits for a zone summary: List rate limits description: Fetches the rate limits for a zone. operationId: rate-limits-for-a-zone-list-rate-limits parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' - name: page in: query schema: type: number description: The page number of paginated results. default: 1 minimum: 1 - name: per_page in: query schema: type: number description: The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`. default: 20 minimum: 1 maximum: 1000 responses: 4XX: description: List rate limits response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_ratelimit_response_collection' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: List rate limits response content: application/json: schema: $ref: '#/components/schemas/firewall_ratelimit_response_collection' deprecated: true security: - api_email: [] api_key: [] post: tags: - Rate limits for a zone summary: Create a rate limit description: Creates a new rate limit for a zone. Refer to the object definition for a list of required attributes. operationId: rate-limits-for-a-zone-create-a-rate-limit parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - match - threshold - period - action responses: 4XX: description: Create a rate limit response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_ratelimit_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Create a rate limit response content: application/json: schema: $ref: '#/components/schemas/firewall_ratelimit_response_single' deprecated: true security: - api_email: [] api_key: [] /zones/{zone_identifier}/rate_limits/{id}: delete: tags: - Rate limits for a zone summary: Delete a rate limit description: Deletes an existing rate limit. operationId: rate-limits-for-a-zone-delete-a-rate-limit parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete a rate limit response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/firewall_ratelimit_response_single' - type: object properties: result: properties: id: $ref: '#/components/schemas/firewall_id' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Delete a rate limit response content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_ratelimit_response_single' - type: object properties: result: properties: id: $ref: '#/components/schemas/firewall_id' deprecated: true security: - api_email: [] api_key: [] get: tags: - Rate limits for a zone summary: Get a rate limit description: Fetches the details of a rate limit. operationId: rate-limits-for-a-zone-get-a-rate-limit parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' responses: 4XX: description: Get a rate limit response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_ratelimit_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Get a rate limit response content: application/json: schema: $ref: '#/components/schemas/firewall_ratelimit_response_single' deprecated: true security: - api_email: [] api_key: [] put: tags: - Rate limits for a zone summary: Update a rate limit description: Updates an existing rate limit. operationId: rate-limits-for-a-zone-update-a-rate-limit parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/firewall_id' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/firewall_identifier' requestBody: required: true content: application/json: schema: required: - id - match - threshold - period - action responses: 4XX: description: Update a rate limit response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/firewall_ratelimit_response_single' - $ref: '#/components/schemas/firewall_api-response-common-failure' "200": description: Update a rate limit response content: application/json: schema: $ref: '#/components/schemas/firewall_ratelimit_response_single' deprecated: true security: - api_email: [] api_key: [] /zones/{zone_identifier}/snippets: get: tags: - Zone Snippets summary: All Snippets operationId: zone-snippets parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/snippets-api_identifier' responses: 4XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' 5XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' "200": description: Snippets response content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common' - type: object properties: result: type: array description: List of all zone snippets items: $ref: '#/components/schemas/snippets-api_snippet' type: object security: - api_email: [] api_key: [] /zones/{zone_identifier}/snippets/{snippet_name}: delete: tags: - Zone Snippets summary: Delete Snippet operationId: zone-snippets-snippet-delete parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/snippets-api_identifier' - name: snippet_name in: path required: true schema: $ref: '#/components/schemas/snippets-api_snippet_name' responses: 4XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' 5XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' "200": description: Snippet response content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common' type: object security: - api_email: [] api_key: [] get: tags: - Zone Snippets summary: Snippet operationId: zone-snippets-snippet parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/snippets-api_identifier' - name: snippet_name in: path required: true schema: $ref: '#/components/schemas/snippets-api_snippet_name' responses: 4XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' 5XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' "200": description: Snippet response content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common' - type: object properties: result: $ref: '#/components/schemas/snippets-api_snippet' type: object security: - api_email: [] api_key: [] put: tags: - Zone Snippets summary: Put Snippet operationId: zone-snippets-snippet-put parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/snippets-api_identifier' - name: snippet_name in: path required: true schema: $ref: '#/components/schemas/snippets-api_snippet_name' requestBody: content: multipart/form-data: schema: type: object properties: files: type: string description: Content files of uploaded snippet example: export { async function fetch(request, env) {return new Response('some_response') } } metadata: type: object properties: main_module: type: string description: Main module name of uploaded snippet example: main.js responses: 4XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' 5XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' "200": description: Snippet response content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common' - type: object properties: result: $ref: '#/components/schemas/snippets-api_snippet' type: object security: - api_email: [] api_key: [] /zones/{zone_identifier}/snippets/{snippet_name}/content: get: tags: - Zone Snippets summary: Snippet Content operationId: zone-snippets-snippet-content parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/snippets-api_identifier' - name: snippet_name in: path required: true schema: $ref: '#/components/schemas/snippets-api_snippet_name' responses: 4XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' 5XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' "200": description: Snippet response content: multipart/form-data: schema: properties: files: type: string description: Content files of uploaded snippet example: export { async function fetch(request, env) {return new Response('some_response') } } security: - api_email: [] api_key: [] /zones/{zone_identifier}/snippets/snippet_rules: get: tags: - Zone Snippets summary: Rules operationId: zone-snippets-snippet-rules parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/snippets-api_identifier' responses: 4XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' 5XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' "200": description: Snippets rules response content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common' - type: object properties: result: $ref: '#/components/schemas/snippets-api_rules' type: object security: - api_email: [] api_key: [] put: tags: - Zone Snippets summary: Put Rules operationId: zone-snippets-snippet-rules-put parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/snippets-api_identifier' requestBody: content: application/json: schema: type: object properties: rules: $ref: '#/components/schemas/snippets-api_rules' responses: 4XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' 5XX: description: Snippet response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common-failure' "200": description: Snippets rules response content: application/json: schema: allOf: - $ref: '#/components/schemas/snippets-api_api-response-common' - type: object properties: result: $ref: '#/components/schemas/snippets-api_rules' type: object security: - api_email: [] api_key: [] /zones/{zone_identifier}/ssl/recommendation: get: tags: - SSL/TLS Mode Recommendation summary: SSL/TLS Recommendation description: Retrieve the SSL/TLS Recommender's recommendation for a zone. operationId: ssl/-tls-mode-recommendation-ssl/-tls-recommendation parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/legacy-jhs_identifier' responses: 4XX: description: SSL/TLS Recommendation response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/legacy-jhs_api-response-single' - properties: result: properties: id: $ref: '#/components/schemas/legacy-jhs_id' modified_on: $ref: '#/components/schemas/legacy-jhs_timestamp' value: $ref: '#/components/schemas/legacy-jhs_value' - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure' "200": description: SSL/TLS Recommendation response content: application/json: schema: allOf: - $ref: '#/components/schemas/legacy-jhs_api-response-single' - properties: result: properties: id: $ref: '#/components/schemas/legacy-jhs_id' modified_on: $ref: '#/components/schemas/legacy-jhs_timestamp' value: $ref: '#/components/schemas/legacy-jhs_value' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone_identifier}/web3/hostnames: get: tags: - Web3 Hostname summary: List Web3 Hostnames operationId: web3-hostname-list-web3-hostnames parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' responses: 5XX: description: List Web3 Hostnames response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dweb-config_collection_response' - $ref: '#/components/schemas/dweb-config_api-response-common-failure' "200": description: List Web3 Hostnames response content: application/json: schema: $ref: '#/components/schemas/dweb-config_collection_response' security: - api_email: [] api_key: [] post: tags: - Web3 Hostname summary: Create Web3 Hostname operationId: web3-hostname-create-web3-hostname parameters: - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dweb-config_create_request' responses: 5XX: description: Create Web3 Hostname response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dweb-config_single_response' - $ref: '#/components/schemas/dweb-config_api-response-common-failure' "200": description: Create Web3 Hostname response content: application/json: schema: $ref: '#/components/schemas/dweb-config_single_response' security: - api_email: [] api_key: [] /zones/{zone_identifier}/web3/hostnames/{identifier}: delete: tags: - Web3 Hostname summary: Delete Web3 Hostname operationId: web3-hostname-delete-web3-hostname parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' requestBody: required: true content: application/json: {} responses: 5XX: description: Delete Web3 Hostname response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dweb-config_api-response-single-id' - $ref: '#/components/schemas/dweb-config_api-response-common-failure' "200": description: Delete Web3 Hostname response content: application/json: schema: $ref: '#/components/schemas/dweb-config_api-response-single-id' security: - api_email: [] api_key: [] get: tags: - Web3 Hostname summary: Web3 Hostname Details operationId: web3-hostname-web3-hostname-details parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' responses: 5XX: description: Web3 Hostname Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dweb-config_single_response' - $ref: '#/components/schemas/dweb-config_api-response-common-failure' "200": description: Web3 Hostname Details response content: application/json: schema: $ref: '#/components/schemas/dweb-config_single_response' security: - api_email: [] api_key: [] patch: tags: - Web3 Hostname summary: Edit Web3 Hostname operationId: web3-hostname-edit-web3-hostname parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dweb-config_modify_request' responses: 5XX: description: Edit Web3 Hostname response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dweb-config_single_response' - $ref: '#/components/schemas/dweb-config_api-response-common-failure' "200": description: Edit Web3 Hostname response content: application/json: schema: $ref: '#/components/schemas/dweb-config_single_response' security: - api_email: [] api_key: [] /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list: get: tags: - Web3 Hostname summary: IPFS Universal Path Gateway Content List Details operationId: web3-hostname-ipfs-universal-path-gateway-content-list-details parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' responses: 5XX: description: IPFS Universal Path Gateway Content List Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dweb-config_content_list_details_response' - $ref: '#/components/schemas/dweb-config_api-response-common-failure' "200": description: IPFS Universal Path Gateway Content List Details response content: application/json: schema: $ref: '#/components/schemas/dweb-config_content_list_details_response' security: - api_email: [] api_key: [] put: tags: - Web3 Hostname summary: Update IPFS Universal Path Gateway Content List operationId: web3-hostname-update-ipfs-universal-path-gateway-content-list parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dweb-config_content_list_update_request' responses: 5XX: description: Update IPFS Universal Path Gateway Content List response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dweb-config_content_list_details_response' - $ref: '#/components/schemas/dweb-config_api-response-common-failure' "200": description: Update IPFS Universal Path Gateway Content List response content: application/json: schema: $ref: '#/components/schemas/dweb-config_content_list_details_response' security: - api_email: [] api_key: [] /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries: get: tags: - Web3 Hostname summary: List IPFS Universal Path Gateway Content List Entries operationId: web3-hostname-list-ipfs-universal-path-gateway-content-list-entries parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' responses: 5XX: description: List IPFS Universal Path Gateway Content List Entries response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dweb-config_content_list_entry_collection_response' - $ref: '#/components/schemas/dweb-config_api-response-common-failure' "200": description: List IPFS Universal Path Gateway Content List Entries response content: application/json: schema: $ref: '#/components/schemas/dweb-config_content_list_entry_collection_response' security: - api_email: [] api_key: [] post: tags: - Web3 Hostname summary: Create IPFS Universal Path Gateway Content List Entry operationId: web3-hostname-create-ipfs-universal-path-gateway-content-list-entry parameters: - name: identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dweb-config_content_list_entry_create_request' responses: 5XX: description: Create IPFS Universal Path Gateway Content List Entry response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dweb-config_content_list_entry_single_response' - $ref: '#/components/schemas/dweb-config_api-response-common-failure' "200": description: Create IPFS Universal Path Gateway Content List Entry response content: application/json: schema: $ref: '#/components/schemas/dweb-config_content_list_entry_single_response' security: - api_email: [] api_key: [] /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}: delete: tags: - Web3 Hostname summary: Delete IPFS Universal Path Gateway Content List Entry operationId: web3-hostname-delete-ipfs-universal-path-gateway-content-list-entry parameters: - name: content_list_entry_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' requestBody: required: true content: application/json: {} responses: 5XX: description: Delete IPFS Universal Path Gateway Content List Entry response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dweb-config_api-response-single-id' - $ref: '#/components/schemas/dweb-config_api-response-common-failure' "200": description: Delete IPFS Universal Path Gateway Content List Entry response content: application/json: schema: $ref: '#/components/schemas/dweb-config_api-response-single-id' security: - api_email: [] api_key: [] get: tags: - Web3 Hostname summary: IPFS Universal Path Gateway Content List Entry Details operationId: web3-hostname-ipfs-universal-path-gateway-content-list-entry-details parameters: - name: content_list_entry_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' responses: 5XX: description: IPFS Universal Path Gateway Content List Entry Details response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dweb-config_content_list_entry_single_response' - $ref: '#/components/schemas/dweb-config_api-response-common-failure' "200": description: IPFS Universal Path Gateway Content List Entry Details response content: application/json: schema: $ref: '#/components/schemas/dweb-config_content_list_entry_single_response' security: - api_email: [] api_key: [] put: tags: - Web3 Hostname summary: Edit IPFS Universal Path Gateway Content List Entry operationId: web3-hostname-edit-ipfs-universal-path-gateway-content-list-entry parameters: - name: content_list_entry_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' - name: zone_identifier in: path required: true schema: $ref: '#/components/schemas/dweb-config_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/dweb-config_content_list_entry_create_request' responses: 5XX: description: Edit IPFS Universal Path Gateway Content List Entry response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/dweb-config_content_list_entry_single_response' - $ref: '#/components/schemas/dweb-config_api-response-common-failure' "200": description: Edit IPFS Universal Path Gateway Content List Entry response content: application/json: schema: $ref: '#/components/schemas/dweb-config_content_list_entry_single_response' security: - api_email: [] api_key: [] /zones/{zone}/spectrum/analytics/aggregate/current: get: tags: - Spectrum Aggregate Analytics summary: Get current aggregated analytics description: Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone. operationId: spectrum-aggregate-analytics-get-current-aggregated-analytics parameters: - name: zone in: path required: true schema: $ref: '#/components/schemas/legacy-jhs_identifier' - name: appID in: query schema: $ref: '#/components/schemas/legacy-jhs_app_id_param' - name: app_id_param in: query schema: $ref: '#/components/schemas/legacy-jhs_app_id_param' - name: colo_name in: query schema: type: string description: Co-location identifier. example: PDX maxLength: 3 responses: 4XX: description: Get current aggregated analytics response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/legacy-jhs_schemas-response_collection' - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure' "200": description: Get current aggregated analytics response content: application/json: schema: $ref: '#/components/schemas/legacy-jhs_schemas-response_collection' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone}/spectrum/analytics/events/bytime: get: tags: - Spectrum Analytics (By Time) summary: Get analytics by time description: Retrieves a list of aggregate metrics grouped by time interval. operationId: spectrum-analytics-(-by-time)-get-analytics-by-time parameters: - name: zone in: path required: true schema: $ref: '#/components/schemas/legacy-jhs_identifier' - name: dimensions in: query schema: $ref: '#/components/schemas/legacy-jhs_dimensions' - name: sort in: query schema: $ref: '#/components/schemas/legacy-jhs_sort' - name: until in: query schema: $ref: '#/components/schemas/legacy-jhs_until' - name: metrics in: query schema: type: array description: "One or more metrics to compute. Options are: \n\nMetric | Name | Example | Unit\n--------------------------|-------------------------------------|--------------------------|--------------------------\ncount \ | Count of total events | 1000 | Count\nbytesIngress | Sum of ingress bytes | 1000 | Sum\nbytesEgress | Sum of egress bytes | 1000 | Sum\ndurationAvg | Average connection duration | 1.0 | Time in milliseconds\ndurationMedian | Median connection duration \ | 1.0 | Time in milliseconds\nduration90th \ | 90th percentile connection duration | 1.0 | Time in milliseconds\nduration99th | 99th percentile connection duration | 1.0 | Time in milliseconds." example: - count - bytesIngress items: type: string enum: - count - bytesIngress - bytesEgress - durationAvg - durationMedian - duration90th - duration99th - name: filters in: query schema: type: string description: "Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: \n\nOperator | Name | URL Encoded\n--------------------------|---------------------------------|--------------------------\n== \ | Equals | %3D%3D\n!= \ | Does not equals | !%3D\n> | Greater Than | %3E\n< | Less Than | %3C\n>= | Greater than or equal to | %3E%3D\n<= | Less than or equal to | %3C%3D ." example: event==disconnect%20AND%20coloName!=SFO - name: since in: query schema: type: string format: date-time description: Start of time interval to query, defaults to `until` - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified. example: "2014-01-02T02:20:00Z" - name: time_delta in: query schema: type: string description: Used to select time series resolution. enum: - year - quarter - month - week - day - hour - dekaminute - minute example: minute responses: 4XX: description: Get analytics by time response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/legacy-jhs_api-response-single' - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure' "200": description: Get analytics by time response content: application/json: schema: $ref: '#/components/schemas/legacy-jhs_api-response-single' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone}/spectrum/analytics/events/summary: get: tags: - Spectrum Analytics (Summary) summary: Get analytics summary description: Retrieves a list of summarised aggregate metrics over a given time period. operationId: spectrum-analytics-(-summary)-get-analytics-summary parameters: - name: zone in: path required: true schema: $ref: '#/components/schemas/legacy-jhs_identifier' - name: dimensions in: query schema: $ref: '#/components/schemas/legacy-jhs_dimensions' - name: sort in: query schema: $ref: '#/components/schemas/legacy-jhs_sort' - name: until in: query schema: $ref: '#/components/schemas/legacy-jhs_until' - name: metrics in: query schema: type: array description: "One or more metrics to compute. Options are: \n\nMetric | Name | Example | Unit\n--------------------------|-------------------------------------|--------------------------|--------------------------\ncount \ | Count of total events | 1000 | Count\nbytesIngress | Sum of ingress bytes | 1000 | Sum\nbytesEgress | Sum of egress bytes | 1000 | Sum\ndurationAvg | Average connection duration | 1.0 | Time in milliseconds\ndurationMedian | Median connection duration \ | 1.0 | Time in milliseconds\nduration90th \ | 90th percentile connection duration | 1.0 | Time in milliseconds\nduration99th | 99th percentile connection duration | 1.0 | Time in milliseconds." example: - count - bytesIngress items: type: string enum: - count - bytesIngress - bytesEgress - durationAvg - durationMedian - duration90th - duration99th - name: filters in: query schema: type: string description: "Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: \n\nOperator | Name | URL Encoded\n--------------------------|---------------------------------|--------------------------\n== \ | Equals | %3D%3D\n!= \ | Does not equals | !%3D\n> | Greater Than | %3E\n< | Less Than | %3C\n>= | Greater than or equal to | %3E%3D\n<= | Less than or equal to | %3C%3D ." example: event==disconnect%20AND%20coloName!=SFO - name: since in: query schema: type: string format: date-time description: Start of time interval to query, defaults to `until` - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified. example: "2014-01-02T02:20:00Z" responses: 4XX: description: Get analytics summary response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/legacy-jhs_api-response-single' - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure' "200": description: Get analytics summary response content: application/json: schema: $ref: '#/components/schemas/legacy-jhs_api-response-single' security: - api_email: [] api_key: [] /zones/{zone}/spectrum/apps: get: tags: - Spectrum Applications summary: List Spectrum applications description: Retrieves a list of currently existing Spectrum applications inside a zone. operationId: spectrum-applications-list-spectrum-applications parameters: - name: zone in: path required: true schema: $ref: '#/components/schemas/legacy-jhs_identifier' - name: page in: query schema: type: number description: Page number of paginated results. This parameter is required in order to use other pagination parameters. If included in the query, `result_info` will be present in the response. example: 1 minimum: 1 - name: per_page in: query schema: type: number description: Sets the maximum number of results per page. default: 20 minimum: 1 maximum: 100 - name: direction in: query schema: type: string description: Sets the direction by which results are ordered. enum: - asc - desc default: asc example: desc - name: order in: query schema: type: string description: Application field by which results are ordered. enum: - protocol - app_id - created_on - modified_on - dns default: dns example: protocol responses: 4XX: description: List Spectrum applications response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/legacy-jhs_response_collection' - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure' "200": description: List Spectrum applications response content: application/json: schema: $ref: '#/components/schemas/legacy-jhs_response_collection' security: - api_token: [] - api_email: [] api_key: [] post: tags: - Spectrum Applications summary: Create Spectrum application using a name for the origin description: Creates a new Spectrum application from a configuration using a name for the origin. operationId: spectrum-applications-create-spectrum-application-using-a-name-for-the-origin parameters: - name: zone in: path required: true schema: $ref: '#/components/schemas/legacy-jhs_identifier' requestBody: required: true content: application/json: schema: type: object required: - protocol - dns - origin_dns - origin_port properties: argo_smart_routing: $ref: '#/components/schemas/legacy-jhs_argo_smart_routing' dns: $ref: '#/components/schemas/legacy-jhs_dns' edge_ips: $ref: '#/components/schemas/legacy-jhs_edge_ips' ip_firewall: $ref: '#/components/schemas/legacy-jhs_ip_firewall' origin_dns: $ref: '#/components/schemas/legacy-jhs_origin_dns' origin_port: $ref: '#/components/schemas/legacy-jhs_origin_port' protocol: $ref: '#/components/schemas/legacy-jhs_protocol' proxy_protocol: $ref: '#/components/schemas/legacy-jhs_proxy_protocol' tls: $ref: '#/components/schemas/legacy-jhs_tls' traffic_type: $ref: '#/components/schemas/legacy-jhs_traffic_type' responses: 4XX: description: Create Spectrum application using a name for the origin response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/legacy-jhs_response_single_origin_dns' - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure' "200": description: Create Spectrum application using a name for the origin response content: application/json: schema: $ref: '#/components/schemas/legacy-jhs_response_single_origin_dns' security: - api_token: [] - api_email: [] api_key: [] /zones/{zone}/spectrum/apps/{app_id}: delete: tags: - Spectrum Applications summary: Delete Spectrum application description: Deletes a previously existing application. operationId: spectrum-applications-delete-spectrum-application parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/legacy-jhs_app_id' - name: zone in: path required: true schema: $ref: '#/components/schemas/legacy-jhs_identifier' requestBody: required: true content: application/json: {} responses: 4XX: description: Delete Spectrum application response failure content: application/json: schema: allOf: - allOf: - $ref: '#/components/schemas/legacy-jhs_api-response-single' - type: object properties: result: type: object properties: id: $ref: '#/components/schemas/legacy-jhs_app_id' - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure' "200": description: Delete Spectrum application response content: application/json: schema: allOf: - $ref: '#/components/schemas/legacy-jhs_api-response-single' - type: object properties: result: type: object properties: id: $ref: '#/components/schemas/legacy-jhs_app_id' security: - api_token: [] - api_email: [] api_key: [] get: tags: - Spectrum Applications summary: Get Spectrum application configuration description: Gets the application configuration of a specific application inside a zone. operationId: spectrum-applications-get-spectrum-application-configuration parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/legacy-jhs_app_id' - name: zone in: path required: true schema: $ref: '#/components/schemas/legacy-jhs_identifier' responses: 4XX: description: Get Spectrum application configuration response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/legacy-jhs_response_single' - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure' "200": description: Get Spectrum application configuration response content: application/json: schema: $ref: '#/components/schemas/legacy-jhs_response_single' security: - api_token: [] - api_email: [] api_key: [] put: tags: - Spectrum Applications summary: Update Spectrum application configuration using a name for the origin description: Updates a previously existing application's configuration that uses a name for the origin. operationId: spectrum-applications-update-spectrum-application-configuration-using-a-name-for-the-origin parameters: - name: app_id in: path required: true schema: $ref: '#/components/schemas/legacy-jhs_app_id' - name: zone in: path required: true schema: $ref: '#/components/schemas/legacy-jhs_identifier' requestBody: required: true content: application/json: schema: type: object required: - protocol - dns - origin_dns - origin_port properties: argo_smart_routing: $ref: '#/components/schemas/legacy-jhs_argo_smart_routing' dns: $ref: '#/components/schemas/legacy-jhs_dns' edge_ips: $ref: '#/components/schemas/legacy-jhs_edge_ips' ip_firewall: $ref: '#/components/schemas/legacy-jhs_ip_firewall' origin_dns: $ref: '#/components/schemas/legacy-jhs_origin_dns' origin_port: $ref: '#/components/schemas/legacy-jhs_origin_port' protocol: $ref: '#/components/schemas/legacy-jhs_protocol' proxy_protocol: $ref: '#/components/schemas/legacy-jhs_proxy_protocol' tls: $ref: '#/components/schemas/legacy-jhs_tls' traffic_type: $ref: '#/components/schemas/legacy-jhs_traffic_type' responses: 4XX: description: Update Spectrum application configuration using a name for the origin response failure content: application/json: schema: allOf: - $ref: '#/components/schemas/legacy-jhs_response_single_origin_dns' - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure' "200": description: Update Spectrum application configuration using a name for the origin response content: application/json: schema: $ref: '#/components/schemas/legacy-jhs_response_single_origin_dns' security: - api_token: [] - api_email: [] api_key: [] security: - api_email: [] api_key: [] - api_token: [] - user_service_key: [] servers: - url: https://api.cloudflare.com/client/v4 description: Client API