Skip to main content

 Services

Web services from /about to /webhooks

create hostalias

/hosts/{hostname}/hostaliases [POST]

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

This service requires administrator.

Response

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

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

Error Handling

No specific errors expected for this service.

Created on , last edited on