Web service API

How to use PageSeeder's Web service API

host

/hosts/{hostname} [PATCH]

com.pageseeder.host.EditHost

Description

Edits a host - will only change specified parameters.

Parameters

NameDescriptionRequiredTypeDefault value
externalWhether the host is externalnoboolean
namethe new name of the hostnostring
restart-emailWhether to restart the email server if requirednobooleantrue

Permission

Only administrators can edit hosts.

Response

The updated host will be returned as a <host> element and will include any existing <alias>

<host-modification>
   <host id="1" name="mycompany.com" external="false">
      <aliases>
         <alias id="3" name="www.mycompany.com"/>
      </aliases>
   </host>
</host-modification>

Error handling

No specific errors expected for this generator.

Created on , last edited on