Skip to main content

 Web service API

How to use PageSeeder's Web service API

update host

/members/{member}/hosts/{host}/update [POST]

com.pageseeder.host.ModifyURIs

Description

Update hosts’ group URIs and URIs with new scheme/port.

Invoking this service starts an Asynchronous process.

Parameters

NameDescriptionRequiredTypeDefault value
portThe new port to set on the objects (required if scheme is not specified) e.g. 8080yesport
schemeThe new scheme to set on the objects (required if port is not specified) e.g. httpyesscheme

Valid port numbers are 1 through 65535

Although PageSeeder does not enforce the use of any particular scheme, in practice, there is no reason to use a scheme other than “http” or “https” for PageSeeder URIs.

Permission

This service requires administrator.

Response

This service returns the following XML:

<host-update>
  <thread ...> ... </thread>
</host-update>

Error Handling

No specific errors expected for this service.

Check the process logs for the events occurring during the process initiated by this service.

Created on , last edited on