Skip to main content

 Web service API

How to use PageSeeder's Web service API

list externaluris hosts

/groups/{group}/externaluris/hosts [GET]

com.pageseeder.system.GetVersion

Description

Load the hosts for the current group.

Parameters

NameDescriptionRequiredTypeDefault value
pageThe page requestednointeger1
pagesizeThe maximum number of item per pagenointeger200

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

Permission

This service is restricted to guest and higher.

Response

The response lists each host in a <host> element, each host alias in <alias> elements as in the following example:

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

Error Handling

No specific errors expected for this service.

Created on , last edited on