Web service API

How to use PageSeeder's Web service API

hosts

/hosts [GET]

com.pageseeder.host.GetAllHosts

Description

This service returns the list of hosts and host aliases currently defined on the server.

To create a new host uses the /hosts [POST] service. New hosts may also be created when posting comments against a URL.

Parameters

NameDescriptionRequiredTypeDefault value
externalWhether external hosts should be returnednobooleanfalse
pagethe page requestednointeger1
pagesizethe maximum number of hosts per pagenointeger200

This service implements paging; pages are based on the number of hosts (aliases are not included in the count)

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