This is the documentation for a previous version of our product. Click here to see the latest version.

Custom Dictionary Cache

Cache availability

The custom dictionary cache is only available in the Real-Time Virtual Appliance.

When the Real-Time Virtual Appliance is started for the first time the cache will be empty. The administration allows to retrieve cache usage data and to purge the cache contents.

View Cache Usage

Cache usage reports the total amount of bytes and the used amount of bytes in the cache.

In order to retrieve usage stats, use a GET request to the /v1/management/cache endpoint:

curl -L -X GET http://${APPLIANCE_HOST}:8080/v1/management/cache \
-H 'Accept: application/json' \
| jq

Here is an example response:

{
  "total_bytes": "105188352",
  "used_bytes": "192512"
}

Purge Cache Contents

It is possible to remove all contents in the cache.

In order to purge the cache contents, use a DELETE request to the /v1/management/cache endpoint:

curl -L -X DELETE http://${APPLIANCE_HOST}:8080/v1/management/cache \
-H 'Accept: application/json' \
| jq

Here is an example response:

{
  "confirmation": "Custom dictionary cache purged successfully",
  "usage": {
    "total_bytes": "105188352",
    "used_bytes": "14336"
  }
}