Get Cache Configuration
GET /obp/v7.0.0/system/cache/config
OBPv6.0.0-getCacheConfig Roles: CanGetCacheConfig CacheSystemAPI
Returns cache configuration information including:
- Redis status: availability, connection details (URL, port, SSL)
- In-memory cache status: availability and current size
- Instance ID and environment
- Global cache namespace prefix
This helps understand what cache backend is being used and how it's configured.
Authentication is Required
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields (10)
- available
- available
- current_size
- current_size
- environment
- environment
- global_prefix
- global_prefix
- in_memory_status
- in_memory_status
- instance_id
- instance_id
- port
- port
- redis_status
- redis_status
- url
- http://www.example.com/id-docs/123/image.png
- use_ssl
- use_ssl
Example success response
{
"redis_status": {
"available": true,
"url": "127.0.0.1",
"port": 6379,
"use_ssl": false
},
"in_memory_status": {
"available": true,
"current_size": 42
},
"instance_id": "obp",
"environment": "dev",
"global_prefix": "obp_dev_"
}Possible errors (3)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.