Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Warning

These REST services have been deprecated and replaced by the newer API here: Ceptor Agent REST API


The Rest services server allows for access to status and statistics information through rest services. These are configured as shown here in the portalprotectceptor-configuration.xml

Code Block
languagexml
<server name="restservices" type="app" description="RestServices server" extends="applications">
  <group name="general" description="general configuration">
    <property name="sessioncookiename" value="sessionid" description="The name of the session cookie used to login if admin.logintype=sessionid"/>
    <property name="json.prettyoutput" value="true" description="Formats the output JSON object data in a pretty readable way (takes more bandwidth)"/>
    <property name="admin.logintype" value="sessionid" description="Type type of login used towards the admin client. Valid values are sessionid and userid"/>
    <property name="admin.credentials.user" value="user1" description="The user ID used if admin.logintype=userid, not used otherwise"/>
    <property name="admin.credentials.password" value="{encoded}94E3EF8563BE8C03" description="The password if admin.logintype=userid, not used otherwise - clear text or encoded as normal"/>
  </group>
  <group name="statistics" description="cluster server configuration">
    <property name="functioncache.timeout" value="5" description="Function cache timeout in seconds"/>
    <property name="statuscache.timeout" value="5" description="Server status cache timeout in seconds"/>
    <property name="webstatuscache.timeout" value="5" description="Server status cache timeout in seconds"/>
  </group>
</server>

...