update host
/members/{member}/hosts/{host}/update [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
Description
Update hosts’ group URIs and URIs with new scheme/port.
Invoking this service starts an asynchronous process.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
port | The new port to set on the objects (required if scheme is not specified) e.g. 8080 | yes | port | |
scheme | The new scheme to set on the objects (required if port is not specified) e.g. http | yes | scheme |
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.