Reference

Cache API

Endpoints under /api/cache, from the com_cache API controllers. Authenticate with an OAuth bearer token or a session cookie; see the developers book for the API basics.

Method Endpoint Purpose
DELETE /cache/clean Clean one or more cache groups
GET /cache/list Display a list of entries
DELETE /cache/purge Purge expired data

DELETE /cache/clean

Clean one or more cache groups

API version 1.0, task clean in cachev1_0.php.

Parameter Type Required Default Description
group string|array yes Cache groups to clean

GET /cache/list

Display a list of entries

API version 1.0, task list in cachev1_0.php.

Parameter Type Required Default Description
clientId integer yes 0 Client to manage cache data for
limit integer no 25 Number of result to return.
start integer no 0 Number of where to start returning results.
sort string no created Field to sort results by.
sort_Dir string no desc Direction to sort results by.

DELETE /cache/purge

Purge expired data

API version 1.0, task purge in cachev1_0.php.

Generated from the source tree.