Skip to main content

Cache Management API

REST interface for Dragonfly/Redis operations — supports all major data types: strings, hashes, lists, sets, and sorted sets.

FieldValue
Port50035
Base Path/api/v1/cache
OpenAPI3.0.1
SpecCache_Mgmt_API.json

Key Management

MethodPathDescription
GET/api/v1/cache/keys/scanScan keys with pattern (cursor-based)
GET/api/v1/cache/keys/{key}/typeGet key data type
GET/api/v1/cache/keys/{key}/ttlGet TTL
PUT/api/v1/cache/keys/{key}/expireSet expiration
PUT/api/v1/cache/keys/{key}/persistRemove expiration
PUT/api/v1/cache/keys/{key}/renameRename key
DELETE/api/v1/cache/keys/{key}Delete key
DELETE/api/v1/cache/keys/bulk-deleteBulk delete by pattern

String Operations

MethodPathDescription
GET/api/v1/cache/strings/{key}Get string value
PUT/api/v1/cache/strings/{key}Set string value
DELETE/api/v1/cache/strings/{key}Delete string
// SetStringRequest
{
"value": "string (required)",
"ttlSeconds": 3600,
"condition": "NX | XX"
}

NX = set only if key does not exist. XX = set only if key exists.


Hash Operations

MethodPathDescription
GET/api/v1/cache/hashes/{key}Get all hash fields
GET/api/v1/cache/hashes/{key}/{field}Get specific field
PUT/api/v1/cache/hashes/{key}Set hash fields
DELETE/api/v1/cache/hashes/{key}/{field}Delete field

List Operations

MethodPathDescription
GET/api/v1/cache/lists/{key}Get list range
GET/api/v1/cache/lists/{key}/{index}Get element at index
POST/api/v1/cache/lists/{key}/pushPush elements
POST/api/v1/cache/lists/{key}/popPop element
PUT/api/v1/cache/lists/{key}/{index}Set element at index
PUT/api/v1/cache/lists/{key}/trimTrim list to range
// ListPushRequest
{
"values": ["value1", "value2"],
"direction": "LEFT | RIGHT"
}

Set Operations

MethodPathDescription
GET/api/v1/cache/sets/{key}Get all members
POST/api/v1/cache/sets/{key}/addAdd members
DELETE/api/v1/cache/sets/{key}/removeRemove members
GET/api/v1/cache/sets/{key}/ismember/{member}Check membership
POST/api/v1/cache/sets/unionUnion of sets
POST/api/v1/cache/sets/intersectIntersection of sets
POST/api/v1/cache/sets/diffDifference of sets

Sorted Set Operations

MethodPathDescription
GET/api/v1/cache/zsets/{key}Get by rank range
POST/api/v1/cache/zsets/{key}/addAdd members with scores
DELETE/api/v1/cache/zsets/{key}/removeRemove members
GET/api/v1/cache/zsets/{key}/score/{member}Get member score
GET/api/v1/cache/zsets/{key}/rank/{member}Get member rank
GET/api/v1/cache/zsets/{key}/range-by-scoreGet by score range

Health

MethodPathDescription
GET/api/v1/cache/healthHealth check
GET/api/v1/cache/infoServer info (memory, clients, stats)
GET/api/v1/cache/dbsizeTotal key count

Frontend Integration

FilePurpose
services/cacheApi.tsCache key operations
hooks/useCacheManagement.tsReact Query hook