Skip to content

Get Cache Status

GET
/api/system/cache/status

Get overall cache system status (cache module removed).

Successful Response

CacheStatusResponse

Response for cache system status and configuration.

Provides overall operational status of the caching system including backend type, global cache size, service cache count, and total cached entries. Essential for monitoring cache health and understanding system-wide caching coverage.

Fields:

  • enabled: Whether caching is active (required, boolean)
  • backend: Backend type - “memory” or “redis” (required, string)
  • global_cache_size: Global cache current size (required, integer)
  • service_cache_count: Number of service-specific caches (required, integer)
  • total_entries: Total cached entries across all caches (required, integer)

Usage: GET /api/system/cache/status returns this response model with cache system status.

JSON Example:

{
  "enabled": true,
  "backend": "memory",
  "globalCacheSize": 156,
  "serviceCacheCount": 8,
  "totalEntries": 1423
}
object
enabled
required
Enabled

Whether caching is active

boolean
backend
required
Backend

Backend type (memory or redis)

string
globalCacheSize
required
Globalcachesize

Global cache current size

integer
serviceCacheCount
required
Servicecachecount

Number of service-specific caches

integer
totalEntries
required
Totalentries

Total cached entries across all caches

integer