cache_reserve
Creates, updates, deletes, gets or lists a cache_reserve resource.
Overview
| Name | cache_reserve |
| Type | Resource |
| Id | cloudflare.zones.cache_reserve |
Fields
The following fields are returned by SELECT queries:
- get_clear_status
Get Cache Reserve Clear response.
| Name | Datatype | Description |
|---|---|---|
id | string | ID of the zone setting. (cache_reserve_clear) (example: cache_reserve_clear) |
end_ts | string (date-time) | The time that the latest Cache Reserve Clear operation completed. (example: 2023-10-02T12:00:00.12345Z) |
modified_on | string (date-time) | Last time this setting was modified. |
start_ts | string (date-time) | The time that the latest Cache Reserve Clear operation started. (example: 2023-10-02T10:00:00.12345Z) |
state | string | The current state of the Cache Reserve Clear operation. (In-progress, Completed) (example: In-progress) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_clear_status | select | zone_id | 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. | |
start_clear | exec | zone_id | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
zone_id | string | The Cloudflare zone ID. |
SELECT examples
- get_clear_status
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.
SELECT
id,
end_ts,
modified_on,
start_ts,
state
FROM cloudflare.zones.cache_reserve
WHERE zone_id = '{{ zone_id }}' -- required
;
Lifecycle Methods
- start_clear
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.
EXEC cloudflare.zones.cache_reserve.start_clear
@zone_id='{{ zone_id }}' --required
;