Caching
The engine exposes an admin-only cache management API at /api/caching for inspecting and clearing in-memory caches (for example entity or plugin caches).
All caching endpoints require an authenticated BSH_ADMIN session or equivalent admin credentials.
The Engine Dashboard provides a UI for managing caches.
Capabilities
- List cache names
- Search cache metadata
- Read cache info by name
- Clear one cache, a list of caches, or all caches
API
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/caching?name=… | Create/register a cache (query params: maximumSize, expireAfterWriteSeconds, expireAfterAccessSeconds) |
| GET | /api/caching/names | List cache names |
| GET | /api/caching/{cacheName} | Cache details |
| POST | /api/caching/search | Search caches (BSH Search body) |
| DELETE | /api/caching/{cacheName} | Clear a cache |
| DELETE | /api/caching/all | Clear all caches |
SDK
Use bshEngine.caching — see Caching service.