--- title: Smart Shield --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Smart Shield ##### [Get Smart Shield Settings](https://developers.cloudflare.com/api/resources/smart_shield/methods/get) GET/zones/{zone\_id}/smart\_shield ##### [Patch Smart Shield Settings](https://developers.cloudflare.com/api/resources/smart_shield/methods/update) PATCH/zones/{zone\_id}/smart\_shield ##### ModelsExpand Collapse

SmartShieldGetResponse object {cache\_reserve, healthchecks\_count, regional\_tiered\_cache, 2 more } A consolidated object containing settings from multiple APIs for partial updates.

cache\_reserve: object {id, editable, value }

id: optional string The id of the Cache Reserve setting. Link to this property editable: optional boolean Whether the setting is editable. Link to this property

value: optional "on"or "off" Specifies the enablement value of Cache Reserve.

One of the following: "on" Link to this property "off" Link to this property

Link to this property

Link to this property healthchecks\_count: number The total number of health checks associated with the zone. Link to this property

regional\_tiered\_cache: object {id, editable, value }

id: optional string The id of the Regional Tiered Cache setting. Link to this property editable: optional boolean Whether the setting is editable. Link to this property

value: optional "on"or "off" Specifies the enablement value of Cache Reserve.

One of the following: "on" Link to this property "off" Link to this property

Link to this property

smart\_routing: object {id, editable, value }

id: optional string The id of the Smart Routing setting. Link to this property editable: optional boolean Whether the setting is editable. Link to this property

value: optional "on"or "off" Specifies the enablement value of Argo Smart Routing.

One of the following: "on" Link to this property "off" Link to this property

Link to this property

smart\_tiered\_cache: object {id, editable, modified\_on, value }

id: optional string The id of the Smart Tiered Cache setting. Link to this property editable: optional boolean Whether the setting is editable. Link to this property modified\_on: optional string The last time the setting was modified. Link to this property

value: optional "on"or "off" Specifies the enablement value of Tiered Cache.

One of the following: "on" Link to this property "off" Link to this property

Link to this property

[Link to this property](<#(resource)%20smart_shield%20%3E%20(model)%20smart_shield_get_response%20%3E%20(schema)>)

SmartShieldUpdateResponse object {smart\_tiered\_cache } A consolidated object containing settings from multiple APIs for partial updates.

smart\_tiered\_cache: object {id, editable, modified\_on, value }

value: optional "on"or "off" Specifies the enablement value of Tiered Cache.

One of the following: "on" Link to this property "off" Link to this property

Link to this property

[Link to this property](<#(resource)%20smart_shield%20%3E%20(model)%20smart_shield_update_response%20%3E%20(schema)>) #### Smart ShieldHealth Checks ##### [List Health Checks](https://developers.cloudflare.com/api/resources/smart_shield/subresources/health_checks/methods/list) GET/zones/{zone\_id}/smart\_shield/healthchecks ##### [Health Check Details](https://developers.cloudflare.com/api/resources/smart_shield/subresources/health_checks/methods/get) GET/zones/{zone\_id}/smart\_shield/healthchecks/{healthcheck\_id} ##### [Create Health Check](https://developers.cloudflare.com/api/resources/smart_shield/subresources/health_checks/methods/create) POST/zones/{zone\_id}/smart\_shield/healthchecks ##### [Update Health Check](https://developers.cloudflare.com/api/resources/smart_shield/subresources/health_checks/methods/update) PUT/zones/{zone\_id}/smart\_shield/healthchecks/{healthcheck\_id} ##### [Patch Health Check](https://developers.cloudflare.com/api/resources/smart_shield/subresources/health_checks/methods/edit) PATCH/zones/{zone\_id}/smart\_shield/healthchecks/{healthcheck\_id} ##### [Delete Health Check](https://developers.cloudflare.com/api/resources/smart_shield/subresources/health_checks/methods/delete) DELETE/zones/{zone\_id}/smart\_shield/healthchecks/{healthcheck\_id} ##### ModelsExpand Collapse

HealthCheckListResponse object {id, address, check\_regions, 15 more }

id: optional string Identifier. maxLength32 Link to this property address: optional string The hostname or IP address of the origin server to run health checks on. Link to this property

check\_regions: optional array of "WNAM"or "ENAM"or "WEU"or 11 more A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

One of the following: "WNAM" Link to this property "ENAM" Link to this property "WEU" Link to this property "EEU" Link to this property "NSAM" Link to this property "SSAM" Link to this property "OC" Link to this property "ME" Link to this property "NAF" Link to this property "SAF" Link to this property "IN" Link to this property "SEAS" Link to this property "NEAS" Link to this property "ALL\_REGIONS" Link to this property

Link to this property consecutive\_fails: optional number The number of consecutive fails required from a health check before changing the health to unhealthy. Link to this property consecutive\_successes: optional number The number of consecutive successes required from a health check before changing the health to healthy. Link to this property created\_on: optional string formatdate-time Link to this property description: optional string A human-readable description of the health check. Link to this property failure\_reason: optional string The current failure reason if status is unhealthy. Link to this property

http\_config: optional object {allow\_insecure, expected\_body, expected\_codes, 5 more } Parameters specific to an HTTP or HTTPS health check.

allow\_insecure: optional boolean Do not validate the certificate when the health check uses HTTPS. Link to this property expected\_body: optional string A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. Link to this property expected\_codes: optional array of string The expected HTTP response codes (e.g. “200”) or code ranges (e.g. “2xx” for all codes starting with 2) of the health check. Link to this property follow\_redirects: optional boolean Follow redirects if the origin returns a 3xx status code. Link to this property header: optional map\[array of string] The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. Link to this property

method: optional "GET"or "HEAD" The HTTP method to use for the health check.

One of the following: "GET" Link to this property "HEAD" Link to this property

Link to this property path: optional string The endpoint path to health check against. Link to this property port: optional number Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS. Link to this property

Link to this property interval: optional number The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations. Link to this property modified\_on: optional string formatdate-time Link to this property name: optional string A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed. Link to this property retries: optional number The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Link to this property

status: optional "unknown"or "healthy"or "unhealthy"or "suspended" The current status of the origin server according to the health check.

One of the following: "unknown" Link to this property "healthy" Link to this property "unhealthy" Link to this property "suspended" Link to this property

Link to this property suspended: optional boolean If suspended, no health checks are sent to the origin. Link to this property

tcp\_config: optional object {method, port } Parameters specific to TCP health check.

method: optional "connection\_established" The TCP connection method to use for the health check. Link to this property port: optional number Port number to connect to for the health check. Defaults to 80. Link to this property

Link to this property timeout: optional number The timeout (in seconds) before marking the health check as failed. Link to this property type: optional string The protocol to use for the health check. Currently supported protocols are ‘HTTP’, ‘HTTPS’ and ‘TCP’. Link to this property

[Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(model)%20health_check_list_response%20%3E%20(schema)>)

HealthCheckGetResponse object {id, address, check\_regions, 15 more }

id: optional string Identifier. maxLength32 Link to this property address: optional string The hostname or IP address of the origin server to run health checks on. Link to this property

check\_regions: optional array of "WNAM"or "ENAM"or "WEU"or 11 more A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

http\_config: optional object {allow\_insecure, expected\_body, expected\_codes, 5 more } Parameters specific to an HTTP or HTTPS health check.

method: optional "GET"or "HEAD" The HTTP method to use for the health check.

One of the following: "GET" Link to this property "HEAD" Link to this property

status: optional "unknown"or "healthy"or "unhealthy"or "suspended" The current status of the origin server according to the health check.

One of the following: "unknown" Link to this property "healthy" Link to this property "unhealthy" Link to this property "suspended" Link to this property

Link to this property suspended: optional boolean If suspended, no health checks are sent to the origin. Link to this property

tcp\_config: optional object {method, port } Parameters specific to TCP health check.

[Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(model)%20health_check_get_response%20%3E%20(schema)>)

HealthCheckCreateResponse object {id, address, check\_regions, 15 more }

id: optional string Identifier. maxLength32 Link to this property address: optional string The hostname or IP address of the origin server to run health checks on. Link to this property

check\_regions: optional array of "WNAM"or "ENAM"or "WEU"or 11 more A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

http\_config: optional object {allow\_insecure, expected\_body, expected\_codes, 5 more } Parameters specific to an HTTP or HTTPS health check.

method: optional "GET"or "HEAD" The HTTP method to use for the health check.

One of the following: "GET" Link to this property "HEAD" Link to this property

status: optional "unknown"or "healthy"or "unhealthy"or "suspended" The current status of the origin server according to the health check.

One of the following: "unknown" Link to this property "healthy" Link to this property "unhealthy" Link to this property "suspended" Link to this property

Link to this property suspended: optional boolean If suspended, no health checks are sent to the origin. Link to this property

tcp\_config: optional object {method, port } Parameters specific to TCP health check.

[Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(model)%20health_check_create_response%20%3E%20(schema)>)

HealthCheckUpdateResponse object {id, address, check\_regions, 15 more }

id: optional string Identifier. maxLength32 Link to this property address: optional string The hostname or IP address of the origin server to run health checks on. Link to this property

check\_regions: optional array of "WNAM"or "ENAM"or "WEU"or 11 more A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

http\_config: optional object {allow\_insecure, expected\_body, expected\_codes, 5 more } Parameters specific to an HTTP or HTTPS health check.

method: optional "GET"or "HEAD" The HTTP method to use for the health check.

One of the following: "GET" Link to this property "HEAD" Link to this property

status: optional "unknown"or "healthy"or "unhealthy"or "suspended" The current status of the origin server according to the health check.

One of the following: "unknown" Link to this property "healthy" Link to this property "unhealthy" Link to this property "suspended" Link to this property

Link to this property suspended: optional boolean If suspended, no health checks are sent to the origin. Link to this property

tcp\_config: optional object {method, port } Parameters specific to TCP health check.

[Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(model)%20health_check_update_response%20%3E%20(schema)>)

HealthCheckEditResponse object {id, address, check\_regions, 15 more }

id: optional string Identifier. maxLength32 Link to this property address: optional string The hostname or IP address of the origin server to run health checks on. Link to this property

check\_regions: optional array of "WNAM"or "ENAM"or "WEU"or 11 more A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

http\_config: optional object {allow\_insecure, expected\_body, expected\_codes, 5 more } Parameters specific to an HTTP or HTTPS health check.

method: optional "GET"or "HEAD" The HTTP method to use for the health check.

One of the following: "GET" Link to this property "HEAD" Link to this property

status: optional "unknown"or "healthy"or "unhealthy"or "suspended" The current status of the origin server according to the health check.

One of the following: "unknown" Link to this property "healthy" Link to this property "unhealthy" Link to this property "suspended" Link to this property

Link to this property suspended: optional boolean If suspended, no health checks are sent to the origin. Link to this property

tcp\_config: optional object {method, port } Parameters specific to TCP health check.

[Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(model)%20health_check_edit_response%20%3E%20(schema)>)

HealthCheckDeleteResponse object {id }

id: optional string Identifier. maxLength32 Link to this property

[Link to this property](<#(resource)%20smart_shield.health_checks%20%3E%20(model)%20health_check_delete_response%20%3E%20(schema)>) #### Smart ShieldCache Reserve Clear ##### [Get Cache Reserve Clear](https://developers.cloudflare.com/api/resources/smart_shield/subresources/cache_reserve_clear/methods/status) GET/zones/{zone\_id}/smart\_shield/cache\_reserve\_clear ##### [Start Cache Reserve Clear](https://developers.cloudflare.com/api/resources/smart_shield/subresources/cache_reserve_clear/methods/clear) POST/zones/{zone\_id}/smart\_shield/cache\_reserve\_clear ##### ModelsExpand Collapse

CacheReserveClearStatusResponse object {id, start\_ts, state, 2 more } You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

id: CacheReserveClear ID of the zone setting. Link to this property start\_ts: string The time that the latest Cache Reserve Clear operation started. formatdate-time Link to this property

state: "In-progress"or "Completed" The current state of the Cache Reserve Clear operation.

One of the following: "In-progress" Link to this property "Completed" Link to this property

Link to this property end\_ts: optional string The time that the latest Cache Reserve Clear operation completed. formatdate-time Link to this property modified\_on: optional string Last time this setting was modified. formatdate-time Link to this property

[Link to this property](<#(resource)%20smart_shield.cache_reserve_clear%20%3E%20(model)%20cache_reserve_clear_status_response%20%3E%20(schema)>)

CacheReserveClearClearResponse object {id, start\_ts, state, 2 more } You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

id: CacheReserveClear ID of the zone setting. Link to this property start\_ts: string The time that the latest Cache Reserve Clear operation started. formatdate-time Link to this property

state: "In-progress"or "Completed" The current state of the Cache Reserve Clear operation.

One of the following: "In-progress" Link to this property "Completed" Link to this property

[Link to this property](<#(resource)%20smart_shield.cache_reserve_clear%20%3E%20(model)%20cache_reserve_clear_clear_response%20%3E%20(schema)>)