Skip to main content

 Web service API

How to use PageSeeder's Web service API

clear cache

/caches/{name}/clear [POST]

com.pageseeder.cache.ClearCache

Description

Clears the cache content of a specific cache.

To retrieve the list of valid cache names, use the /caches [GET] service.

Parameters

No parameters required.

Permission

This service requires administrator.

Response

When successful, this service returns the cache that was cleared wrapped in a <clear-cache> element as in the following example:

<clear-cache>
  <cache name="xml-documents"
guid="MY-PC/192.168.200.210-860d089c-62e9-4f2a-9081-e79a2989c0ef"/>
</clear-cache>

Error Handling

If the cache name does not exist, this service returns the following:

<error id="0800">
  <request>/ps/service/caches/does-not-exist/clear</request>
  <message>Runtime exception thrown by generator</message>
</error>
Created on , last edited on