Skip to main content

 Services

Web services from /about to /webhooks

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 might also be created when posting comments against a URL, if the hostname of that URL has not been previously registered.

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

This service requires administrator.

Response

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

<hosts [limitreached="true"]>
  <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 service.

Created on , last edited on