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.
/zones/{zone_identifier}/cache/cache_reserve_clear
post
Zone Cache Settings
zone-cache-settings-start-cache-reserve-clear
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}{
"enum": [
"#zone_settings:edit"
]
}[
{
"in": "path",
"name": "zone_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"example": "{}"
}
},
"description": "The request body is currently not used.",
"required": true
}{
"200": {
"content": {
"application/json": {
"examples": {
"In-progress": {
"value": {
"errors": [],
"messages": [],
"result": {
"id": "cache_reserve_clear",
"start_ts": "2023-10-02T10:00:00.12345Z",
"state": "In-progress"
},
"success": true
}
}
},
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"type": "object"
}
}
}
]
},
{
"properties": {
"result": {
"allOf": [
{
"allOf": [
{
"properties": {
"id": {
"description": "Identifier of the zone setting.",
"type": "string"
},
"modified_on": {
"description": "last time this setting was modified.",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"id",
"modified_on"
]
},
{
"properties": {
"id": {
"description": "ID of the zone setting.",
"enum": [
"cache_reserve_clear"
],
"example": "cache_reserve_clear"
}
}
}
],
"description": "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.",
"title": "Cache Reserve Clear"
},
{
"properties": {
"end_ts": {
"description": "The time that the latest Cache Reserve Clear operation completed.",
"example": "2023-10-02T12:00:00.12345Z",
"format": "date-time",
"type": "string"
},
"start_ts": {
"description": "The time that the latest Cache Reserve Clear operation started.",
"example": "2023-10-02T10:00:00.12345Z",
"format": "date-time",
"type": "string"
},
"state": {
"description": "The current state of the Cache Reserve Clear operation.",
"enum": [
"In-progress",
"Completed"
],
"example": "In-progress",
"type": "string"
}
},
"required": [
"state",
"start_ts"
]
}
]
}
}
}
]
}
}
},
"description": "Start Cache Reserve Clear response"
},
"4XX": {
"content": {
"application/json": {
"examples": {
"Rejected": {
"value": {
"errors": [
{
"code": 1152,
"message": "Turn off Cache Reserve sync to proceed with deletion."
}
],
"messages": [],
"result": null,
"success": false
}
}
},
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"type": "object"
}
}
}
]
},
{
"properties": {
"result": {
"allOf": [
{
"allOf": [
{
"properties": {
"id": {
"description": "Identifier of the zone setting.",
"type": "string"
},
"modified_on": {
"description": "last time this setting was modified.",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"id",
"modified_on"
]
},
{
"properties": {
"id": {
"description": "ID of the zone setting.",
"enum": [
"cache_reserve_clear"
],
"example": "cache_reserve_clear"
}
}
}
],
"description": "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.",
"title": "Cache Reserve Clear"
},
{
"properties": {
"end_ts": {
"description": "The time that the latest Cache Reserve Clear operation completed.",
"example": "2023-10-02T12:00:00.12345Z",
"format": "date-time",
"type": "string"
},
"start_ts": {
"description": "The time that the latest Cache Reserve Clear operation started.",
"example": "2023-10-02T10:00:00.12345Z",
"format": "date-time",
"type": "string"
},
"state": {
"description": "The current state of the Cache Reserve Clear operation.",
"enum": [
"In-progress",
"Completed"
],
"example": "In-progress",
"type": "string"
}
},
"required": [
"state",
"start_ts"
]
}
]
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Start Cache Reserve Clear failure response"
}
}[
{
"api_email": [],
"api_key": []
}
]