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

name

The name of the host to create must be at least two characters long, at most 100 characters long, a valid host according to RFC 3986 - section 3.2.2 host , and match the following regular expression:

([a-z0-9]([a-z0-9-]*[a-z0-9])?\.?)+[a-z0-9]([a-z0-9-]*[a-z0-9])?

PageSeeder supports IPv4 addresses and regular names.

Note

The host name is not case-sensitive and it is not case-preserving: it will always be converted to lower case before being stored in the database.

restart-email

The purpose of this parameter is to prevent the email server from being restarted if  the emailDomain template property  is set to pshosts.

When the emailDomain template property is set to pshosts,  the PageSeeder email server must be restarted in order to handle the new host. it will do so unless this parameter is set to "false ".

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