Skip to content

Invalidate Cache Entry

DELETE
/api/system/cache/invalidate

Invalidate specific cache entry (cache module removed - no-op).

CacheInvalidateRequest

Request model for cache invalidation.

Used for invalidating (deleting) a specific cache entry by key. More surgical than clearing the entire cache, minimizing backend load increase.

Fields:

  • key: Cache key to invalidate (required, string)
  • service_name: Service cache, None for global cache (optional, string | None)

Usage: DELETE /api/system/cache/invalidate accepts this request model for invalidating entries.

JSON Example:

{
  "key": "workflow:123:result",
  "serviceName": "workflow"
}
object
key
required
Key

Cache key to invalidate

string
serviceName
Any of:
string

Successful Response

CacheInvalidateResponse

Response model for cache invalidation.

Provides confirmation of cache entry invalidation with key existence status.

Fields:

  • success: Whether invalidation succeeded (required, boolean)
  • key: Echo of invalidated key (required, string)
  • found: Whether key existed in cache (required, boolean)

Usage: DELETE /api/system/cache/invalidate returns this response model with invalidation results.

JSON Example:

{
  "success": true,
  "key": "workflow:123:result",
  "found": true
}
object
success
required
Success

Whether invalidation succeeded

boolean
key
required
Key

Key that was invalidated

string
found
required
Found

Whether key existed in cache

boolean

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object