REST API

REST API

OIE Cache Manager exposes a REST API for programmatic access to cache definitions and operations. The base path is:

/api/extensions/oie-cache-manager

Interactive Documentation

Full endpoint documentation — including request/response schemas, parameter descriptions, and the ability to try calls live — is available through OIE's built-in Swagger UI. Look for the OIE Cache Manager tag.

Authentication

All API requests require authentication using OIE credentials. Use HTTP Basic Authentication or session-based authentication consistent with other OIE API calls.

Permissions

Operation Type	Required Permission
Read (list, get, statistics, snapshot)	SERVER_SETTINGS_VIEW
Write (create, update, delete, refresh, test)	SERVER_SETTINGS_EDIT

Validation Rules

The Create and Update endpoints validate the CacheDefinition body before processing. If validation fails, the server returns 400 Bad Request with a descriptive error message.

Field	Rule
name	Required, must not be blank
driver	Required, must not be blank
url	Required, must not be blank
query	Required, must not be blank
valueColumn	Required, must not be blank
maxSize	Must be non-negative (0 means unlimited)
evictionDurationMinutes	Must be non-negative (0 means no time-based eviction)
maxConnections	Must be at least 1

---

← Using Caches in Channels | Next: Troubleshooting →