Web service API

How to use PageSeeder's Web service API

bandwidth

/bandwidth [GET]

com.pageseeder.content.GetBandwidth

This service is obsolete since version 5.7900

Description

Return total bandwidth used on server.

This item is obsolete!

This Service is now obsolete and has been removed from PageSeeder 5.8+

Returns the bandwidth used by scanning the Tomcat log files for the specified project.

Log files details matching the Valve com.pageseeder.tomcat.PageseederLogValve

Parameters

NameDescriptionRequiredTypeDefault value
fromThe start date for measuring the bandwidth using the ISO8601 date format.For example: 2012-12-01nodateA month ago
hostThe host for checking the bandwidthnostringhost from URL
toThe end date for measuring the bandwidth using the ISO8601 date format.For example: 2012-12-31nodate today

If either parameter is not parseable as a date, their value is ignored.

Permission

Undocumented permissions requirements.

Response

This service returns the following XML:

<root status="[status]"
      host="[host]"
      from="[start date]"
      to="[end date]"
      size="[size in bytes]"/>

The dates are returned using the ISO8601 calendar date format.

Error handling

No specific errors expected for this service.

Created on , last edited on