POST
/api/v1/cache/clear/{cacheType} Clears a specific cache type. Valid types: capabilities, collections, features, counts, tiles. Requires super_admin role.
Operation ID: clearCacheByType
Authentication
Use one of the following authentication options. Permissions and workspace scope still apply. See authentication and access control.
-
Authorization: Bearer YOUR_ACCESS_TOKEN -
X-API-Key: YOUR_API_KEY
Parameters
-
cacheTypepath required -
Cache type to clear
string- Allowed values
-
["capabilities","collections","features","counts","tiles"]
Responses
200 Cache cleared successfully
Content type application/json
object
-
messagestring -
typestring
400 Invalid cache type or caching not enabled
Content type application/json
401 Unauthorized
Content type application/json
403 Forbidden - requires super_admin role
Content type application/json
413 Request body exceeds the configured limit
Content type application/json
426 HTTPS required
Content type application/json
429 Request rate exceeded
Content type application/json
503 Service temporarily unavailable
Content type application/json
OpenAPI operation definition
{
"description": "Clears a specific cache type. Valid types: capabilities, collections, features, counts, tiles. Requires super_admin role.",
"operationId": "clearCacheByType",
"parameters": [
{
"description": "Cache type to clear",
"in": "path",
"name": "cacheType",
"required": true,
"schema": {
"enum": [
"capabilities",
"collections",
"features",
"counts",
"tiles"
],
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Cache cleared successfully"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Invalid cache type or caching not enabled"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Forbidden - requires super_admin role"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Request body exceeds the configured limit"
},
"426": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "HTTPS required"
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Request rate exceeded"
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Service temporarily unavailable"
}
},
"summary": "Clear specific cache type",
"tags": [
"Cache"
]
}