You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com. |
Caches
API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}
API Resource Path: /environments/{env_name}/caches |
A lightweight persistence store that can be used by policies or code executing on the Apigee Edge. |
To support data segregation, cache resources are scoped to environments. For usage, Creating and editing an environment cache. |
Clear all cache entries | Detail | |
/environments/{env_name}/caches/{cache_name}/entries?action=clear
|
||
Verb: | POST | |
Description: | Clears all entries from the specified cache. Entries to be cleared can be scoped by CacheKey prefix by using the 'prefix' parameter. | |
Media types: |
application/octet-stream
|
|
Auth: | Basic Auth | |
Clear cache entry | Detail | |
/environments/{env_name}/caches/{cache_name}/entries/{entry}?action=clear
|
||
Verb: | POST | |
Description: | Clears the cache entry, which by the full CacheKey prefix and value | |
Media types: |
application/octet-stream
|
|
Auth: | Basic Auth | |
Create a cache | Detail | |
/environments/{env_name}/caches
|
||
Verb: | POST | |
Description: | Creates a cache in an environment | |
Media types: |
application/json
text/xml
|
|
Auth: | Basic Auth | |
Get a cache configuration | Detail | |
/environments/{env_name}/caches/{cache_name}
|
||
Verb: | GET | |
Description: | Gets a representation of a a cache resource | |
Media types: |
application/json
text/xml
|
|
Auth: | Basic Auth | |
List caches in an environment | Detail | |
/environments/{env_name}/caches
|
||
Verb: | GET | |
Description: | Returns a list of caches that are available in an environment | |
Media types: |
application/json
text/xml
|
|
Auth: | Basic Auth | |
Update a cache | Detail | |
/environments/{env_name}/caches/{cache_name}
|
||
Verb: | POST | |
Description: | Updates the configuration of an existing cache | |
Media types: |
application/json
text/xml
|
|
Auth: | Basic Auth | |
Delete a cache | Detail | |
/environments/{env_name}/caches/{cache_name}
|
||
Verb: | DELETE | |
Description: | Delete an existing cache | |
Auth: | Basic Auth |
Help or comments?
- If something's not working: Ask the Apigee Community or see Apigee Support.
- If something's wrong with the docs: Click the "Send Feedback" button.
(Incorrect? Unclear? Broken link? Typo?)