Web service API

How to use PageSeeder's Web service API

get cache

/caches/{name} [GET]

com.pageseeder.cache.GetCacheInfo

Description

Return information about a specific cache

Parameters

No parameters required.

Permission

Only administrators can use this service.

Response

When the response is successful, the returned XML include information about the cache as well as its configuration.

<cache disabled="false"
     name="user-details" 
     status="STATUS_ALIVE" 
     guid="MY-PC/192.168.200.210-f5d9a7f3-4996-4cd9-b800-6641983e54e8">
 <info size="1"/>
 <configuration memory-store-eviction-policy="LRU"
                count-based-tuned="true" 
                copy-on-write="false" 
                copy-on-read="false" 
                clear-on-flush="true" 
                eternal="false" 
                max-bytes-local-heap-percentage-set="false" 
                max-bytes-local-heap="0" 
                max-bytes-local-disk-percentage-set="false" 
                max-bytes-local-disk="0" 
                max-entries-local-heap="10000" 
                max-entries-local-disk="1000000" 
                disk-expiry-thread-interval-seconds="300" 
                disk-spool-buffer-size-mb="30"/>
</cache>

Warning!

This XML format is subject to change

Error Handling

No specific errors expected.

Created on , last edited on