Skip to main content

 Services

Web services from /about to /webhooks

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
virtualWhether the host is virtual. PageSeeder v5.99 or higher.nobooleanfalse

name

The name of the host to create must be at least two characters long, at most 100 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.

Created on , last edited on