Skip to main content

 Web service API

How to use PageSeeder's Web service API

clear all cache

/caches/clear [POST]

com.pageseeder.cache.ClearCache

Description

Clear all caches.

Clearing all the caches might lead to a significant degradation of performance and has potential security implications:

If the “account-lockout” cache is cleared, all accounts are automatically unlocked.

As of PageSeeder 5.9, caches include the following list:

  • xml-documents
  • reset-password-lockout
  • validation-results
  • account-lockout
  • file-inspection
  • user-details
  • group-state

Whenever possible, and if the caches do need to be cleared, it might be more appropriate to clear individual caches.

Parameters

No parameters required.

Permission

This service requires administrator.

Response

When successful, this service returns the list of caches which have been 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"/>
  <cache name="reset-password-lockout"
guid="MY-PC/192.168.200.210-7ee40724-bbfc-4637-b0d1-b8b8b5b17cbc"/>
  <cache name="validation-results"
guid="MY-PC/192.168.200.210-a896ef63-dbdb-4ade-9b63-7a3629b1c41e"/>
  <cache name="account-lockout"
guid="MY-PC/192.168.200.210-471be945-3a79-468c-93c9-c87807e69a51"/>
  <cache name="file-inspection"
guid="MY-PC/192.168.200.210-f152257f-647d-4f4a-8c32-fa7e5dc3c0dc"/>
  <cache name="user-details"
guid="MY-PC/192.168.200.210-f5a92432-e8e6-4ff5-a5c7-928a748e2f81"/>
  <cache name="group-state"
guid="MY-PC/192.168.200.210-8afef95a-3bc8-49c4-943c-1e8889cc37ee"/>
</clear-cache>

Error Handling

No specific errors expected for this service.

Created on , last edited on