---
title: Get Smart Shield Settings
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Smart Shield](https://developers.cloudflare.com/api/resources/smart_shield)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Get Smart Shield Settings
GET/zones/{zone\_id}/smart\_shield
Retrieve Smart Shield Settings.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Zone Settings Write``Zone Settings Read``Zone Read``Zone Write`
##### P ath ParametersExpand Collapse
zone\_id: string
Identifier.
maxLength32
[Link to this property](<#(resource)%20smart_shield%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20smart_shield%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20smart_shield%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: 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
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
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
[Link to this property](<#(resource)%20smart_shield%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
Whether the API call was successful.
[Link to this property](<#(resource)%20smart_shield%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### Get Smart Shield Settings
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/smart_shield \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
500 example
502 example
4XX example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"cache_reserve": {
"id": "cache_reserve",
"editable": true,
"value": "off"
},
"healthchecks_count": 5,
"regional_tiered_cache": {
"id": "regional_tiered_cache",
"editable": true,
"value": "off"
},
"smart_routing": {
"id": "smart_routing",
"editable": true,
"value": "off"
},
"smart_tiered_cache": {
"id": "smart_tiered_cache",
"editable": true,
"modified_on": "2025-09-10T22:53:22.946098Z",
"value": "on"
}
},
"success": true
}
```
```
{
"errors": [
{
"code": 1137,
"message": "Unable to process request. Internal error."
}
],
"messages": [],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 1016,
"message": "Unable to retrieve smart_tiered_cache."
},
{
"code": 1016,
"message": "Unable to retrieve cache_reserve."
},
{
"code": 1016,
"message": "Unable to retrieve smart_routing."
},
{
"code": 1016,
"message": "Unable to retrieve regional_tiered_cache."
},
{
"code": 1016,
"message": "Unable to retrieve healthchecks_count."
}
],
"messages": [],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 1034,
"message": "Upgrade Smart Shield to unlock smart_tiered_cache."
},
{
"code": 1034,
"message": "Upgrade Smart Shield to unlock argo_smart_routing."
},
{
"code": 1034,
"message": "Upgrade Smart Shield to unlock regional_tiered_cache."
},
{
"code": 1034,
"message": "Upgrade Smart Shield to unlock cache_reserve."
},
{
"code": 1034,
"message": "Upgrade Smart Shield to unlock healthchecks_count."
}
],
"messages": [],
"result": null,
"success": false
}
```
##### Returns Examples
200 example
500 example
502 example
4XX example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"cache_reserve": {
"id": "cache_reserve",
"editable": true,
"value": "off"
},
"healthchecks_count": 5,
"regional_tiered_cache": {
"id": "regional_tiered_cache",
"editable": true,
"value": "off"
},
"smart_routing": {
"id": "smart_routing",
"editable": true,
"value": "off"
},
"smart_tiered_cache": {
"id": "smart_tiered_cache",
"editable": true,
"modified_on": "2025-09-10T22:53:22.946098Z",
"value": "on"
}
},
"success": true
}
```
```
{
"errors": [
{
"code": 1137,
"message": "Unable to process request. Internal error."
}
],
"messages": [],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 1016,
"message": "Unable to retrieve smart_tiered_cache."
},
{
"code": 1016,
"message": "Unable to retrieve cache_reserve."
},
{
"code": 1016,
"message": "Unable to retrieve smart_routing."
},
{
"code": 1016,
"message": "Unable to retrieve regional_tiered_cache."
},
{
"code": 1016,
"message": "Unable to retrieve healthchecks_count."
}
],
"messages": [],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 1034,
"message": "Upgrade Smart Shield to unlock smart_tiered_cache."
},
{
"code": 1034,
"message": "Upgrade Smart Shield to unlock argo_smart_routing."
},
{
"code": 1034,
"message": "Upgrade Smart Shield to unlock regional_tiered_cache."
},
{
"code": 1034,
"message": "Upgrade Smart Shield to unlock cache_reserve."
},
{
"code": 1034,
"message": "Upgrade Smart Shield to unlock healthchecks_count."
}
],
"messages": [],
"result": null,
"success": false
}
```