remove cache element
/caches/{name}/elements/{key}/remove [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.5000 | 5.9500 | xml, json |
Description
Removes an entry from the cache content.
Parameters
No parameters required.
Permission
This service requires administrator.
Response
When the response is successful, the XML response includes the element that was removed as well as the affected cache wrapped in a <clear-entry>
element.
Example of a successful response:
<clear-entry> <cache name="xml-documents" guid="MY-PC/192.168.200.210-860d089c-62e9-4f2a-9081-e79a2989c0ef"/> <element key="4-1-" removed="true"/> </clear-entry>
If the key does not exist, the response is identical to when the response is successful.
<clear-entry> <cache name="xml-documents" guid="MY-PC/192.168.200.210-860d089c-62e9-4f2a-9081-e79a2989c0ef"/> <element key="5" removed="false"/> </clear-entry>
Error Handling
If the cache name does not exist, this service returns:
<clear-entry> <no-cache name="brazil"/> </clear-entry>