Web service API

How to use PageSeeder's Web service API

host

/hosts/{hostname} [DELETE]

com.pageseeder.host.DeleteHost

Description

Deletes a host.

Parameters

NameDescriptionRequiredTypeDefault value
restart-emailWhether to restart the email server if requirednobooleantrue

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 delete a host.

Response

If successful, this service always returns the following:

<host-delete/>

Error Handling

No specific errors expected for this generator.

Created on , last edited on