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 WriteZone Settings ReadZone ReadZone Write

Path ParametersExpand Collapse

zone_id: string

Identifier.

maxLength32

ReturnsExpand Collapse

errors: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

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.

editable: optional boolean

Whether the setting is editable.

value: optional "on" or "off"

Specifies the enablement value of Cache Reserve.

One of the following:

"on"

"off"

healthchecks_count: number

The total number of health checks associated with the zone.

regional_tiered_cache: object { id, editable, value }

id: optional string

The id of the Regional Tiered Cache setting.

editable: optional boolean

Whether the setting is editable.

value: optional "on" or "off"

Specifies the enablement value of Cache Reserve.

One of the following:

"on"

"off"

smart_routing: object { id, editable, value }

id: optional string

The id of the Smart Routing setting.

editable: optional boolean

Whether the setting is editable.

value: optional "on" or "off"

Specifies the enablement value of Argo Smart Routing.

One of the following:

"on"

"off"

smart_tiered_cache: object { id, editable, modified_on, value }

id: optional string

The id of the Smart Tiered Cache setting.

editable: optional boolean

Whether the setting is editable.

modified_on: optional string

The last time the setting was modified.

value: optional "on" or "off"

Specifies the enablement value of Tiered Cache.

One of the following:

"on"

"off"

success: true

Whether the API call was successful.

Get Smart Shield Settings

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/smart_shield \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "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

{
  "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
}