openapi: 3.2.0 info: description: Welcome to Cloudflare's API documentation site. license: name: BSD-3-Clause url: https://opensource.org/licenses/BSD-3-Clause title: Cloudflare Zone Settings API version: 4.0.0 servers: - description: Client API url: https://api.cloudflare.com/client/v4 security: - api_email: [] api_key: [] - api_token: [] - user_service_key: [] tags: - name: Zone Settings paths: /zones/{zone_id}/settings: get: operationId: zone-settings-get-all-zone-settings summary: Get all zone settings description: Available settings for your user in relation to a zone. parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' responses: '200': description: Get all Zone settings response content: application/json: schema: $ref: '#/components/schemas/zones_zone_settings_response_collection' 4XX: description: Get all Zone settings response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure-3' deprecated: true security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: deprecated x-fern-sdk-group-name: zones.settings x-fern-sdk-method-name: list x-forge-sunset: date: '2030-01-01T00:00:00Z' x-stainless-deprecation-message: This endpoint is deprecated. Zone settings should instead be managed individually. patch: operationId: zone-settings-edit-zone-settings-info summary: Edit multiple zone settings description: Edit settings for a zone. parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/zones_multiple_settings' responses: '200': description: Edit zone settings info response content: application/json: schema: $ref: '#/components/schemas/zones_zone_settings_response_collection' 4XX: description: Edit zone settings info response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure-3' deprecated: true security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: deprecated x-fern-sdk-group-name: zones.settings x-fern-sdk-method-name: bulk-edit x-forge-sunset: date: '2030-01-01T00:00:00Z' x-stainless-deprecation-message: This endpoint is deprecated. Zone settings should instead be managed individually. /zones/{zone_id}/settings/aegis: get: operationId: zone-cache-settings-get-aegis-setting summary: Get aegis setting description: Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses. parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache-settings_identifier' responses: '200': description: Get aegis setting response. content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/cache-settings_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache-settings_aegis_response_value' 4XX: description: Get aegis setting response failure. content: application/json: schema: $ref: '#/components/schemas/cache-settings_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read - Zone Read - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: business: false enterprise: true free: false pro: false x-fern-availability: generally-available x-fern-sdk-group-name: zones.aegis x-fern-sdk-method-name: get x-forge-hidden: true patch: operationId: zone-cache-settings-change-aegis-setting summary: Change aegis setting description: Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses. parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache-settings_identifier' requestBody: required: true content: application/json: schema: type: object properties: value: $ref: '#/components/schemas/cache-settings_aegis_value' required: - value responses: '200': description: Change aegis setting response. content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/cache-settings_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache-settings_aegis_response_value' 4XX: description: Change aegis setting response failure. content: application/json: schema: $ref: '#/components/schemas/cache-settings_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: business: false enterprise: true free: false pro: false x-fern-availability: generally-available x-fern-sdk-group-name: zones.aegis x-fern-sdk-method-name: edit x-forge-hidden: true /zones/{zone_id}/settings/automatic_platform_optimization: get: operationId: zone-settings-get-automatic-platform-optimization-setting summary: Get Automatic Platform Optimization setting description: 'Automatic Platform Optimization (APO) for WordPress is a performance feature that serves your WordPress site from Cloudflare''s edge network, reducing load times for visitors. Refer to the APO documentation for more information.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' responses: '200': description: Get Automatic Platform Optimization setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_automatic_platform_optimization_response' type: object 4XX: description: Get Automatic Platform Optimization setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true free: false pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.automatic-platform-optimization x-fern-sdk-method-name: get patch: operationId: zone-settings-change-automatic-platform-optimization-setting summary: Change Automatic Platform Optimization setting description: 'Automatic Platform Optimization (APO) for WordPress is a performance feature that serves your WordPress site from Cloudflare''s edge network, reducing load times for visitors. Refer to the APO documentation for more information.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' requestBody: required: true content: application/json: schema: type: object properties: value: $ref: '#/components/schemas/speed_automatic_platform_optimization_value' required: - value responses: '200': description: Change Automatic Platform Optimization setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_automatic_platform_optimization_response' type: object 4XX: description: Change Automatic Platform Optimization setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: business: true enterprise: true free: false pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.automatic-platform-optimization x-fern-sdk-method-name: edit /zones/{zone_id}/settings/binary_ast: get: operationId: zone-settings-get-binary-ast-setting summary: Get Binary AST setting description: 'Binary AST is a new binary encoding for JavaScript that enables faster parsing of scripts. When enabled, Cloudflare will serve a binary-encoded version of JavaScript to compatible browsers.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' responses: '200': description: Get Binary AST setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_binary_ast_response' type: object 4XX: description: Get Binary AST setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.binary-ast x-fern-sdk-method-name: get patch: operationId: zone-settings-change-binary-ast-setting summary: Change Binary AST setting description: 'Binary AST is a new binary encoding for JavaScript that enables faster parsing of scripts. When enabled, Cloudflare will serve a binary-encoded version of JavaScript to compatible browsers.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' requestBody: required: true content: application/json: schema: type: object properties: value: $ref: '#/components/schemas/speed_binary_ast_value' required: - value responses: '200': description: Change Binary AST setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_binary_ast_response' type: object 4XX: description: Change Binary AST setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.binary-ast x-fern-sdk-method-name: edit /zones/{zone_id}/settings/fonts: get: operationId: zone-settings-get-fonts-setting 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.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' responses: '200': description: Get Cloudflare Fonts setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_cloudflare_fonts' type: object 4XX: description: Get Cloudflare Fonts setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.fonts x-fern-sdk-method-name: get patch: operationId: zone-settings-change-fonts-setting 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.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' requestBody: required: true content: application/json: schema: type: object properties: value: $ref: '#/components/schemas/speed_cloudflare_fonts_value' required: - value responses: '200': description: Change Cloudflare Fonts setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_cloudflare_fonts' type: object 4XX: description: Change Cloudflare Fonts setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.fonts x-fern-sdk-method-name: edit /zones/{zone_id}/settings/h2_prioritization: get: operationId: zone-settings-get-h2-prioritization-setting summary: Get HTTP/2 Prioritization setting description: 'HTTP/2 Prioritization controls the order in which assets are delivered to browsers. Cloudflare''s HTTP/2 Prioritization overrides the default browser prioritization order, improving the loading performance of web pages.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' responses: '200': description: Get HTTP/2 Prioritization setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_h2_prioritization_response' type: object 4XX: description: Get HTTP/2 Prioritization setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true free: false pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.h2-prioritization x-fern-sdk-method-name: get patch: operationId: zone-settings-change-h2-prioritization-setting summary: Change HTTP/2 Prioritization setting description: 'HTTP/2 Prioritization controls the order in which assets are delivered to browsers. Cloudflare''s HTTP/2 Prioritization overrides the default browser prioritization order, improving the loading performance of web pages.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' requestBody: required: true content: application/json: schema: type: object properties: value: $ref: '#/components/schemas/speed_h2_prioritization_value' required: - value responses: '200': description: Change HTTP/2 Prioritization setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_h2_prioritization_response' type: object 4XX: description: Change HTTP/2 Prioritization setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: business: true enterprise: true free: false pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.h2-prioritization x-fern-sdk-method-name: edit /zones/{zone_id}/settings/image_resizing: get: operationId: zone-settings-get-image-resizing-setting summary: Get Image Transformations setting description: Gets the Image Transformations setting for a zone. Accepted values are `off`, `on`, `open`, and `latest`. parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' responses: '200': description: Get Image Resizing setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_image_resizing_response' type: object 4XX: description: Get Image Resizing setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.image-resizing x-fern-sdk-method-name: get patch: operationId: zone-settings-change-image-resizing-setting summary: Change Image Transformations setting description: Sets the Image Transformations setting for a zone. Accepted values are `off`, `on`, `open`, and `latest`. parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' requestBody: required: true content: application/json: schema: type: object properties: value: $ref: '#/components/schemas/speed_image_resizing_value' required: - value responses: '200': description: Change Image Resizing setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_image_resizing_response' type: object 4XX: description: Change Image Resizing setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.image-resizing x-fern-sdk-method-name: edit /zones/{zone_id}/settings/origin_h2_max_streams: get: operationId: zone-cache-settings-get-origin-h2-max-streams-setting summary: Get Origin H2 Max Streams Setting description: Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled. parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache-settings_identifier' responses: '200': description: Get Origin H2 Max Streams setting response. content: application/json: examples: origin_h2_max_streams_50: $ref: '#/components/examples/cache-settings_origin_h2_max_streams_50' schema: $ref: '#/components/schemas/cache-settings_origin_h2_max_streams_response_value' 4XX: description: Get Origin H2 Max Streams setting response failure. content: application/json: examples: Error: $ref: '#/components/examples/cache-settings_dummy_error_response' schema: $ref: '#/components/schemas/cache-settings_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read - Zone Read - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.origin-h2-max-streams x-fern-sdk-method-name: get x-forge-hidden: true patch: operationId: zone-cache-settings-change-origin-h2-max-streams-setting summary: Change Origin H2 Max Streams Setting description: Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled. parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache-settings_identifier' requestBody: required: true content: application/json: schema: type: object properties: value: $ref: '#/components/schemas/cache-settings_origin_h2_max_streams_value' required: - value responses: '200': description: Change Origin H2 Max Streams setting response. content: application/json: examples: origin_h2_max_streams_50: $ref: '#/components/examples/cache-settings_origin_h2_max_streams_50' schema: $ref: '#/components/schemas/cache-settings_origin_h2_max_streams_response_value' 4XX: description: Change Origin H2 Max Streams response failure. content: application/json: examples: Error: $ref: '#/components/examples/cache-settings_dummy_error_response' schema: $ref: '#/components/schemas/cache-settings_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: business: false enterprise: true free: false pro: false x-fern-availability: generally-available x-fern-sdk-group-name: zones.origin-h2-max-streams x-fern-sdk-method-name: edit x-forge-hidden: true /zones/{zone_id}/settings/origin_max_http_version: get: operationId: zone-cache-settings-get-origin-max-http-version-setting 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, for more information.). The default value is "2" for all plan types except Enterprise where it is "1". parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache-settings_identifier' responses: '200': description: Get Origin Max HTTP Version setting response. content: application/json: examples: max_http_version_2: $ref: '#/components/examples/cache-settings_origin_max_http_version_2' schema: type: object allOf: - $ref: '#/components/schemas/cache-settings_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache-settings_origin_max_http_version_response_value' 4XX: description: Get Origin Max HTTP Version setting response failure. content: application/json: examples: Error: $ref: '#/components/examples/cache-settings_dummy_error_response' schema: $ref: '#/components/schemas/cache-settings_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read - Zone Read - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.origin-max-http-version x-fern-sdk-method-name: get x-forge-hidden: true patch: operationId: zone-cache-settings-change-origin-max-http-version-setting 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, for more information.). The default value is "2" for all plan types except Enterprise where it is "1". parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/cache-settings_identifier' requestBody: required: true content: application/json: schema: type: object properties: value: $ref: '#/components/schemas/cache-settings_origin_max_http_version_value' required: - value responses: '200': description: Change Origin Max HTTP Version setting response. content: application/json: examples: max_http_version_2: $ref: '#/components/examples/cache-settings_origin_max_http_version_2' schema: type: object allOf: - $ref: '#/components/schemas/cache-settings_zone_cache_settings_response_single' - $ref: '#/components/schemas/cache-settings_origin_max_http_version_response_value' 4XX: description: Change Origin Max HTTP Version response failure. content: application/json: examples: Error: $ref: '#/components/examples/cache-settings_dummy_error_response' schema: $ref: '#/components/schemas/cache-settings_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.origin-max-http-version x-fern-sdk-method-name: edit x-forge-hidden: true /zones/{zone_id}/settings/speed_brain: get: operationId: zone-settings-get-speed-brain-setting summary: Get Cloudflare Speed Brain setting description: 'Speed Brain lets compatible browsers speculate on content which can be prefetched or preloaded, making website navigation faster. Refer to the Cloudflare Speed Brain documentation for more information.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' responses: '200': description: Get Cloudflare Speed Brain setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_cloudflare_speed_brain_response' type: object 4XX: description: Get Cloudflare Speed Brain setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.speed-brain x-fern-sdk-method-name: get patch: operationId: zone-settings-change-speed-brain-setting summary: Change Cloudflare Speed Brain setting description: 'Speed Brain lets compatible browsers speculate on content which can be prefetched or preloaded, making website navigation faster. Refer to the Cloudflare Speed Brain documentation for more information.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' requestBody: required: true content: application/json: schema: type: object properties: value: description: Whether the feature is enabled or disabled. type: string enum: - 'on' - 'off' required: - value responses: '200': description: Cloudflare Speed Brain setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_cloudflare_speed_brain_response' type: object 4XX: description: Change Cloudflare Speed Brain setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write x-cfPermissionsRequired: enum: - '#zone_settings:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.speed-brain x-fern-sdk-method-name: edit /zones/{zone_id}/settings/transformations_allowed_origins: get: operationId: zone-settings-get-transformations-allowed-origins-setting summary: Get Image Transformations Allowed Origins setting description: 'Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare''s network to requests originating from specified domains. Refer to the Image Transformations and Video Transformations documentation for more information.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' responses: '200': description: Get Image Transformations Allowed Origins setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_transformations_allowed_origins_response' type: object 4XX: description: Get Image Transformations Allowed Origins setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.transformations-allowed-origins x-fern-sdk-method-name: get patch: operationId: zone-settings-change-transformations-allowed-origins-setting summary: Change Image Transformations Allowed Origins setting description: 'Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare''s network to requests originating from specified domains. Refer to the Image Transformations and Video Transformations documentation for more information.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' requestBody: required: true content: application/json: schema: type: object properties: value: $ref: '#/components/schemas/speed_transformations_allowed_origins_value' required: - value responses: '200': description: Change Image Transformations Allowed Origins setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_transformations_allowed_origins_response' type: object 4XX: description: Change Image Transformations Allowed Origins setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.transformations-allowed-origins x-fern-sdk-method-name: edit /zones/{zone_id}/settings/transformations_c2pa: get: operationId: zone-settings-get-transformations-c2pa-setting summary: Get Image Transformations C2PA setting description: 'C2PA (Coalition for Content Provenance and Authenticity) signing adds cryptographic metadata to images processed through Cloudflare Image Transformations, enabling verification of image authenticity and provenance.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' responses: '200': description: Get Image Transformations C2PA setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_transformations_c2pa_response' type: object 4XX: description: Get Image Transformations C2PA setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.transformations-c2pa x-fern-sdk-method-name: get patch: operationId: zone-settings-change-transformations-c2pa-setting summary: Change Image Transformations C2PA setting description: 'C2PA (Coalition for Content Provenance and Authenticity) signing adds cryptographic metadata to images processed through Cloudflare Image Transformations, enabling verification of image authenticity and provenance.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' requestBody: required: true content: application/json: schema: type: object properties: value: $ref: '#/components/schemas/speed_transformations_c2pa_value' required: - value responses: '200': description: Change Image Transformations C2PA setting response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_transformations_c2pa_response' type: object 4XX: description: Change Image Transformations C2PA setting response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.transformations-c2pa x-fern-sdk-method-name: edit /zones/{zone_id}/settings/transformations_config: get: operationId: zone-settings-get-transformations-config summary: Get Transformations configuration description: 'Returns the combined Transformations configuration for a zone, including the transformations toggle, allowed origins, and C2PA signing settings in a single response.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' responses: '200': description: Get Transformations configuration response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_transformations_config_response' type: object 4XX: description: Get Transformations configuration response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.transformations-config x-fern-sdk-method-name: get patch: operationId: zone-settings-change-transformations-config summary: Change Transformations configuration description: 'Updates one or more fields of the combined Transformations configuration for a zone. Omitted fields are left unchanged. The response always returns the full current state of all three sub-settings.' parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/speed_identifier' requestBody: required: true content: application/json: schema: type: object properties: value: $ref: '#/components/schemas/speed_transformations_config_value' required: - value responses: '200': description: Change Transformations configuration response. content: application/json: schema: allOf: - $ref: '#/components/schemas/speed_api-response-common' - properties: result: $ref: '#/components/schemas/speed_transformations_config_response' type: object 4XX: description: Change Transformations configuration response failure. content: application/json: schema: $ref: '#/components/schemas/speed_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: zones.transformations-config x-fern-sdk-method-name: edit /zones/{zone_id}/settings/{setting_id}: get: operationId: zone-settings-get-single-setting summary: Get zone setting description: Fetch a single zone setting by name parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' - name: setting_id in: path required: true schema: $ref: '#/components/schemas/zones_setting_name' responses: '200': description: Get zone setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_api-response-common-4' - properties: result: $ref: '#/components/schemas/zones_setting' 4XX: description: Get zone setting response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure-3' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write - Zone Settings Read x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true free: false pro: false x-fern-availability: generally-available x-fern-sdk-group-name: zones.settings x-fern-sdk-method-name: get patch: operationId: zone-settings-edit-single-setting summary: Edit zone setting description: Updates a single zone setting by the identifier parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/zones_identifier' - name: setting_id in: path required: true schema: $ref: '#/components/schemas/zones_setting_name' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/zones_zone_settings_single_request' responses: '200': description: Edit zone setting response content: application/json: schema: allOf: - $ref: '#/components/schemas/zones_api-response-common-4' - properties: result: $ref: '#/components/schemas/zones_setting' 4XX: description: Edit zone settings info response failure content: application/json: schema: $ref: '#/components/schemas/zones_api-response-common-failure-3' security: - api_token: [] - api_email: [] api_key: [] tags: - Zone Settings x-api-token-group: - Zone Settings Write x-cfPermissionsRequired: enum: - '#zone_settings:read' x-cfPlanAvailability: business: true enterprise: true free: false pro: false x-fern-availability: generally-available x-fern-sdk-group-name: zones.settings x-fern-sdk-method-name: edit components: schemas: speed_messages: type: array items: properties: code: type: integer minimum: 1000 x-auditable: true message: type: string x-auditable: true required: - code - message type: object uniqueItems: true example: [] speed_automatic_platform_optimization_value: description: 'Configuration for Automatic Platform Optimization (APO) for WordPress. Set to "off" to disable, or provide an object to configure APO settings. ' oneOf: - description: Disable Automatic Platform Optimization. enum: - 'off' type: string - properties: cache_by_device_type: description: Whether to cache by device type. type: boolean example: false cf: description: Whether the zone is proxied through Cloudflare. type: boolean example: true enabled: description: Whether APO is enabled. type: boolean example: true hostnames: description: List of hostnames where APO is active. type: array items: type: string example: - www.example.com recheck: description: Whether to recheck WordPress and plugin detection. type: boolean example: false wordpress: description: Whether the site is a WordPress site. type: boolean example: true wp_plugin: description: Whether the Cloudflare WordPress plugin is installed. type: boolean example: true required: - cf - enabled - wordpress - wp_plugin type: object title: Automatic Platform Optimization value zones_security_header_value: type: object properties: strict_transport_security: description: Strict Transport Security. type: object properties: enabled: description: Whether or not strict transport security is enabled. type: boolean example: true include_subdomains: description: Include all subdomains for strict transport security. type: boolean example: true max_age: description: Max age in seconds of the strict transport security. type: number example: 86400 nosniff: description: 'Whether or not to include ''X-Content-Type-Options: nosniff'' header.' type: boolean example: true preload: description: Enable automatic preload of the HSTS configuration. type: boolean example: true default: strict_transport_security: enabled: true include_subdomains: true max_age: 86400 nosniff: true preload: false zones_sort_query_string_for_cache_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' zones_true_client_ip_header-2: 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' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: true_client_ip_header enum: - true_client_ip_header value: $ref: '#/components/schemas/zones_true_client_ip_header_value' title: True Client IP Header zones_ciphers: description: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. default: [] allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: ciphers enum: - ciphers value: $ref: '#/components/schemas/zones_ciphers_value' title: Zone ciphers allowed for TLS termination zones_cache-rules_aegis: description: Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses. type: object allOf: - $ref: '#/components/schemas/zones_cache-rules_base' - properties: id: description: ID of the zone setting. type: string example: aegis enum: - aegis x-auditable: true value: $ref: '#/components/schemas/zones_cache-rules_aegis_value' type: object title: Aegis zones_china_network_enabled: description: 'Determines whether or not the china network is enabled. ' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: china_network_enabled enum: - china_network_enabled value: $ref: '#/components/schemas/zones_china_network_enabled_value' title: China Network Enabled zones_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).' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: server_side_exclude enum: - server_side_exclude value: $ref: '#/components/schemas/zones_server_side_exclude_value' title: Server Side Exclude zones_browser_check-2: 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). allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: browser_check enum: - browser_check value: $ref: '#/components/schemas/zones_browser_check_value' title: Browser Check zones_sha1_support: description: Allow SHA1 support. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: Zone setting identifier. example: sha1_support enum: - sha1_support value: $ref: '#/components/schemas/zones_sha1_support_value' title: Toggle SHA1 support zones_sha1_support_value: description: Value of the zone setting. type: string default: 'off' enum: - 'off' - 'on' speed_automatic_platform_optimization_response: description: Controls Automatic Platform Optimization (APO) for WordPress. allOf: - $ref: '#/components/schemas/speed_base' - properties: id: description: ID of the zone setting. type: string example: automatic_platform_optimization enum: - automatic_platform_optimization x-auditable: true value: $ref: '#/components/schemas/speed_automatic_platform_optimization_value' type: object title: Automatic Platform Optimization setting speed_binary_ast_response: description: Controls Binary AST JavaScript parsing for the zone. allOf: - $ref: '#/components/schemas/speed_base' - properties: id: description: ID of the zone setting. type: string example: binary_ast enum: - binary_ast x-auditable: true value: $ref: '#/components/schemas/speed_binary_ast_value' type: object title: Binary AST setting zones_ssl_recommender_enabled: description: ssl-recommender enrollment setting. type: boolean default: false speed_transformations_c2pa_value: description: Whether C2PA signing is enabled for image transformations. type: string enum: - 'off' - 'on' x-auditable: true zones_privacy_pass_value: description: Value of the Privacy Pass v1 (deprecated) zone setting type: string default: 'off' deprecated: true enum: - 'on' - 'off' x-stainless-deprecation-message: Privacy Pass v1 was deprecated in 2023. (Announcement - https://blog.cloudflare.com/privacy-pass-standard/) and (API deprecation details - https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2024-03-31) zones_replace_insecure_js: description: 'Automatically replace insecure JavaScript libraries with safer and faster alternatives provided under cdnjs and powered by Cloudflare. Currently supports the following libraries: Polyfill under polyfill.io. ' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: replace_insecure_js enum: - replace_insecure_js value: $ref: '#/components/schemas/zones_replace_insecure_js_value' title: Replace insecure JavaScript libraries zones_mirage-2: 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. ' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: mirage enum: - mirage value: $ref: '#/components/schemas/zones_mirage_value' deprecated: true title: Mirage Image Optimization x-stainless-deprecation-message: Mirage is being deprecated. More information at https://developers.cloudflare.com/speed/optimization/images/mirage/ zones_cache_level-2: 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). allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: cache_level enum: - cache_level value: $ref: '#/components/schemas/zones_cache_level_value' title: Cloudflare Cache Level zones_prefetch_preload_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' zones_cache-rules_origin_h2_max_streams: description: Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled. type: object allOf: - $ref: '#/components/schemas/zones_cache-rules_base' - properties: id: description: Value of the zone setting. type: string example: origin_h2_max_streams enum: - origin_h2_max_streams x-auditable: true value: $ref: '#/components/schemas/zones_cache-rules_origin_h2_max_streams_value' type: object title: Origin H2 Max Streams zones_privacy_pass: description: Privacy Pass v1 was a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors by allowing users to reduce the number of CAPTCHAs shown. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass). default: 'off' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: privacy_pass enum: - privacy_pass value: $ref: '#/components/schemas/zones_privacy_pass_value' deprecated: true title: Privacy Pass v1 (deprecated) x-stainless-deprecation-message: Privacy Pass v1 was deprecated in 2023. (Announcement - https://blog.cloudflare.com/privacy-pass-standard/) and (API deprecation details - https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2024-03-31) zones_pre_render_value: description: Value of the zone setting. type: string default: 'off' enum: - 'off' - 'on' zones_image_resizing_value: description: Whether the feature is enabled, disabled, or enabled in `open proxy` mode. type: string default: 'off' enum: - 'on' - 'off' - open zones_tls_1_3: description: Enables Crypto TLS 1.3 feature for a zone. default: 'off' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: tls_1_3 enum: - tls_1_3 value: $ref: '#/components/schemas/zones_tls_1_3_value' title: Enable TLS 1.3 value for a zone zones_setting_name: description: Setting name type: string example: always_online zones_redirects_for_ai_training: description: 'When enabled, Cloudflare will redirect verified AI training crawlers to canonical URLs found in the HTML response, ensuring AI models train on authoritative content.' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: redirects_for_ai_training enum: - redirects_for_ai_training value: $ref: '#/components/schemas/zones_redirects_for_ai_training_value' title: Redirects for AI Training zones_server_side_exclude_value: description: Value of the zone setting. type: string default: 'on' enum: - 'on' - 'off' zones_transformations_allowed_origins_value: description: 'Comma-separated list of allowed origins. Refer to the [Image Transformations](https://developers.cloudflare.com/images/transform-images/sources/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information.' type: string cache-settings_origin_max_http_version_value: description: Value of the Origin Max HTTP Version Setting. type: string enum: - '2' - '1' x-auditable: true cache-settings_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 Enterprise where it is "1". type: object allOf: - $ref: '#/components/schemas/cache-settings_base' - properties: id: description: Value of the zone setting. type: string example: origin_max_http_version enum: - origin_max_http_version x-auditable: true value: $ref: '#/components/schemas/cache-settings_origin_max_http_version_value' type: object title: Origin Max HTTP Version cache-settings_aegis_value: description: Value of the zone setting. type: object properties: enabled: description: Whether the feature is enabled or not. type: boolean x-auditable: true pool_id: description: Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin. type: string example: pool-id x-auditable: true zones_proxy_read_timeout: description: Maximum time between two read operations from origin. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: proxy_read_timeout enum: - proxy_read_timeout value: $ref: '#/components/schemas/zones_proxy_read_timeout_value' title: Proxy Read Timeout zones_browser_cache_ttl-2: 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). allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: browser_cache_ttl enum: - browser_cache_ttl value: $ref: '#/components/schemas/zones_browser_cache_ttl_value' title: Browser Cache TTL speed_image_resizing_value: description: 'Controls Image Resizing behavior: - "off": Feature disabled. - "on": Resizing is enabled for same-zone images only. - "open": Resizing is enabled for images from any origin. - "latest": Resizing is enabled for same-zone images using the latest version. ' type: string enum: - 'off' - 'on' - open - latest x-auditable: true cache-settings_editable: description: Whether the setting is editable. type: boolean x-auditable: true zones_nel_value: description: Value of the zone setting. type: object properties: enabled: type: boolean example: false default: false default: enabled: false cache-settings_identifier: description: Identifier. type: string example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 readOnly: true x-auditable: true zones_tls_1_3_value: description: 'Value of the zone setting. Notes: Default value depends on the zone''s plan level.' type: string default: 'off' enum: - 'on' - 'off' - zrt cache-settings_base: type: object properties: id: description: Identifier of the zone setting. type: string x-auditable: true modified_on: description: Last time this setting was modified. type: - string - 'null' format: date-time example: '2014-01-01T05:20:00.12345Z' readOnly: true x-auditable: true required: - id zones_ipv6_value: description: Value of the zone setting. type: string default: 'off' enum: - 'off' - 'on' zones_content_converter_value: description: Value of the zone setting. type: string default: 'off' enum: - 'off' - 'on' zones_setting_value: oneOf: - $ref: '#/components/schemas/zones_0rtt_value' - $ref: '#/components/schemas/zones_advanced_ddos_value' - $ref: '#/components/schemas/zones_cache-rules_aegis_value' - $ref: '#/components/schemas/zones_always_online_value' - $ref: '#/components/schemas/zones_always_use_https_value' - $ref: '#/components/schemas/zones_automatic_https_rewrites_value' - $ref: '#/components/schemas/zones_brotli_value' - $ref: '#/components/schemas/zones_browser_cache_ttl_value' - $ref: '#/components/schemas/zones_browser_check_value' - $ref: '#/components/schemas/zones_cache_level_value' - $ref: '#/components/schemas/zones_challenge_ttl_value' - $ref: '#/components/schemas/zones_china_network_enabled_value' - $ref: '#/components/schemas/zones_content_converter_value' - $ref: '#/components/schemas/zones_ciphers_value' - $ref: '#/components/schemas/zones_cname_flattening_value' - $ref: '#/components/schemas/zones_development_mode_value' - $ref: '#/components/schemas/zones_early_hints_value' - $ref: '#/components/schemas/zones_edge_cache_ttl_value' - $ref: '#/components/schemas/zones_email_obfuscation_value' - $ref: '#/components/schemas/zones_h2_prioritization_value' - $ref: '#/components/schemas/zones_hotlink_protection_value' - $ref: '#/components/schemas/zones_http2_value' - $ref: '#/components/schemas/zones_http3_value' - $ref: '#/components/schemas/zones_image_resizing_value' - $ref: '#/components/schemas/zones_ip_geolocation_value' - $ref: '#/components/schemas/zones_ipv6_value' - $ref: '#/components/schemas/zones_max_upload_value' - $ref: '#/components/schemas/zones_min_tls_version_value' - $ref: '#/components/schemas/zones_mirage_value' - $ref: '#/components/schemas/zones_nel_value' - $ref: '#/components/schemas/zones_opportunistic_encryption_value' - $ref: '#/components/schemas/zones_opportunistic_onion_value' - $ref: '#/components/schemas/zones_orange_to_orange_value' - $ref: '#/components/schemas/zones_origin_error_page_pass_thru_value' - $ref: '#/components/schemas/zones_cache-rules_origin_h2_max_streams_value' - $ref: '#/components/schemas/zones_cache-rules_origin_max_http_version_value' - $ref: '#/components/schemas/zones_polish_value' - $ref: '#/components/schemas/zones_prefetch_preload_value' - $ref: '#/components/schemas/zones_pre_render_value' - $ref: '#/components/schemas/zones_privacy_pass_value' - $ref: '#/components/schemas/zones_proxy_read_timeout_value' - $ref: '#/components/schemas/zones_pseudo_ipv4_value' - $ref: '#/components/schemas/zones_redirects_for_ai_training_value' - $ref: '#/components/schemas/zones_replace_insecure_js_value' - $ref: '#/components/schemas/zones_response_buffering_value' - $ref: '#/components/schemas/zones_rocket_loader_value' - $ref: '#/components/schemas/zones_automatic_platform_optimization' - $ref: '#/components/schemas/zones_search_for_agents_value' - $ref: '#/components/schemas/zones_security_header_value' - $ref: '#/components/schemas/zones_security_level_value' - $ref: '#/components/schemas/zones_server_side_exclude_value' - $ref: '#/components/schemas/zones_sha1_support_value' - $ref: '#/components/schemas/zones_sort_query_string_for_cache_value' - $ref: '#/components/schemas/zones_ssl_value' - $ref: '#/components/schemas/zones_tls_1_2_only_value' - $ref: '#/components/schemas/zones_tls_1_3_value' - $ref: '#/components/schemas/zones_tls_client_auth_value' - $ref: '#/components/schemas/zones_true_client_ip_header_value' - $ref: '#/components/schemas/zones_waf_value' - $ref: '#/components/schemas/zones_webmcp_enabled_value' - $ref: '#/components/schemas/zones_webmcp_packs_value' - $ref: '#/components/schemas/zones_webp_value' - $ref: '#/components/schemas/zones_websockets_value' zones_security_level-2: 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). allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: security_level enum: - security_level value: $ref: '#/components/schemas/zones_security_level_value' title: Security Level zones_opportunistic_encryption_value: description: 'Value of the zone setting. Notes: Default value depends on the zone''s plan level.' type: string default: 'on' enum: - 'on' - 'off' cache-settings_origin_max_http_version_response_value: type: object properties: result: $ref: '#/components/schemas/cache-settings_origin_max_http_version' zones_browser_cache_ttl_value: description: 'Value of the zone setting in seconds. Minimum values by plan: - Free: 1 second - Pro: 1 second - Business: 1 second - Enterprise: 1 second Setting a TTL of 0 is equivalent to selecting `Respect Existing Headers` and is allowed for all plans.' type: integer default: 14400 maximum: 31536000 minimum: 0 zones_challenge_ttl_value: description: Value of the zone setting. type: number default: 1800 enum: - 300 - 900 - 1800 - 2700 - 3600 - 7200 - 10800 - 14400 - 28800 - 57600 - 86400 - 604800 - 2592000 - 31536000 zones_cache-rules_aegis_value: description: Value of the zone setting. type: object properties: enabled: description: Whether the feature is enabled or not. type: boolean x-auditable: true pool_id: description: Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin. type: string example: pool-id x-auditable: true zones_early_hints_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' speed_transformations_config_response: description: 'Combined view of Transformations, Allowed Origins, and C2PA settings for a zone. ' allOf: - $ref: '#/components/schemas/speed_base' - properties: id: description: ID of the zone setting. type: string example: transformations_config enum: - transformations_config x-auditable: true value: $ref: '#/components/schemas/speed_transformations_config_value' type: object title: Transformations combined configuration zones_always_use_https_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' zones_prefetch_preload: description: Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones. default: 'off' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: prefetch_preload enum: - prefetch_preload value: $ref: '#/components/schemas/zones_prefetch_preload_value' title: Prefetch preload zones_identifier: description: Identifier type: string example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 zones_search_for_agents: description: 'When enabled, Cloudflare provisions an AI Search instance for the zone and exposes a /.well-known/ai-search endpoint that AI agents can query. Markdown responses also receive an agent: YAML capability block advertising the search endpoint.' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: search_for_agents enum: - search_for_agents value: $ref: '#/components/schemas/zones_search_for_agents_value' title: Search for Agents zones_h2_prioritization_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' - custom cache-settings_messages: type: array items: properties: code: type: integer minimum: 1000 message: type: string required: - code - message type: object uniqueItems: true example: [] zones_search_for_agents_value: description: Value of the zone setting. type: string default: 'off' enum: - 'off' - 'on' zones_base: properties: editable: description: Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). type: boolean enum: - true - false readOnly: true id: description: Identifier of the zone setting. type: string example: development_mode modified_on: description: last time this setting was modified. type: - string - 'null' format: date-time example: '2014-01-01T05:20:00.12345Z' readOnly: true value: description: Current value of the zone setting. example: 'on' required: - id - value zones_cache-rules_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 Enterprise where it is "1". type: object allOf: - $ref: '#/components/schemas/zones_cache-rules_base' - properties: id: description: Value of the zone setting. type: string example: origin_max_http_version enum: - origin_max_http_version x-auditable: true value: $ref: '#/components/schemas/zones_cache-rules_origin_max_http_version_value' type: object title: Origin Max HTTP Version zones_redirects_for_ai_training_value: description: Value of the zone setting. type: string default: 'off' enum: - 'off' - 'on' zones_response_buffering-2: 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' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: response_buffering enum: - response_buffering value: $ref: '#/components/schemas/zones_response_buffering_value' deprecated: true title: Response Buffering x-stainless-deprecation-message: This zone setting is deprecated. This functionality is no longer supported. zones_edge_cache_ttl-2: description: Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: edge_cache_ttl enum: - edge_cache_ttl value: $ref: '#/components/schemas/zones_edge_cache_ttl_value' title: Edge Cache TTL zones_websockets_value: description: Value of the zone setting. type: string default: 'off' enum: - 'off' - 'on' zones_0rtt_value: description: Value of the 0-RTT setting. type: string default: 'off' enum: - 'on' - 'off' zones_multiple_settings: type: array items: anyOf: - $ref: '#/components/schemas/zones_0rtt' - $ref: '#/components/schemas/zones_advanced_ddos' - $ref: '#/components/schemas/zones_cache-rules_aegis' - $ref: '#/components/schemas/zones_always_online' - $ref: '#/components/schemas/zones_always_use_https-2' - $ref: '#/components/schemas/zones_automatic_https_rewrites-2' - $ref: '#/components/schemas/zones_brotli' - $ref: '#/components/schemas/zones_browser_cache_ttl-2' - $ref: '#/components/schemas/zones_browser_check-2' - $ref: '#/components/schemas/zones_cache_level-2' - $ref: '#/components/schemas/zones_challenge_ttl' - $ref: '#/components/schemas/zones_china_network_enabled' - $ref: '#/components/schemas/zones_content_converter' - $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-2' - $ref: '#/components/schemas/zones_email_obfuscation-2' - $ref: '#/components/schemas/zones_h2_prioritization' - $ref: '#/components/schemas/zones_hotlink_protection' - $ref: '#/components/schemas/zones_http2' - $ref: '#/components/schemas/zones_http3' - $ref: '#/components/schemas/zones_ip_geolocation-2' - $ref: '#/components/schemas/zones_ipv6' - $ref: '#/components/schemas/zones_max_upload' - $ref: '#/components/schemas/zones_min_tls_version' - $ref: '#/components/schemas/zones_mirage-2' - $ref: '#/components/schemas/zones_nel' - $ref: '#/components/schemas/zones_opportunistic_encryption-2' - $ref: '#/components/schemas/zones_opportunistic_onion' - $ref: '#/components/schemas/zones_orange_to_orange' - $ref: '#/components/schemas/zones_origin_error_page_pass_thru-2' - $ref: '#/components/schemas/zones_cache-rules_origin_h2_max_streams' - $ref: '#/components/schemas/zones_cache-rules_origin_max_http_version' - $ref: '#/components/schemas/zones_polish-2' - $ref: '#/components/schemas/zones_prefetch_preload' - $ref: '#/components/schemas/zones_pre_render' - $ref: '#/components/schemas/zones_privacy_pass' - $ref: '#/components/schemas/zones_proxy_read_timeout' - $ref: '#/components/schemas/zones_pseudo_ipv4' - $ref: '#/components/schemas/zones_redirects_for_ai_training' - $ref: '#/components/schemas/zones_replace_insecure_js' - $ref: '#/components/schemas/zones_response_buffering-2' - $ref: '#/components/schemas/zones_rocket_loader-2' - $ref: '#/components/schemas/zones_schemas-automatic_platform_optimization' - $ref: '#/components/schemas/zones_search_for_agents' - $ref: '#/components/schemas/zones_security_header' - $ref: '#/components/schemas/zones_security_level-2' - $ref: '#/components/schemas/zones_server_side_exclude' - $ref: '#/components/schemas/zones_sha1_support' - $ref: '#/components/schemas/zones_sort_query_string_for_cache-2' - $ref: '#/components/schemas/zones_ssl-2' - $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-2' - $ref: '#/components/schemas/zones_waf-2' - $ref: '#/components/schemas/zones_webmcp_enabled' - $ref: '#/components/schemas/zones_webmcp_packs' - $ref: '#/components/schemas/zones_webp' - $ref: '#/components/schemas/zones_websockets' zones_polish-2: 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.' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: polish enum: - polish value: $ref: '#/components/schemas/zones_polish_value' title: Polish Image Optimization speed_h2_prioritization_value: description: 'Controls HTTP/2 Prioritization behavior: - "off": Use browser default prioritization. - "on": Use Cloudflare''s optimized prioritization. - "custom": Use custom prioritization rules. ' type: string enum: - 'off' - 'on' - custom x-auditable: true zones_webp: 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. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: webp enum: - webp value: $ref: '#/components/schemas/zones_webp_value' title: Polish WebP Conversion zones_replace_insecure_js_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' zones_rocket_loader_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' zones_ipv6: description: Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586). allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: ipv6 enum: - ipv6 value: $ref: '#/components/schemas/zones_ipv6_value' title: IPv6 zones_email_obfuscation_value: description: Value of the zone setting. type: string default: 'on' enum: - 'on' - 'off' zones_mirage_value: description: Value of the zone setting. type: string default: 'off' deprecated: true enum: - 'on' - 'off' x-stainless-deprecation-message: Mirage is being deprecated. More information at https://developers.cloudflare.com/speed/optimization/images/mirage/ speed_binary_ast_value: description: 'Controls Binary AST behavior: - "off": Feature disabled. - "on": Binary AST enabled. - "latest": Binary AST enabled using the latest version. ' type: string enum: - 'off' - 'on' - latest x-auditable: true cache-settings_aegis_response_value: type: object properties: result: $ref: '#/components/schemas/cache-settings_aegis' zones_http2_value: description: Value of the HTTP2 setting. type: string default: 'off' enum: - 'on' - 'off' zones_http3: description: HTTP3 enabled for this zone. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: http3 enum: - http3 value: $ref: '#/components/schemas/zones_http3_value' title: HTTP3 Value speed_transformations_c2pa_response: description: Controls C2PA signing for images processed through Cloudflare Image Transformations. allOf: - $ref: '#/components/schemas/speed_base' - properties: id: description: ID of the zone setting. type: string example: image_resizing_c2pa enum: - image_resizing_c2pa x-auditable: true value: $ref: '#/components/schemas/speed_transformations_c2pa_value' type: object title: Image Transformations C2PA setting zones_rocket_loader-2: 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. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: rocket_loader enum: - rocket_loader value: $ref: '#/components/schemas/zones_rocket_loader_value' title: Rocket Loader zones_opportunistic_onion: 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' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: opportunistic_onion enum: - opportunistic_onion value: $ref: '#/components/schemas/zones_opportunistic_onion_value' title: Zone Enable Onion Routing zones_ip_geolocation_value: description: Value of the zone setting. type: string default: 'on' enum: - 'on' - 'off' zones_tls_client_auth_value: description: value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' speed_transformations_allowed_origins_value: description: 'Comma-separated list of allowed origin domains for image and video transformations. Use "*" to allow all origins (default). ' type: string example: example.com,cdn.example.com x-auditable: true zones_pseudo_ipv4: description: The value set for the Pseudo IPv4 setting. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: Value of the Pseudo IPv4 setting. default: pseudo_ipv4 enum: - pseudo_ipv4 value: $ref: '#/components/schemas/zones_pseudo_ipv4_value' title: Pseudo IPv4 Value zones_webmcp_enabled: description: 'When enabled, Cloudflare injects the WebMCP bridge (bridge.js) into HTML responses for this zone, exposing DOM and Content Credentials tools to an in-browser AI agent via navigator.modelContext. No origin-side code changes are required. This setting is currently in beta and its behavior may change.' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: webmcp_enabled enum: - webmcp_enabled value: $ref: '#/components/schemas/zones_webmcp_enabled_value' title: WebMCP Enabled zones_api-response-common-failure-3: type: object properties: errors: example: - code: 7003 message: No route for the URI allOf: - $ref: '#/components/schemas/zones_messages' minLength: 1 messages: example: [] allOf: - $ref: '#/components/schemas/zones_messages' result: type: - object - 'null' success: description: Whether the API call was successful type: boolean example: false required: - success - errors - messages - result zones_edge_cache_ttl_value: 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)' type: number default: 7200 enum: - 30 - 60 - 300 - 1200 - 1800 - 3600 - 7200 - 10800 - 14400 - 18000 - 28800 - 43200 - 57600 - 72000 - 86400 - 172800 - 259200 - 345600 - 432000 - 518400 - 604800 zones_cache-rules_base: type: object properties: id: description: Identifier of the zone setting. type: string x-auditable: true modified_on: description: Last time this setting was modified. type: - string - 'null' format: date-time example: '2014-01-01T05:20:00.12345Z' readOnly: true x-auditable: true required: - id cache-settings_origin_h2_max_streams: description: Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled. type: object allOf: - $ref: '#/components/schemas/cache-settings_base' - properties: id: description: Value of the zone setting. type: string example: origin_h2_max_streams enum: - origin_h2_max_streams x-auditable: true value: $ref: '#/components/schemas/cache-settings_origin_h2_max_streams_value' type: object title: Origin H2 Max Streams zones_brotli_value: description: Value of the zone setting. type: string default: 'off' enum: - 'off' - 'on' cache-settings_zone_cache_settings_response_single: type: object allOf: - $ref: '#/components/schemas/cache-settings_api-response-common' - properties: result: $ref: '#/components/schemas/cache-settings_result-object' type: object zones_0rtt: description: 0-RTT session resumption enabled for this zone. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: 0rtt enum: - 0rtt value: $ref: '#/components/schemas/zones_0rtt_value' title: 0-RTT Value zones_waf-2: 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). allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: waf enum: - waf value: $ref: '#/components/schemas/zones_waf_value' title: Web Application Firewall zones_ssl_recommender: description: Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support. allOf: - properties: enabled: $ref: '#/components/schemas/zones_ssl_recommender_enabled' id: description: Enrollment value for SSL/TLS Recommender. example: ssl_recommender enum: - ssl_recommender title: SSL/TLS Recommender zones_orange_to_orange_value: description: Value of the zone setting. type: string default: 'on' deprecated: true enum: - 'on' - 'off' x-stainless-deprecation-message: This setting is deprecated. Orange to Orange (O2O) is applied automatically for eligible zones and no longer requires configuration; this setting only controlled the legacy O2O v1 (Managed CNAME) path. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/ speed_cloudflare_fonts_value: description: Whether the feature is enabled or disabled. type: string default: 'off' enum: - 'on' - 'off' x-auditable: true speed_api-response-common-failure: type: object properties: errors: example: - code: 7003 message: No route for the URI allOf: - $ref: '#/components/schemas/speed_messages' minLength: 1 messages: example: [] allOf: - $ref: '#/components/schemas/speed_messages' result: type: - object - 'null' success: description: Whether the API call was successful. type: boolean example: false x-auditable: true required: - success - errors - messages - result zones_always_use_https-2: 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' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: always_use_https enum: - always_use_https value: $ref: '#/components/schemas/zones_always_use_https_value' title: Zone Enable Always Use HTTPS zones_ssl-2: 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).' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: ssl enum: - ssl value: $ref: '#/components/schemas/zones_ssl_value' title: SSL zones_pre_render: description: 'When enabled, Cloudflare serves pre-rendered HTML to eligible search and AI crawlers instead of the origin''s unrendered response.' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: pre_render enum: - pre_render value: $ref: '#/components/schemas/zones_pre_render_value' title: Pre-render zones_opportunistic_onion_value: description: 'Value of the zone setting. Notes: Default value depends on the zone''s plan level.' type: string default: 'off' enum: - 'on' - 'off' zones_ciphers_value: description: Value of the zone setting. type: array items: type: string example: - ECDHE-RSA-AES128-GCM-SHA256 - AES128-SHA default: [] uniqueItems: true speed_cloudflare_speed_brain_response: allOf: - $ref: '#/components/schemas/speed_base' - properties: value: description: 'Whether the feature is enabled or disabled. Defaults to "on" for Free plans, otherwise defaults to "off". ' type: string type: object title: Cloudflare Speed Brain response speed_h2_prioritization_response: description: Controls HTTP/2 Prioritization for the zone. allOf: - $ref: '#/components/schemas/speed_base' - properties: id: description: ID of the zone setting. type: string example: h2_prioritization enum: - h2_prioritization x-auditable: true value: $ref: '#/components/schemas/speed_h2_prioritization_value' type: object title: HTTP/2 Prioritization setting zones_waf_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' cache-settings_setting_id: description: The identifier of the caching setting. type: string x-auditable: true cache-settings_setting_value: description: The value of the setting. type: string x-auditable: true speed_transformations_config_value: description: 'Combined configuration value for Transformations. All fields are optional on PATCH; omitted fields are left unchanged. ' type: object properties: allowed_origins: description: 'Comma-separated list of allowed origin domains for image and video transformations. Use "*" to allow all origins (default). ' type: string example: example.com,cdn.example.com x-auditable: true c2pa: description: Whether C2PA signing is enabled for image transformations. type: string enum: - 'off' - 'on' x-auditable: true transformations: description: 'Controls Image Transformations behavior: - "off": Feature disabled. - "on": Transformations enabled for same-zone images only. - "open": Transformations enabled for images from any origin. - "latest": Transformations enabled using the latest version. ' type: string enum: - 'off' - 'on' - open - latest x-auditable: true speed_transformations_allowed_origins_response: description: 'Controls which origins are allowed to request image and video transformations. ' allOf: - $ref: '#/components/schemas/speed_base' - properties: id: description: ID of the zone setting. type: string example: image_resizing_allowed_origins enum: - image_resizing_allowed_origins x-auditable: true value: $ref: '#/components/schemas/speed_transformations_allowed_origins_value' type: object title: Image Transformations Allowed Origins setting zones_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). allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: hotlink_protection enum: - hotlink_protection value: $ref: '#/components/schemas/zones_hotlink_protection_value' title: Hotlink Protection zones_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-). allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: websockets enum: - websockets value: $ref: '#/components/schemas/zones_websockets_value' title: WebSockets zones_cname_flattening_value: description: Value of the cname flattening setting. type: string default: flatten_at_root deprecated: true enum: - flatten_at_root - flatten_all x-stainless-deprecation-message: This zone setting is deprecated; please use the DNS Settings route instead. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2025-03-21 zones_ssl_value: description: 'Value of the zone setting. Notes: Depends on the zone''s plan level' type: string default: 'off' enum: - 'off' - flexible - full - strict zones_advanced_ddos_value: description: 'Value of the zone setting. Notes: Defaults to on for Business+ plans' type: string default: 'off' enum: - 'on' - 'off' speed_image_resizing_response: description: Controls Cloudflare Image Resizing for the zone. allOf: - $ref: '#/components/schemas/speed_base' - properties: id: description: ID of the zone setting. type: string example: image_resizing enum: - image_resizing x-auditable: true value: $ref: '#/components/schemas/speed_image_resizing_value' type: object title: Image Resizing setting zones_messages: type: array items: properties: code: type: integer minimum: 1000 message: type: string required: - code - message type: object uniqueItems: true example: [] zones_true_client_ip_header_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' zones_h2_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. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: h2_prioritization enum: - h2_prioritization value: $ref: '#/components/schemas/zones_h2_prioritization_value' title: HTTP/2 Edge Prioritization zones_browser_check_value: description: Value of the zone setting. type: string default: 'on' enum: - 'on' - 'off' zones_min_tls_version: 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' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: min_tls_version enum: - min_tls_version value: $ref: '#/components/schemas/zones_min_tls_version_value' title: Zone Minimum TLS Version value zones_ip_geolocation-2: 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). allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: ip_geolocation enum: - ip_geolocation value: $ref: '#/components/schemas/zones_ip_geolocation_value' title: IP Geolocation zones_opportunistic_encryption-2: description: Enables the Opportunistic Encryption feature for a zone. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: opportunistic_encryption enum: - opportunistic_encryption value: $ref: '#/components/schemas/zones_opportunistic_encryption_value' title: Enable Opportunistic Encryption for a zone zones_advanced_ddos: 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. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: advanced_ddos enum: - advanced_ddos value: $ref: '#/components/schemas/zones_advanced_ddos_value' title: Advanced DDoS Protection zones_cache_level_value: description: Value of the zone setting. type: string default: aggressive enum: - aggressive - basic - simplified speed_base: properties: editable: description: Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). type: boolean enum: - true - false readOnly: true x-auditable: true id: description: Identifier of the zone setting. type: string example: development_mode x-auditable: true modified_on: description: last time this setting was modified. type: - string - 'null' format: date-time example: '2014-01-01T05:20:00.12345Z' readOnly: true x-auditable: true value: description: Current value of the zone setting. type: string example: 'on' enum: - 'on' - 'off' x-auditable: true cache-settings_api-response-common-failure: type: object properties: errors: type: array items: type: object example: - code: 7003 message: No route for the URI allOf: - $ref: '#/components/schemas/cache-settings_messages' minLength: 1 messages: type: array items: type: object example: [] allOf: - $ref: '#/components/schemas/cache-settings_messages' result: type: - object - 'null' enum: - null success: description: Whether the API call was successful. type: boolean example: false enum: - false required: - success - errors - messages - result zones_response_buffering_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' zones_automatic_https_rewrites-2: description: Enable the Automatic HTTPS Rewrites feature for this zone. default: 'off' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: automatic_https_rewrites enum: - automatic_https_rewrites value: $ref: '#/components/schemas/zones_automatic_https_rewrites_value' title: Zone Enable Automatic HTTPS Rewrites zones_security_level_value: description: Value of the zone setting. type: string default: medium enum: - 'off' - essentially_off - low - medium - high - under_attack zones_sort_query_string_for_cache-2: 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' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: sort_query_string_for_cache enum: - sort_query_string_for_cache value: $ref: '#/components/schemas/zones_sort_query_string_for_cache_value' title: Get String Sort zones_webp_value: description: Value of the zone setting. type: string default: 'off' enum: - 'off' - 'on' zones_orange_to_orange: description: Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: orange_to_orange enum: - orange_to_orange value: $ref: '#/components/schemas/zones_orange_to_orange_value' deprecated: true title: Orange to Orange x-stainless-deprecation-message: This setting is deprecated. Orange to Orange (O2O) is applied automatically for eligible zones and no longer requires configuration; this setting only controlled the legacy O2O v1 (Managed CNAME) path. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/ cache-settings_api-response-common: type: object properties: errors: $ref: '#/components/schemas/cache-settings_messages' messages: $ref: '#/components/schemas/cache-settings_messages' success: description: Whether the API call was successful. type: boolean example: true enum: - true required: - success - errors - messages zones_hotlink_protection_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' zones_tls_1_2_only_value: description: Value of the zone setting. type: string default: 'off' enum: - 'off' - 'on' zones_cache-rules_origin_max_http_version_value: description: Value of the Origin Max HTTP Version Setting. type: string enum: - '2' - '1' x-auditable: true zones_zone_settings_response_collection: allOf: - $ref: '#/components/schemas/zones_api-response-common-4' - properties: result: type: array items: anyOf: - $ref: '#/components/schemas/zones_0rtt' - $ref: '#/components/schemas/zones_advanced_ddos' - $ref: '#/components/schemas/zones_cache-rules_aegis' - $ref: '#/components/schemas/zones_always_online' - $ref: '#/components/schemas/zones_always_use_https-2' - $ref: '#/components/schemas/zones_automatic_https_rewrites-2' - $ref: '#/components/schemas/zones_brotli' - $ref: '#/components/schemas/zones_browser_cache_ttl-2' - $ref: '#/components/schemas/zones_browser_check-2' - $ref: '#/components/schemas/zones_cache_level-2' - $ref: '#/components/schemas/zones_challenge_ttl' - $ref: '#/components/schemas/zones_ciphers' - $ref: '#/components/schemas/zones_content_converter' - $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-2' - $ref: '#/components/schemas/zones_email_obfuscation-2' - $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-2' - $ref: '#/components/schemas/zones_ipv6' - $ref: '#/components/schemas/zones_max_upload' - $ref: '#/components/schemas/zones_min_tls_version' - $ref: '#/components/schemas/zones_mirage-2' - $ref: '#/components/schemas/zones_nel' - $ref: '#/components/schemas/zones_opportunistic_encryption-2' - $ref: '#/components/schemas/zones_opportunistic_onion' - $ref: '#/components/schemas/zones_orange_to_orange' - $ref: '#/components/schemas/zones_origin_error_page_pass_thru-2' - $ref: '#/components/schemas/zones_cache-rules_origin_h2_max_streams' - $ref: '#/components/schemas/zones_cache-rules_origin_max_http_version' - $ref: '#/components/schemas/zones_polish-2' - $ref: '#/components/schemas/zones_prefetch_preload' - $ref: '#/components/schemas/zones_pre_render' - $ref: '#/components/schemas/zones_privacy_pass' - $ref: '#/components/schemas/zones_proxy_read_timeout' - $ref: '#/components/schemas/zones_pseudo_ipv4' - $ref: '#/components/schemas/zones_redirects_for_ai_training' - $ref: '#/components/schemas/zones_replace_insecure_js' - $ref: '#/components/schemas/zones_response_buffering-2' - $ref: '#/components/schemas/zones_rocket_loader-2' - $ref: '#/components/schemas/zones_schemas-automatic_platform_optimization' - $ref: '#/components/schemas/zones_search_for_agents' - $ref: '#/components/schemas/zones_security_header' - $ref: '#/components/schemas/zones_security_level-2' - $ref: '#/components/schemas/zones_server_side_exclude' - $ref: '#/components/schemas/zones_sha1_support' - $ref: '#/components/schemas/zones_sort_query_string_for_cache-2' - $ref: '#/components/schemas/zones_ssl-2' - $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_transformations' - $ref: '#/components/schemas/zones_transformations_allowed_origins' - $ref: '#/components/schemas/zones_true_client_ip_header-2' - $ref: '#/components/schemas/zones_waf-2' - $ref: '#/components/schemas/zones_webmcp_enabled' - $ref: '#/components/schemas/zones_webmcp_packs' - $ref: '#/components/schemas/zones_webp' - $ref: '#/components/schemas/zones_websockets' zones_image_resizing: description: Image Transformations provides on-demand resizing, conversion and optimization for images served through Cloudflare's network. Refer to the [Image Transformations documentation](https://developers.cloudflare.com/images/) for more information. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: image_resizing enum: - image_resizing value: $ref: '#/components/schemas/zones_image_resizing_value' title: Image Transformations zones_setting: type: object oneOf: - $ref: '#/components/schemas/zones_0rtt' - $ref: '#/components/schemas/zones_advanced_ddos' - $ref: '#/components/schemas/zones_cache-rules_aegis' - $ref: '#/components/schemas/zones_always_online' - $ref: '#/components/schemas/zones_always_use_https-2' - $ref: '#/components/schemas/zones_automatic_https_rewrites-2' - $ref: '#/components/schemas/zones_brotli' - $ref: '#/components/schemas/zones_browser_cache_ttl-2' - $ref: '#/components/schemas/zones_browser_check-2' - $ref: '#/components/schemas/zones_cache_level-2' - $ref: '#/components/schemas/zones_challenge_ttl' - $ref: '#/components/schemas/zones_china_network_enabled' - $ref: '#/components/schemas/zones_content_converter' - $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-2' - $ref: '#/components/schemas/zones_email_obfuscation-2' - $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-2' - $ref: '#/components/schemas/zones_ipv6' - $ref: '#/components/schemas/zones_max_upload' - $ref: '#/components/schemas/zones_min_tls_version' - $ref: '#/components/schemas/zones_mirage-2' - $ref: '#/components/schemas/zones_nel' - $ref: '#/components/schemas/zones_opportunistic_encryption-2' - $ref: '#/components/schemas/zones_opportunistic_onion' - $ref: '#/components/schemas/zones_orange_to_orange' - $ref: '#/components/schemas/zones_origin_error_page_pass_thru-2' - $ref: '#/components/schemas/zones_cache-rules_origin_h2_max_streams' - $ref: '#/components/schemas/zones_cache-rules_origin_max_http_version' - $ref: '#/components/schemas/zones_polish-2' - $ref: '#/components/schemas/zones_prefetch_preload' - $ref: '#/components/schemas/zones_pre_render' - $ref: '#/components/schemas/zones_privacy_pass' - $ref: '#/components/schemas/zones_proxy_read_timeout' - $ref: '#/components/schemas/zones_pseudo_ipv4' - $ref: '#/components/schemas/zones_redirects_for_ai_training' - $ref: '#/components/schemas/zones_replace_insecure_js' - $ref: '#/components/schemas/zones_response_buffering-2' - $ref: '#/components/schemas/zones_rocket_loader-2' - $ref: '#/components/schemas/zones_schemas-automatic_platform_optimization' - $ref: '#/components/schemas/zones_search_for_agents' - $ref: '#/components/schemas/zones_security_header' - $ref: '#/components/schemas/zones_security_level-2' - $ref: '#/components/schemas/zones_server_side_exclude' - $ref: '#/components/schemas/zones_sha1_support' - $ref: '#/components/schemas/zones_sort_query_string_for_cache-2' - $ref: '#/components/schemas/zones_ssl-2' - $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_transformations' - $ref: '#/components/schemas/zones_transformations_allowed_origins' - $ref: '#/components/schemas/zones_true_client_ip_header-2' - $ref: '#/components/schemas/zones_waf-2' - $ref: '#/components/schemas/zones_webmcp_enabled' - $ref: '#/components/schemas/zones_webmcp_packs' - $ref: '#/components/schemas/zones_webp' - $ref: '#/components/schemas/zones_websockets' zones_webmcp_packs_value: description: 'Comma-separated list of WebMCP tool-pack names to activate for this zone (for example, "c2pa,mcp-server-client"), surfaced to the injected bridge as the data-packs attribute. An empty value clears the override so the bridge uses its built-in default pack set.' type: string default: '' maxLength: 256 pattern: ^([a-z0-9]+(-[a-z0-9]+)*(,[a-z0-9]+(-[a-z0-9]+)*)*)?$ zones_cname_flattening: description: Whether or not cname flattening is on. 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' deprecated: true title: Cloudflare CNAME Flattening x-stainless-deprecation-message: This zone setting is deprecated; please use the DNS Settings route instead. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2025-03-21 zones_challenge_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). allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: challenge_ttl enum: - challenge_ttl value: $ref: '#/components/schemas/zones_challenge_ttl_value' title: Challenge Page TTL zones_security_header: description: Cloudflare security header for a zone. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone's security header. example: security_header enum: - security_header value: $ref: '#/components/schemas/zones_security_header_value' title: Security Header zones_zone_settings_single_request: oneOf: - properties: enabled: $ref: '#/components/schemas/zones_ssl_recommender_enabled' type: object - properties: value: $ref: '#/components/schemas/zones_setting_value' type: object zones_pseudo_ipv4_value: description: Value of the Pseudo IPv4 setting. type: string default: 'off' enum: - 'off' - add_header - overwrite_header zones_webmcp_enabled_value: description: Value of the zone setting. type: string default: 'off' enum: - 'off' - 'on' zones_always_online: 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. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: always_online enum: - always_online value: $ref: '#/components/schemas/zones_always_online_value' title: Always Online Mode zones_http3_value: description: Value of the HTTP3 setting. type: string default: 'off' enum: - 'on' - 'off' zones_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. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: development_mode enum: - development_mode time_remaining: description: 'Value of the zone setting. Notes: The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is false.' type: number example: 3600 readOnly: true value: $ref: '#/components/schemas/zones_development_mode_value' title: Development Mode cache-settings_origin_h2_max_streams_response_value: allOf: - $ref: '#/components/schemas/cache-settings_api-response-common' - properties: result: $ref: '#/components/schemas/cache-settings_origin_h2_max_streams' type: object zones_cache-rules_origin_h2_max_streams_value: description: Value of the Origin H2 Max Streams Setting. type: integer example: 50 maximum: 1000 minimum: 1 x-auditable: true cache-settings_modified_on: description: The time when the setting was last modified. type: string format: date-time x-auditable: true zones_china_network_enabled_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' readOnly: true speed_api-response-common: type: object properties: errors: $ref: '#/components/schemas/speed_messages' messages: $ref: '#/components/schemas/speed_messages' success: description: Whether the API call was successful. type: boolean example: true x-auditable: true required: - success - errors - messages zones_development_mode_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' zones_transformations: description: Media Transformations provides on-demand resizing, conversion and optimization for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. Shared between Image Transformations and Video Transformations. example: transformations enum: - transformations value: $ref: '#/components/schemas/zones_image_resizing_value' title: Media Transformations zones_max_upload_value: description: 'Value of the zone setting. Notes: The size depends on the plan level of the zone. (Enterprise = 5000, Business = 200, Pro = 100, Free = 100)' type: integer default: 100 enum: - 100 - 125 - 150 - 175 - 200 - 225 - 250 - 275 - 300 - 325 - 350 - 375 - 400 - 425 - 450 - 475 - 500 - 1000 - 1500 - 2000 - 2500 - 3000 - 3500 - 4000 - 4500 - 5000 zones_tls_1_2_only: description: Only allows TLS1.2. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: Zone setting identifier. example: tls_1_2_only enum: - tls_1_2_only value: $ref: '#/components/schemas/zones_tls_1_2_only_value' title: TLS1.2 only zones_min_tls_version_value: description: Value of the zone setting. type: string default: '1.0' enum: - '1.0' - '1.1' - '1.2' - '1.3' cache-settings_origin_h2_max_streams_value: description: Value of the Origin H2 Max Streams Setting. type: integer example: 50 maximum: 1000 minimum: 1 x-auditable: true zones_email_obfuscation-2: 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). allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: email_obfuscation enum: - email_obfuscation value: $ref: '#/components/schemas/zones_email_obfuscation_value' title: Email Obfuscation zones_transformations_allowed_origins: description: Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. Shared between Image Transformations and Video Transformations. example: transformations_allowed_origins enum: - transformations_allowed_origins value: $ref: '#/components/schemas/zones_transformations_allowed_origins_value' title: Media Transformations Allowed Origins zones_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. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: early_hints enum: - early_hints value: $ref: '#/components/schemas/zones_early_hints_value' title: Early Hints cache-settings_aegis: description: Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses. type: object allOf: - $ref: '#/components/schemas/cache-settings_base' - properties: id: description: ID of the zone setting. type: string example: aegis enum: - aegis x-auditable: true value: $ref: '#/components/schemas/cache-settings_aegis_value' type: object title: Aegis zones_origin_error_page_pass_thru_value: description: Value of the zone setting. type: string default: 'off' enum: - 'on' - 'off' zones_proxy_read_timeout_value: description: 'Value of the zone setting. Notes: Value must be between 1 and 6000' type: number default: 125 zones_automatic_platform_optimization: type: object properties: cache_by_device_type: description: Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled. type: boolean example: false cf: description: Indicates whether or not Cloudflare proxy is enabled. type: boolean example: true default: false enabled: description: Indicates whether or not Automatic Platform Optimization is enabled. type: boolean example: true default: false hostnames: description: An array of hostnames where Automatic Platform Optimization for WordPress is activated. type: array items: format: hostname type: string example: - www.example.com - example.com - shop.example.com wordpress: description: Indicates whether or not site is powered by WordPress. type: boolean example: true default: false wp_plugin: description: Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed. type: boolean example: true default: false required: - enabled - cf - wordpress - wp_plugin - hostnames - cache_by_device_type zones_nel: description: 'Enable Network Error Logging reporting on your zone. (Beta) ' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: Zone setting identifier. example: nel enum: - nel value: $ref: '#/components/schemas/zones_nel_value' title: Network Error Logging zones_http2: description: HTTP2 enabled for this zone. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: http2 enum: - http2 value: $ref: '#/components/schemas/zones_http2_value' title: HTTP2 Value zones_content_converter: description: 'When enabled and the client sends an Accept header requesting text/markdown, Cloudflare will convert HTML responses to Markdown format using the toMarkdown() service. Refer to the [developer documentation](https://developers.cloudflare.com/workers-ai/features/markdown-conversion/) for more information.' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: content_converter enum: - content_converter value: $ref: '#/components/schemas/zones_content_converter_value' title: Content Converter zones_automatic_https_rewrites_value: description: 'Value of the zone setting. Notes: Default value depends on the zone''s plan level.' type: string default: 'on' enum: - 'on' - 'off' zones_tls_client_auth: description: TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only). allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: tls_client_auth enum: - tls_client_auth value: $ref: '#/components/schemas/zones_tls_client_auth_value' title: TLS Client Authentication speed_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. ' allOf: - $ref: '#/components/schemas/speed_base' - properties: id: description: ID of the zone setting. type: string example: fonts enum: - fonts x-auditable: true value: $ref: '#/components/schemas/speed_cloudflare_fonts_value' type: object title: Cloudflare Fonts zones_api-response-common-4: type: object properties: errors: $ref: '#/components/schemas/zones_messages' messages: $ref: '#/components/schemas/zones_messages' success: description: Whether the API call was successful type: boolean example: true required: - success - errors - messages zones_brotli: description: When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: brotli enum: - brotli value: $ref: '#/components/schemas/zones_brotli_value' title: Brotli Compression zones_max_upload: description: Maximum size of an allowable upload. allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: identifier of the zone setting. example: max_upload enum: - max_upload value: $ref: '#/components/schemas/zones_max_upload_value' title: Max Upload zones_always_online_value: description: Value of the zone setting. type: string default: 'on' enum: - 'on' - 'off' cache-settings_result-object: type: object properties: editable: $ref: '#/components/schemas/cache-settings_editable' id: $ref: '#/components/schemas/cache-settings_setting_id' modified_on: $ref: '#/components/schemas/cache-settings_modified_on' value: $ref: '#/components/schemas/cache-settings_setting_value' required: - id - value - editable zones_polish_value: description: Value of the zone setting. type: string default: 'off' enum: - 'off' - lossless - lossy zones_origin_error_page_pass_thru-2: 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' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: origin_error_page_pass_thru enum: - origin_error_page_pass_thru value: $ref: '#/components/schemas/zones_origin_error_page_pass_thru_value' title: Error Pages On zones_schemas-automatic_platform_optimization: description: '[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare''s edge network and caches third-party fonts.' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: automatic_platform_optimization enum: - automatic_platform_optimization value: $ref: '#/components/schemas/zones_automatic_platform_optimization' title: Automatic Platform Optimization for WordPress speed_identifier: description: Identifier. type: string example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 x-auditable: true zones_webmcp_packs: description: 'Optional per-zone override of which bundled WebMCP tool packs the injected bridge.js activates. Only takes effect when webmcp_enabled is on. Leave empty to use the bridge''s default pack set. Unknown pack names are ignored by the bridge. This setting is currently in beta and its behavior may change.' allOf: - $ref: '#/components/schemas/zones_base' - properties: id: description: ID of the zone setting. example: webmcp_packs enum: - webmcp_packs value: $ref: '#/components/schemas/zones_webmcp_packs_value' title: WebMCP Tool Packs examples: cache-settings_origin_max_http_version_2: value: errors: [] messages: [] result: editable: true id: origin_max_http_version value: '2' success: true cache-settings_origin_h2_max_streams_50: value: errors: [] messages: [] result: editable: true id: origin_h2_max_streams value: 50 success: true cache-settings_dummy_error_response: value: errors: - code: 12345 message: Some error message messages: [] result: null success: false securitySchemes: api_email: in: header name: X-Auth-Email type: apiKey api_key: in: header name: X-Auth-Key type: apiKey api_token: scheme: bearer type: http user_service_key: in: header name: X-Auth-User-Service-Key type: apiKey externalDocs: description: Cloudflare Radar Documentation url: https://developers.cloudflare.com/radar/ x-forge-commands: abuse-reports: description: Submit and track abuse reports for phishing, malware, and other policy violations on Cloudflare-proxied sites groups: appeals: description: Appeal eligibility for abuse reports emails: description: Emails sent for abuse reports mitigations: description: Mitigation actions taken in response to abuse reports accounts: description: Account settings, members, roles, subscriptions, and API tokens for your Cloudflare account groups: applications: description: Applications operations categories: description: Categories operations organizations: description: Move accounts between organizations profile: description: View and manage the profile for a Cloudflare account roles: description: View the roles available for assigning to account members, each defining a set of permissions subscriptions: description: View and manage plan subscriptions attached to this account tokens: description: Create and manage scoped API tokens for programmatic access to the Cloudflare API ai-gateway: description: Proxy, cache, rate-limit, and observe requests to AI providers — OpenAI, Anthropic, Workers AI, and more groups: custom-domains: description: Manage custom hostnames that route requests through an AI Gateway custom-providers: description: Manage account-level custom AI providers and their endpoint settings datasets: description: 'Deprecated: manage filtered collections of gateway logs used by evaluations' dynamic-routing: description: Route requests across multiple AI providers with fallback, load-balancing, and versioned deployments dynamic-routing.deployments: description: Deploy dynamic route versions and view deployment history dynamic-routing.versions: description: Create and inspect saved versions of a dynamic route evaluation-types: description: 'Deprecated: list the evaluator types that evaluations can use' evaluations: description: 'Deprecated: score the logs in a dataset with selected evaluator types' gateways: description: Create and configure AI Gateways for an account gateways.providers: description: Store and rotate upstream AI provider keys for a gateway logs: description: Inspect, annotate, and delete gateway request logs stored by Legacy Logs ai-search: description: 'Managed search-as-a-service: crawl, index, and query content with AI-powered relevance and chat completions' groups: items: description: Content indexed by AI Search instances jobs: description: Indexing job lifecycle for AI Search instances namespace: description: Logical groupings for organizing AI Search instances tokens: description: Credentials used by AI Search instances ai-security: description: Detect prompt injection, PII, and unsafe topics in traffic to your AI applications groups: custom-topics: description: Organization-specific topic categories used by AI Security for Apps content detection analytics: description: Zone-level traffic analytics — dashboard summaries, per-colo breakdowns, and Argo latency metrics groups: colo: description: Per-data-center (colo) traffic analytics breakdown for the zone dashboard: description: Aggregated zone dashboard analytics — requests, bandwidth, threats, and page views latency: description: Argo Smart Routing latency analytics showing time-to-first-byte improvements argo: description: Network optimization features that speed up and improve reliability of traffic to your origins groups: smart-routing: description: Route traffic through the fastest network paths to your origin using real-time latency data tiered-caching: description: Reduce origin load by having upper-tier data centers serve cache misses before reaching your origin basin-catalog: description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines groups: credentials: description: Catalog access credentials for external query engines (Spark, Trino, etc.) maintenance-configs: description: Table maintenance settings — compaction schedules and snapshot expiration policies namespaces: description: Logical namespaces that group related tables within the data catalog namespaces.tables: description: Tables within catalog namespaces namespaces.tables.maintenance-configs: description: Table-level maintenance configurations and operations namespaces.tables.maintenance-runs: description: History of maintenance runs performed on tables billing: description: Account billing profiles and usage data for Cloudflare subscriptions and add-on services groups: profiles: description: Billing profile with payment method, address, and invoice preferences usage: description: Metered usage data for billed services — requests, bandwidth, and feature consumption botnet-feed: description: Botnet threat intelligence feeds — IP and ASN-level data on known command-and-control infrastructure groups: asn: description: ASN-level botnet activity data showing networks with known C2 infrastructure configs: description: Botnet feed subscription configuration and notification preferences builds: description: Build and deploy Workers from connected repositories, then inspect build status and logs. groups: deploy-hooks: description: Manage branch-specific HTTP hooks that start builds. limits: description: View build-minute availability and refresh information. logs: description: Retrieve build logs. repos: description: Manage source repository connections for Workers Builds. tokens: description: Manage credentials used by Workers Builds to deploy Workers. triggers: description: Configure how repository changes build and deploy Workers. versions: description: Find builds associated with Worker versions. workers: description: Manage repository-backed build configuration for Workers. cache: description: Purge cached content and configure Cache Reserve, tiered caching, and variant serving groups: origin-cloud-regions: description: Manage Origin Cloud Regions routing and failover configurations settings: description: Configure Cache Reserve, tiered caching, and variant serving settings.regional-tiered-cache: description: Restrict tiered cache topology to data centers within a specific geographic region settings.reserve: description: Persistent storage tier that keeps cached assets even after eviction from edge caches settings.smart-tiered-cache: description: Automatically determine the best upper-tier data centers for tiered cache topology settings.variants: description: Serve different cached versions of an image based on the Accept header (WebP, AVIF, etc.) client-side-security: description: Client-Side Security — monitor JavaScript, connections, and cookies on your pages for supply-chain attacks groups: connections: description: Third-party connections made by scripts on your pages — track data exfiltration risks cookies: description: Cookies set by your pages with classification and same-site attribute tracking policies: description: Content Security Policies that control which scripts and connections are allowed on your pages scripts: description: JavaScript files detected on your pages with change tracking and malicious code detection settings: description: Fine tune Client-Side Security behaviors cloud-connector: description: Route traffic from Cloudflare directly to cloud provider services (AWS, Azure, GCP) without origin servers groups: rules: description: Routing rules that map request patterns to cloud provider endpoints cloudforce-one: description: Detection rule management APIs groups: binary-storage: description: Upload and retrieve malware samples and suspicious binaries for analysis requests: description: Additional request operations — priority listing and asset creation rules: description: Rule management operations groups: approvals: description: Approval workflow operations email: description: Email rule operations exemptions: description: Exemption rule operations managed: description: Managed rule operations stats: description: Rule statistics operations tree: description: Rule navigation tree operations scans: description: Scan URLs, IPs, and domains for threat intelligence indicators containers: description: Deploy and manage Containers applications on Cloudflare's global network groups: applications: description: Manage Containers applications applications.instances: description: Inspect Containers instances belonging to applications applications.rollouts: description: Manage rollouts for scheduler-backed applications applications.versions: description: Inspect versions of scheduler-backed applications registries: description: Manage Containers image registries registries.credentials: description: Generate image registry credentials content-scan: description: Malicious uploads detection, scan uploaded content in HTTP requests for malware and malicious payloads groups: expressions: description: Custom expressions that tell the scanner how to reach content objects it cannot parse on its own custom-pages: description: Manage custom error and challenge pages and their assets for accounts and zones groups: account-custom-pages: description: Manage account-level custom pages account-custom-pages.preview-tokens: description: Preview tokens for account-level custom pages assets: description: Manage account- and zone-level custom assets zone-custom-pages: description: Manage zone-level custom pages zone-custom-pages.preview-tokens: description: Preview tokens for zone-level custom pages d1: description: D1 is Cloudflare's managed, serverless database with SQLite's SQL semantics, built-in disaster recovery, and Worker and HTTP API access. groups: time-travel: description: use specific point-in-time backups of your D1 database x-forge-epilogue: For more information about Time Travel, see https://developers.cloudflare.com/d1/reference/time-travel diagnostics: description: Network diagnostic tools — traceroutes from Cloudflare's edge and endpoint health checks groups: endpoint-healthchecks: description: Monitor external endpoint availability with periodic HTTP/HTTPS health checks traceroutes: description: Run traceroutes from Cloudflare data centers to diagnose network path issues email-routing: description: Route incoming email to verified destination addresses or Workers with routing rules, catch-all behavior, and managed DNS records groups: addresses: description: Verified destination email addresses that can receive forwarded mail dns: description: Inspect or unlock the DNS records required by Email Routing rules: description: Match incoming email addresses and forward messages to destination mailboxes or Workers settings: description: Inspect and update Email Routing settings email-security: description: Cloud email security — investigate threats, manage allow/block policies, and detect phishing groups: analytics: description: Analytics and reporting — monthly report and per-day breakdowns of threat activity bulk-actions: description: Asynchronous jobs that move or release every message matching a search — create, monitor, and manage bulk jobs investigate: description: Search and investigate email messages — view detections, traces, raw content, and take remediation actions phishguard: description: PhishGuard user-reported phishing reports — view detected threats for a date range settings: description: Email security configuration — block senders, allow policies, content policies, domains, trusted domains, impersonation registry, and URL handling submissions: description: Reclassify submissions — track user and team reports of false positives and missed detections email-sending: description: Send transactional email and manage sending subdomains and their DNS configuration groups: limits: description: Inspect account-level sending quotas and current usage subdomains: description: Configure sending subdomains and keep their DNS records healthy suppressions: description: Prevent delivery to suppressed addresses and manage the account suppression list filters: description: Filter expressions used by legacy firewall rules to match requests — prefer Rulesets for new configurations firewall: description: Legacy firewall rules, zone lockdowns, access rules, user-agent blocking, and WAF packages groups: access-rules: description: IP-based access rules that allow, block, challenge, or whitelist traffic globally or per-zone lockdowns: description: Zone lockdown rules that restrict access to URLs by IP address or range rules: description: Legacy firewall rules with filter expressions — prefer Rulesets for new configurations ua-rules: description: Block or challenge requests based on the User-Agent header string waf: description: Legacy WAF managed rule packages, rule groups, individual rules, and override configurations zone-access-rules: description: Zone-scoped IP access rules for blocking or allowing traffic google-tag-gateway: description: Google Tag Gateway operations groups: config: description: Google Tag Gateway config operations healthchecks: description: Standalone health checks that monitor origin server availability from Cloudflare's edge groups: previews: description: Test a health check configuration before deploying it to production hyperdrive: description: Accelerate access to existing databases by caching queries and pooling connections at the edge iam: description: Identity and access management — permission groups, resource groups, user groups, and SSO connectors groups: permission-groups: description: View the permission groups that can be assigned to API tokens and policies resource-groups: description: Define scopes that limit which account resources a policy or token can access sso: description: Configure single sign-on connectors to authenticate account members through an external identity provider user-groups: description: Organize account members into groups for easier permission assignment images: description: Store, resize, and deliver optimized images globally — variants, signing keys, and direct uploads groups: flows: description: Zone-level transformation flows that control how images are resized and optimized on delivery import: description: Import images from S3 keys: description: Manage signing keys for generating private image URLs variants: description: Manage named resize variants for transforming images on delivery intel: description: Threat intelligence lookups — IP reputation, domain info, ASN details, WHOIS, and indicator feeds groups: asn: description: ASN intelligence — ownership, geolocation, and subnet details for autonomous systems attack-surface-report: description: Attack surface intelligence — exposed assets, vulnerabilities, and infrastructure mapping dns: description: Passive DNS data showing historical DNS resolution records for domains domain-history: description: Historical domain registration and categorization changes over time domains: description: Domain intelligence — risk scores, categories, and associated infrastructure indicator-feeds: description: Threat indicator feeds — subscribe to and manage curated lists of malicious IPs, domains, and URLs ip-lists: description: Curated IP lists used for threat detection and policy enforcement ips: description: IP address intelligence — geolocation, risk assessment, and hosting provider details miscategorizations: description: Report and track domain miscategorization corrections whois: description: WHOIS registration data for domains including registrant, registrar, and nameservers k2: description: Durable, ordered event streams that you produce records to and consume from with subscriptions groups: streams: description: K2 streams, their retention, and the HTTP and Workers binding inputs used to produce records streams.subscriptions: description: Subscriptions that consume a K2 stream, with committed-position lag leaked-credential-checks: description: Detect compromised credentials in login requests by checking against known breach databases groups: detections: description: Custom detection locations that tell the WAF where to find usernames and passwords in requests load-balancers: description: Distribute traffic across origin pools with health monitoring, geo-steering, and failover groups: monitor-groups: description: Group monitors together for shared configuration and bulk management monitor-groups.references: description: List references to monitor groups used by load balancer pools monitors: description: Health check configurations that probe origin servers and determine pool availability monitors.previews: description: Health check configurations that probe origin servers and determine pool availability monitors.references: description: Health check configurations that probe origin servers and determine pool availability pools: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences pools.health: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences pools.references: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences previews: description: Preview the result of a health check monitor configuration before applying it regions: description: Geographic regions used for regional pool steering and traffic policies searches: description: Search across all load balancer resources (pools, monitors, load balancers) by name or reference logs: description: Log control, retention, and raw log access — CMB config, ray ID lookups, and received fields groups: control: description: Log control operations received: description: Received log operations magic-network-monitoring: description: Flow-based network traffic monitoring with configurable alerting rules and VPC flow ingestion groups: configs: description: Account-level monitoring configuration — sampling rates, thresholds, and notification settings rules: description: Monitoring rules that define traffic thresholds and trigger alerts or prefix advertisements vpc-flows: description: Ingest VPC flow logs from cloud providers for network visibility and anomaly detection magic-transit: description: DDoS-protected network transit — GRE/IPsec tunnels, static routes, Magic WAN sites, connectors, and packet captures groups: advanced-dns-protection: description: Advanced Dns Protection operations advanced-tcp-protection: description: Advanced Tcp Protection operations apps: description: Application-aware traffic policies for Magic WAN that steer traffic by app type bgp-filter-profiles: description: BGP filter profiles for controlling which routes are allowed or denied on Magic Transit tunnels bgp-settings: description: BGP settings for controlling default ASN and route redistribution on Magic Transit tunnels cf-interconnects: description: Cloudflare Network Interconnect (CNI) links for direct physical or virtual peering gre-tunnels: description: GRE tunnel endpoints that connect your network to Cloudflare for Magic Transit ipsec-tunnels: description: IPsec tunnel endpoints with pre-shared key management for encrypted transit pcaps: description: Packet capture requests for debugging traffic flowing through Magic Transit tunnels routes: description: Static routes that direct IP prefix traffic through specific GRE/IPsec tunnels sites: description: Magic WAN branch sites — base CRUD, LAN/WAN interface configuration, ACLs, connectors, app configuration, and NetFlow config mcp: description: Manage MCP portals and upstream MCP servers for Cloudflare Access AI controls groups: portals: description: Manage MCP portals, attached servers, and Code Mode settings servers: description: Manage upstream MCP servers, credentials, capabilities, and sync state network-interconnects: description: Physical and virtual private interconnects between your infrastructure and Cloudflare's network groups: cnis: description: Cloud Network Interconnect (CNI) connections — private links from cloud providers to Cloudflare interconnects: description: Physical cross-connect and partner interconnect sessions with LOA and status tracking settings: description: Account-level interconnect settings and default configurations slots: description: Available interconnect facility slots showing port capacity at Cloudflare data centers organizations: description: Multi-user organizations that group accounts, members, and shared settings under a single entity groups: account-organizations: description: List organizations associated with a specific account accounts: description: Accounts operations members: description: Members operations members-batch-create: description: Members Batch Create operations organization-profile: description: View and update the public profile information for an organization shares: description: Shares operations origin-post-quantum-encryption: description: Enable post-quantum key exchange for connections between Cloudflare and your origin server pages: description: Full-stack application hosting with Git-integrated builds, preview deployments, and custom domains groups: projects: description: Pages projects, deployments, build logs, and custom domain bindings pipelines: description: Ingest, transform, and route event streams into R2, analytics, or other destinations in real time groups: sinks: description: Destinations where pipeline data is written — R2 buckets, HTTP endpoints, or other storage streams: description: Inbound data streams that feed events into a pipeline for processing precursor: description: Precursor settings for a zone queues: description: Reliable message queuing between Workers — produce, consume, and batch-process messages at scale groups: consumers: description: Workers that automatically receive and process messages from a queue messages: description: Push messages to a queue and pull or acknowledge them from consumers purge: description: Remove all pending messages from a queue subscriptions: description: Manage queue subscriptions for event-driven message routing r2: description: S3-compatible object storage with zero egress fees — buckets, lifecycle rules, event notifications, and data migration groups: buckets: description: Create and configure R2 buckets including CORS, lifecycle, custom domains, event notifications, and object locks buckets.jobs: description: Create and inspect background jobs for an R2 bucket buckets.local-uploads: description: R2 bucket local upload configuration super-slurper: description: Migrate data from external S3-compatible storage into R2 buckets with resumable transfer jobs temporary-credentials: description: Generate short-lived S3-compatible credentials scoped to specific buckets and operations r2-data-catalog: description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines groups: credentials: description: Catalog access credentials for external query engines (Spark, Trino, etc.) maintenance-configs: description: Table maintenance settings — compaction schedules and snapshot expiration policies namespaces: description: Logical namespaces that group related tables within the data catalog namespaces.tables: description: Tables within catalog namespaces namespaces.tables.maintenance-configs: description: Table-level maintenance configurations and operations namespaces.tables.maintenance-runs: description: History of maintenance runs performed on tables radar: description: Internet-wide traffic intelligence — BGP, DNS, HTTP trends, attack data, and network quality insights groups: agent-readiness: description: Agent readiness summary statistics across the Cloudflare network ai: description: AI inference trends and model usage statistics across the Cloudflare network annotations: description: Radar annotations marking significant Internet events (outages, cable cuts, etc.) as112: description: AS112 DNS sinkhole statistics — reverse DNS query volumes for private address space attacks: description: DDoS and application-layer attack trends, vectors, and target analysis bgp: description: BGP routing data — prefix announcements, AS-level stats, route leaks, and hijack events bots: description: Internet-wide bot traffic trends, categories, and distribution statistics ct: description: Certificate Transparency log monitoring and newly-issued certificate discovery datasets: description: Downloadable Radar datasets for offline analysis and research dns: description: Global DNS query trends — top domains, resolver stats, and DNSSEC adoption email: description: Email security trends — DMARC/SPF/DKIM adoption, spam, and phishing statistics entities: description: Look up ASNs, IPs, domains, and locations with metadata and traffic summaries geolocations: description: Geographic location metadata used for regional traffic analysis http: description: HTTP protocol trends — TLS versions, HTTP versions, browser share, and OS distribution leaked-credentials: description: Leaked credential detection trends and exposure statistics netflows: description: Network-layer traffic flow data and volumetric trend analysis origins: description: Cloud and hosting origin providers (e.g. Amazon, by region) and their traffic metrics post-quantum: description: Post-quantum encryption adoption and deployment trends across the Internet quality: description: Internet connection quality metrics — speed, latency, and jitter by geography and ASN ranking: description: Top domain rankings based on DNS query popularity across the Cloudflare network robots-txt: description: Robots.txt adoption and crawler directive trends across the web search: description: Search Radar data across IPs, ASNs, domains, and locations tcp-resets-timeouts: description: TCP connection reset and timeout statistics indicating network health issues tlds: description: Top-level domain (TLD) metadata and performance trends traffic-anomalies: description: Detected traffic anomalies and unusual patterns in Internet traffic flows verified-bots: description: Catalog of known good bots (Googlebot, Bingbot, etc.) and their traffic patterns rate-limits: description: Legacy per-zone rate limiting rules — prefer Advanced Rate Limiting in Rulesets for new configurations realtime: description: Real-time audio, video, and data services on Cloudflare's global network groups: kit: description: SDK-backed meetings, participants, recordings, livestreams, and webhooks kit.analytics: description: Usage and livestream analytics for RealtimeKit applications kit.analytics.livestreams: description: Livestream analytics for RealtimeKit applications kit.analytics.livestreams.daily: description: Daily livestream analytics for RealtimeKit applications kit.analytics.usage: description: Usage analytics for RealtimeKit applications kit.apps: description: RealtimeKit applications that group meetings, sessions, and configuration kit.livestreams: description: Independent and meeting-based livestreams and their sessions kit.livestreams.sessions: description: Sessions for RealtimeKit livestreams kit.meetings: description: Meetings, participants, access tokens, and meeting livestreams kit.meetings.active: description: Live meeting state and participant controls kit.meetings.active.polls: description: Polls for active meeting sessions kit.meetings.livestream: description: Livestream operations associated with RealtimeKit meetings kit.meetings.participants: description: Participants in RealtimeKit meetings kit.meetings.participants.tokens: description: Access tokens for RealtimeKit meeting participants kit.presets: description: Reusable meeting configuration for media, permissions, and interface behavior kit.recordings: description: Meeting and participant-track recordings and recording controls kit.recordings.active: description: Active recordings for RealtimeKit meetings kit.recordings.tracks: description: Participant-track recordings for RealtimeKit meetings kit.sessions: description: Historical session data, participants, chat, transcripts, and summaries kit.sessions.chat: description: Chat messages from historical RealtimeKit sessions kit.sessions.livestreams: description: Livestreams associated with historical RealtimeKit sessions kit.sessions.participants: description: Participants in historical RealtimeKit sessions kit.sessions.peers: description: Peer details from historical RealtimeKit sessions kit.sessions.summaries: description: Summaries of historical RealtimeKit sessions kit.sessions.transcripts: description: Transcripts from historical RealtimeKit sessions kit.webhooks: description: Webhook endpoints and supported events for RealtimeKit notifications kit.webhooks.events: description: Supported events for RealtimeKit webhooks moq: description: MoQ relays for publishing and subscribing to media streams moq.relays: description: Relays are isolated MoQ scopes that carry media between publishers and subscribers moq.relays.tokens: description: Tokens that authorize publishers and subscribers to connect to a relay sfu: description: SFU apps that route WebRTC media and data between participants sfu.apps: description: SFU application namespaces for sessions and tracks turn: description: TURN keys that help clients traverse NATs and firewalls turn.keys: description: Keys used to generate short-lived TURN credentials request-tracers: description: Trace how a request would be processed through Cloudflare's rules and configuration pipeline groups: traces: description: Simulate request processing to debug rule matches, transforms, and routing decisions resource-sharing: description: Share Cloudflare resources (zones, accounts) across organizations with granular access controls groups: recipients: description: Update share recipients resources: description: Individual resources (zones, configs) that have been shared with recipients rules: description: Resources used by Cloudflare rules and rulesets groups: lists: description: Custom account-level lists of IPs, hostnames, ASNs, or redirects used in rule expressions rum: description: Real User Measurement (Web Analytics) — track page loads, Core Web Vitals, and visitor metrics groups: rules: description: Rules that control which pages and paths are tracked by Web Analytics site-info: description: Web Analytics sites — register domains and get the JavaScript beacon snippet scim: description: SCIM 2.0 provisioning — manage users, groups, and identity provider sync for your account groups: groups: description: Groups operations resource-types: description: Resource Types operations schemas: description: Schemas operations service-provider-config: description: Service Provider Config operations users: description: Users operations secrets-store: description: Centralized secret management — store API keys, tokens, and credentials for use across Workers and other products groups: quota: description: Account quota limits for secrets stores, secrets count, and storage capacity secrets: description: Encrypted key-value secrets within a store. Pass --store-id to scope. stores: description: Secret stores that hold encrypted key-value secrets accessible by Workers and services security-center: description: Security posture dashboard — view and manage security insights, misconfigurations, and vulnerabilities groups: insights: description: Security findings and recommendations across your account — DNS, SSL, WAF misconfigurations, etc. zone-insights: description: Zone-scoped security insights — counts by class, severity, type, and dismissal security-txt: description: Manage the /.well-known/security.txt file that tells security researchers how to report vulnerabilities smart-shield: description: Smart Shield settings, health checks, and cache reserve management groups: cache-reserve-clear: description: Cache Reserve Clear operations health-checks: description: Health checks operations spectrum: description: Proxy and protect arbitrary TCP/UDP applications through Cloudflare's network with DDoS mitigation groups: analytics: description: Real-time and historical connection analytics for Spectrum applications apps: description: Spectrum application configurations that map protocols and ports to origin servers speed: description: Observatory speed tests — run Lighthouse audits, track performance trends, and schedule recurring tests groups: availabilities: description: Check which speed test regions and configurations are available for your zone pages: description: Tested pages with their performance history, trends, and individual test results schedule: description: Scheduled recurring speed tests that automatically run at regular intervals ssl: description: SSL/TLS certificate management — certificate packs, Universal SSL, verification, and TLS mode recommendations groups: automatic-upgrader: description: SSL automatic mode enrollment — get or update automatic SSL/TLS upgrader settings recommendations: description: Get the recommended SSL/TLS encryption mode based on your origin server's certificate configuration stream: description: Video encoding, storage, and delivery — upload, live-stream, clip, caption, and embed video at scale groups: audio-tracks: description: Add, edit, or remove additional audio tracks on a video captions: description: Upload, generate, or retrieve captions and subtitles for videos in multiple languages clip: description: Create a new video clip from an existing video by specifying start and end times copy: description: Import a video from a URL into Stream for processing and delivery direct-upload: description: Generate a tokenized URL that lets end-users upload video directly to Stream downloads: description: Create downloadable MP4 renditions of a video for offline viewing embed: description: Retrieve the HTML embed code snippet for a video keys: description: Signing keys used to generate short-lived signed URLs for private video playback live-inputs: description: Enable and disable live input streams token: description: Generate short-lived signed URL tokens for secure private video playback typed-downloads: description: Type-specific stream download creation and deletion videos: description: Aggregate video storage usage statistics for the account watermarks: description: Watermark profiles that overlay an image on every video in the account webhooks: description: Webhook notifications for video lifecycle events (ready, error, etc.) tenants: description: Multi-tenant account management — manage tenant accounts, entitlements, and memberships groups: account-types: description: Account Types operations accounts: description: Accounts operations entitlements: description: Entitlements operations memberships: description: Memberships operations turnstile: description: CAPTCHA-free bot verification widgets that protect forms and APIs without degrading user experience groups: widgets: description: Turnstile widget configurations — site keys, secret rotation, and challenge mode settings url-scanner: description: Scan URLs for phishing, malware, and other threats — submit scans and retrieve detailed results groups: response: description: Response operations responses: description: Raw HTTP response data captured during URL scans scan: description: Scan operations scans: description: URL scan requests and results — submit URLs for analysis and retrieve threat verdicts user: description: Your Cloudflare user profile, invitations, organizations, billing, and personal API tokens groups: billing: description: View billing history and payment profile for your user (deprecated — prefer account-level billing) firewall: description: Firewall operations load-balancers.monitors: description: Load Balancers operations load-balancers.monitors.preview: description: Load Balancers operations load-balancers.monitors.references: description: Load Balancers operations load-balancers.pools: description: Load Balancers operations load-balancers.pools.edit.pools: description: Load Balancers operations load-balancers.pools.health: description: Load Balancers operations load-balancers.pools.preview: description: Load Balancers operations load-balancers.pools.references: description: Load Balancers operations load-balancers.preview: description: Load Balancers operations load-balancing-analytics.events: description: Load Balancing Analytics operations subscriptions: description: View and manage zone-level plan subscriptions owned by your user tenants: description: Tenants operations tokens: description: Create and manage personal API tokens scoped to your user for programmatic API access user.analytics: description: User-level traffic analytics — aggregated totals and timeseries across all zones vectorize: description: Globally distributed vector database for building semantic search, recommendations, and RAG applications on Workers groups: deprecated-indexes: description: Deprecated v1 Vectorize index operations metadata-index: description: Metadata indexes for filtered vector search waiting-rooms: description: Virtual queues that throttle traffic to your site during peak demand with customizable waiting pages groups: account-waiting-rooms: description: Account-scoped waiting room listing events: description: Scheduled events that temporarily override waiting room settings for sales, launches, etc. page: description: Custom HTML waiting page templates and preview rendering rules: description: Rules that bypass or modify waiting room behavior for specific request patterns settings: description: Zone-level waiting room defaults and cookie configuration statuses: description: Real-time queue status showing active users, queued users, and estimated wait times workflows: description: Durable, multi-step workflows that run on Workers with automatic retries and state persistence groups: instances: description: Workflow instance operations versions: description: Workflow version operations zaraz: description: Server-side tag manager — load third-party tools (analytics, pixels, etc.) from Cloudflare's edge without client-side JS groups: config: description: Full Zaraz configuration including tools, triggers, and variables for the zone default: description: Default Zaraz configuration template used as a starting point for new zones export: description: Export the current Zaraz configuration as a portable JSON document history: description: Configuration version history — browse and restore previous Zaraz configurations publish: description: Publish pending Zaraz configuration changes to make them live on the zone workflow: description: Workflow state for Zaraz configuration changes (draft vs. published) zero-trust: description: Cloudflare's SASE platform — secure access, device posture, DLP, tunnels, gateway policies, and network segmentation groups: dex: description: Digital Experience Monitoring — synthetic tests, fleet-wide device metrics, and network path diagnostics dlp.custom-prompt-topics: description: Data Loss Prevention - manage custom prompt topics for AI-based content detection dlp.data-classes: description: Data Loss Prevention - manage data classes used to classify sensitive information dlp.data-tag-categories: description: Data Loss Prevention - manage categories that organize data tags dlp.data-tag-category-templates: description: Data Loss Prevention - browse templates for creating data tag categories dlp.data-tags: description: Data Loss Prevention - manage tags used to classify and organize sensitive data dlp.datasets: description: Data Loss Prevention - manage datasets, versions, and uploads dlp.document-fingerprints: description: Data Loss Prevention - manage document fingerprints for detecting matching documents dlp.email.account-mapping: description: Data Loss Prevention - configure account mappings for outbound email scanning dlp.email.rules: description: Data Loss Prevention - manage outbound email scanning rules and their priorities dlp.entries: description: Data Loss Prevention - list and manage detection entries dlp.limits: description: Data Loss Prevention - view account limits and resource quotas dlp.patterns: description: Data Loss Prevention - validate regular expressions used for content detection dlp.profiles: description: Data Loss Prevention - list and retrieve profiles dlp.profiles.custom: description: Data Loss Prevention - manage custom profiles dlp.profiles.predefined: description: Data Loss Prevention - manage predefined profiles dlp.sensitivity-group-templates: description: Data Loss Prevention - browse templates for creating sensitivity groups dlp.sensitivity-groups: description: Data Loss Prevention - manage sensitivity groups and their level ordering dlp.sensitivity-levels: description: Data Loss Prevention - manage sensitivity levels within sensitivity groups dlp.settings: description: Data Loss Prevention - manage account-level settings dlp.validators: description: Data Loss Prevention - list and retrieve content validators dlp.validators.proximity-words: description: Data Loss Prevention - manage proximity-word validators risk-scoring: description: User Risk Scoring - retrieve and reset user risk scores risk-scoring.behaviours: description: User Risk Scoring - manage behaviors used to calculate user risk scores risk-scoring.integrations: description: User Risk Scoring - manage integrations that provide risk score signals risk-scoring.integrations.references: description: User Risk Scoring - retrieve integrations by external reference risk-scoring.summary: description: User Risk Scoring - retrieve account risk score summaries zones: description: Zones are domains on Cloudflare — list, create, and configure domain settings groups: aegis: description: Aegis operations fonts: description: Fonts operations origin-h2-max-streams: description: Origin H2 Max Streams operations origin-max-http-version: description: Origin Max Http Version operations origin-tls-compliance-modes: description: Manage zone Origin TLS Compliance Modes setting rum: description: Rum operations speed-brain: description: Speed Brain operations