1# Cache Reserve Configuration
2 
3## Dashboard Setup
4 
5**Minimum steps to enable:**
6 
7```bash
8# Navigate to dashboard
9https://dash.cloudflare.com/caching/cache-reserve
10 
11# Click "Enable Storage Sync" or "Purchase" button
12```
13 
14**Prerequisites:**
15- Paid Cache Reserve plan or Smart Shield Advanced required
16- Tiered Cache **required** for Cache Reserve to function optimally
17 
18## API Configuration
19 
20### REST API
21 
22```bash
23# Enable
24curl -X PATCH "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/cache/cache_reserve" \
25  -H "Authorization: Bearer $API_TOKEN" -H "Content-Type: application/json" \
26  -d '{"value": "on"}'
27 
28# Check status
29curl -X GET "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/cache/cache_reserve" \
30  -H "Authorization: Bearer $API_TOKEN"
31```
32 
33### TypeScript SDK
34 
35```bash
36npm install cloudflare
37```
38 
39```typescript
40import Cloudflare from 'cloudflare';
41 
42const client = new Cloudflare({
43  apiToken: process.env.CLOUDFLARE_API_TOKEN,
44});
45 
46// Enable Cache Reserve
47await client.cache.cacheReserve.edit({
48  zone_id: 'abc123',
49  value: 'on',
50});
51 
52// Get Cache Reserve status
53const status = await client.cache.cacheReserve.get({
54  zone_id: 'abc123',
55});
56console.log(status.value); // 'on' or 'off'
57```
58 
59### Python SDK
60 
61```bash
62pip install cloudflare
63```
64 
65```python
66from cloudflare import Cloudflare
67 
68client = Cloudflare(api_token=os.environ.get("CLOUDFLARE_API_TOKEN"))
69 
70# Enable Cache Reserve
71client.cache.cache_reserve.edit(
72    zone_id="abc123",
73    value="on"
74)
75 
76# Get Cache Reserve status
77status = client.cache.cache_reserve.get(zone_id="abc123")
78print(status.value)  # 'on' or 'off'
79```
80 
81### Terraform
82 
83```hcl
84terraform {
85  required_providers {
86    cloudflare = {
87      source  = "cloudflare/cloudflare"
88      version = "~> 4.0"
89    }
90  }
91}
92 
93provider "cloudflare" {
94  api_token = var.cloudflare_api_token
95}
96 
97resource "cloudflare_zone_cache_reserve" "example" {
98  zone_id = var.zone_id
99  enabled = true
100}
101 
102# Tiered Cache is required for Cache Reserve
103resource "cloudflare_tiered_cache" "example" {
104  zone_id    = var.zone_id
105  cache_type = "smart"
106}
107```
108 
109### Pulumi
110 
111```typescript
112import * as cloudflare from "@pulumi/cloudflare";
113 
114// Enable Cache Reserve
115const cacheReserve = new cloudflare.ZoneCacheReserve("example", {
116  zoneId: zoneId,
117  enabled: true,
118});
119 
120// Enable Tiered Cache (required)
121const tieredCache = new cloudflare.TieredCache("example", {
122  zoneId: zoneId,
123  cacheType: "smart",
124});
125```
126 
127### Required API Token Permissions
128 
129- `Zone Settings Read`
130- `Zone Settings Write`
131- `Zone Read`
132- `Zone Write`
133 
134## Cache Rules Integration
135 
136Control Cache Reserve eligibility via Cache Rules:
137 
138```typescript
139// Enable for static assets
140{
141  action: 'set_cache_settings',
142  action_parameters: {
143    cache_reserve: { eligible: true, minimum_file_ttl: 86400 },
144    edge_ttl: { mode: 'override_origin', default: 86400 },
145    cache: true
146  },
147  expression: '(http.request.uri.path matches "\\.(jpg|png|webp|pdf|zip)$")'
148}
149 
150// Disable for APIs
151{
152  action: 'set_cache_settings',
153  action_parameters: { cache_reserve: { eligible: false } },
154  expression: '(http.request.uri.path matches "^/api/")'
155}
156 
157// Create via API: PUT to zones/{zone_id}/rulesets/phases/http_request_cache_settings/entrypoint
158```
159 
160## Wrangler Integration
161 
162Cache Reserve works automatically with Workers deployed via Wrangler. No special wrangler.jsonc configuration needed - enable Cache Reserve via Dashboard or API for the zone.
163 
164## See Also
165 
166- [README](./README.md) - Overview and core concepts
167- [API Reference](./api.md) - Purging and monitoring APIs
168- [Patterns](./patterns.md) - Best practices and optimization
169- [Gotchas](./gotchas.md) - Common issues and troubleshooting
170