Skip to content

Configure Cache

POST
/api/system/cache/configure

Update cache configuration (cache module removed - no-op).

CacheConfigRequest

Request model for cache configuration update.

Used for updating cache parameters like maximum size and default TTL dynamically without requiring system restart. Allows runtime tuning of cache behavior.

Fields:

  • service_name: Service cache to configure, None for global (optional, string | None)
  • max_size: New maximum cache size (optional, integer | None)
  • default_ttl: New default TTL in seconds (optional, float | None)

Usage: POST /api/system/cache/configure accepts this request model for updating cache config.

JSON Example:

{
  "serviceName": "etherforce",
  "maxSize": 20000,
  "defaultTtl": 1800
}
object
serviceName
Any of:
string
maxSize
Any of:
integer
defaultTtl
Any of:
number

Successful Response

CacheConfigResponse

Response model for cache configuration.

Provides confirmation of cache configuration update with applied settings.

Fields:

  • success: Whether configuration was updated (required, boolean)
  • service_name: Service that was configured (required, string)
  • configuration: Applied configuration dictionary (required, JsonDict)

Usage: POST /api/system/cache/configure returns this response model with configuration results.

JSON Example:

{
  "success": true,
  "serviceName": "etherforce",
  "configuration": {
    "maxSize": 20000,
    "defaultTtl": 1800,
    "evictionStrategy": "lru"
  }
}
object
success
required
Success

Whether configuration was updated

boolean
serviceName
required
Servicename

Service that was configured

string
configuration
required

Applied configuration

object
key
additional properties
any

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