Web service API

How to use PageSeeder's Web service API

create hostalias

/hosts/{hostname}/hostaliases [POST]

com.pageseeder.host.CreateHostalias

Description

Create an alias to an existing host.

The host must exist before an alias can be created.

To create a host use the /hosts [POST] service.

Parameters

NameDescriptionRequiredTypeDefault value
nameThe name of the host aliasyesstring

Permission

Only administrators can use this service.

Response

If successful, the created alias is returned as an <alias> element wrapped in an <alias-creation> element as in the example below:

<alias-creation>
   <alias id="2" name="www.acme.com" />
</alias-creation>

Error handling

No specific errors expected for this generator.

Created on , last edited on