hosts
API Support | Available since | Last updated | Output |
---|---|---|---|
5.8900 | 6.0000 | xml, json |
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
Name | Description | Required | Type | Default value |
---|---|---|---|---|
name | The name of the host | yes | string | |
external | Whether the host is external | no | boolean | false |
virtual | Whether the host is virtual. PageSeeder v5.99 or higher. | no | boolean | false |
name
The name of the host to create must be at least two characters long, at most 255 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.
The hostname is not case-sensitive and it is not case-preserving: it is always converted to lower case before being stored in the database.
Permission
This service requires administrator.
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" virtual="false"/> </host-creation>
Since the host has only been created, it won’t include any alias.
Error Handling
No specific errors expected for this service.