Web service API

How to use PageSeeder's Web service API

hosts

/hosts [POST]

com.pageseeder.host.CreateHost

Description

Creates a host.

Before you create a new host consider whether, creating a new host alias is more appropriate. To create an alias to existing host use the following service: /hosts/{hostname}/hostaliases [POST]

Parameters

NameDescriptionRequiredTypeDefault value
namethe name of the hostyesstring
externalWhether the host is externalnobooleanfalse
restart-emailWhether to restart the email server if requirednobooleantrue

Permission

Only administrators can invoke this service.

Response

If successful, the created host is returned as a single <host> element wrapped in a <host-creation> element.

<host-creation>
   <host id="2" name="acme.com" external="false"/>
</host-creation>

Note

Since the host has only just been created, it will not include any alias.

Error handling

No specific errors expected for this generator.

Created on , last edited on