Web service API

How to use PageSeeder's Web service API

hosts

/hosts [GET]

com.pageseeder.host.GetAllHosts

Description

Load all the hosts for the current server.

Parameters

NameDescriptionRequiredTypeDefault value
external Whether external hosts should be returned no boolean false
page the page requested no integer 1
pagesize the maximum number of item per page no integer 200

Permission

Only administrators can invoke this service.

Response

This service returns each host and their aliases as <host> and <alias> elements as in the example below:

<hosts>
   <host id="2" name="acme.com" external="false"/>
   <host id="1" name="mycompany.com" external="false">
      <aliases>
        <alias id="3" name="www.mycompany.com"/>
      </aliases>
   </host>
   ...
</hosts>

Error handling

No specific errors expected for this generator.

Created on , last edited on