APIDocumentation

Deutsch | English | Español

Währung:

EUR

Ihr Land ist:

Bitte Land auswählen!

2.12. Host
Prev	Chapter 2. Methods	Next

2.12. Host

The host object provides methods to manage your glue records.

2.12.1. host.check

Checks a hostname.

2.12.1.1. Input

Table 2.163. Parameters

Parameter	Description	Type	Required	Default
hostname	Name of host	hostname	true

2.12.1.2. Output

Table 2.164. Parameters

Parameter	Description	Type	Optional
avail	Host available	boolean

2.12.2. host.create

Creates a new host.

2.12.2.1. Input

Table 2.165. Parameters

Parameter	Description	Type	Required	Default
hostname	Name of host	hostname	true
ip	Ip address(es)	array_ip	true
testing	Execute command in testing mode	boolean	false	false

2.12.2.2. Output

Table 2.166. Parameters

Parameter	Description	Type	Optional
roId	Id (Repository Object Identifier) of the hostname	int

2.12.3. host.delete

Deletes a host.

2.12.3.1. Input

Table 2.167. Parameters

Parameter	Description	Type	Required	Default
hostname	Name of host	hostname	false
roId	Id (Repository Object Identifier) of the hostname	int	false
testing	Execute command in testing mode	boolean	false	false

2.12.3.2. Output

No additional return parameters

2.12.4. host.info

Get host details.

2.12.4.1. Input

Table 2.168. Parameters

Parameter	Description	Type	Required	Default
hostname	Name of host	hostname	false
roId	Id (Repository Object Identifier) of the hostname	int	false

2.12.4.2. Output

Table 2.169. Parameters

Parameter	Description	Type
roId	Id (Repository Object Identifier) of the hostname	int
hostname	Name of host	int
status	Status of the hostname	text64
ip	List of ip address	ipList

2.12.5. host.list

List of hosts.

2.12.5.1. Input

Table 2.170. Parameters

Parameter	Description	Type	Required	Default
search	Filter by hostname search string	text64	false	*
page	Page number for paging	int	false	1
pagelimit	Max number of results per page	int	false	20

2.12.5.2. Output

Table 2.171. Parameters

Parameter	Description	Type
count	Total number of hostnames	int
host
... roId	Id (Repository Object Identifier) of the hostname	int
... hostname	Name of host	token255
... ip	List of ip address	ipList
... status	Status of the hostname	text64

2.12.6. host.update

Updates a hostname.

2.12.6.1. Input

Table 2.172. Parameters

Parameter	Description	Type	Required	Default
hostname	Name of host	hostname	false
roId	Id (Repository Object Identifier) of the hostname	int	false
ip	Ip address(es)	array_ip	true
testing	Execute command in testing mode	boolean	false	false