APIDocumentation

2.15. Nameserver
Prev	Chapter 2. Methods	Next

2.15.1. nameserver.check

Checks if the given nameservers are responding accordingly.

2.15.1.1. Input

Table 2.182. Parameters

Parameter	Description	Type	Required	Default
domain	Domain name	token255	true
ns	List of nameserver	nsList	true

2.15.1.2. Output

Table 2.183. Parameters

Parameter	Description	Type
details
... ns	Given nameserver	token255
... messageList	Check messages	array_text255
... status	Stauts of the nameserver check	text64

2.15.2. nameserver.clone

Clones cource domain DNS to target DNS.

2.15.2.1. Input

Table 2.184. Parameters

Parameter	Description	Type	Required	Default
sourceDomain	Source domain name	token255	true
targetDomain	Target domain name	token255	true

2.15.2.2. Output

Table 2.185. Parameters

Parameter	Description	Type	Optional
roId	ID of new zone	int

2.15.3. nameserver.create

Creates a domain in the nameserver.

2.15.3.1. Input

Table 2.186. Parameters

Parameter	Description	Type	Required	Default
domain	Domain name	token255	true
type	Type of nameserver entry	nsType	true
ns	List of nameserver	nsList	false
masterIp	Master IP address	ip	false
web	Web nameserver entry	token0255	false
mail	Mail nameserver entry	text0255	false
soaEmail	Email address for SOA record	email	false
urlRedirectType	Type of the url redirection	urlRedirectType	false
urlRedirectTitle	Title of the frame redirection	token0255	false
urlRedirectDescription	Description of the frame redirection	token0255	false
urlRedirectFavIcon	FavIcon of the frame redirection	token0255	false
urlRedirectKeywords	Keywords of the frame redirection	token0255	false
testing	Execute command in testing mode	boolean	false	false
ignoreExisting	Ignore existing	boolean	false	false

2.15.3.2. Output

Table 2.187. Parameters

Parameter	Description	Type	Optional
roId	Created DNS domain id	int

2.15.4. nameserver.createRecord

Creates a new nameserver record.

2.15.4.1. Input

Table 2.188. Parameters

Parameter	Description	Type	Required	Default
domain	Domain name	token255	false
roId	DNS domain id	int	false
type	Type of the nameserver record	recordType	true
content	Content of the nameserver record	text	true
name	Name of the nameserver record	token0255	false
ttl	TTL (time to live) of the nameserver record	int	false	3600
prio	Priority of the nameserver record	int	false	0
urlRedirectType	Type of the url redirection	urlRedirectType	false
urlRedirectTitle	Title of the frame redirection	token0255	false
urlRedirectDescription	Description of the frame redirection	token0255	false
urlRedirectFavIcon	FavIcon of the frame redirection	token0255	false
urlRedirectKeywords	Keywords of the frame redirection	token0255	false
urlAppend	Append the path for redirection	boolean	false	false
testing	Execute command in testing mode	boolean	false	false

2.15.4.2. Output

Table 2.189. Parameters

Parameter	Description	Type	Optional
id	Created record id	int

2.15.5. nameserver.delete

Deletes a nameserver domain

2.15.5.1. Input

Table 2.190. Parameters

Parameter	Description	Type	Required	Default
domain	Domain name	token255	false
roId	Id (Repository Object Identifier) of the DNS domain	int	false
testing	Execute command in testing mode	boolean	false	false

2.15.5.2. Output

No additional return parameters

2.15.6. nameserver.deleteRecord

Deletes a nameserver record.

2.15.6.1. Input

Table 2.191. Parameters

Parameter	Description	Type	Required	Default
id	Id of the nameserver record	int	true
testing	Execute command in testing mode	boolean	false	false

2.15.6.2. Output

No additional return parameters

2.15.7. nameserver.export

Creates a nameserver.export TXT Datei

2.15.7.1. Input

Table 2.192. Parameters

Parameter	Description	Type	Required	Default
domain	Domain name	token255	true

2.15.7.2. Output

Table 2.193. Parameters

Parameter	Description	Type	Optional
export	export result	text

2.15.8. nameserver.exportlist

Nameserver List export as file

2.15.8.1. Input

Table 2.194. Parameters

Parameter	Description	Type	Required	Default
format	Format of the requested document	documentformat	false	raw
domain	Search by domain name	token0255	false	*
wide	More detailed output	int	false	1
page	Page number for paging	int	false	1
pagelimit	Max number of results per page	int	false	20

2.15.8.2. Output

Table 2.195. Parameters

Parameter	Description	Type	Optional
count	Log timestamp	int
domains	Domains Log list	array

2.15.9. nameserver.exportrecords

Export nameserver records as file

2.15.9.1. Input

Table 2.196. Parameters

Parameter	Description	Type	Required	Default
format	Request output of given format. Defaults to csv.	documentformat	false	csv
name	Filter results by given record name. You can, for example, set domain names here. Wildcard * is allowed.	token255	false
page	If limit is set, show entries from {page - 1}*{limit}. Defaults to 1.	int	false	1
limit	Only return {limit} entries at once. Set to 0 for no limit. Defaults to 0.	int	false	0

2.15.9.2. Output

Table 2.197. Parameters

Parameter	Description	Type	Optional
count	Amount of entries returned.	int
data	Result file data in cleartext or base64 coded, depending on the selected format. CSV returns as clear text. Other formats are currently not supported.	base64

2.15.10. nameserver.info

Get nameserver record details.

2.15.10.1. Input

Table 2.198. Parameters

Parameter	Description	Type	Required
domain	Search by domain name	token255	false
roId	Id (Repository Object Identifier) of the DNS domain	int	false
recordId	Search by record id	int	false
type	Search by record type	text64	false
name	Search by record name	text0255	false
content	Search by record content	text1024	false
ttl	Search by record ttl	int	false
prio	Search by record priority	int	false

2.15.10.2. Output

Table 2.199. Parameters

Parameter	Description	Type	Optional
roId	Id (Repository Object Identifier) of the DNS domain	int	Yes
domain	Domain name	token255	Yes
type	Type of nameserver domain	nsType	Yes
masterIp	Master IP address	ip	Yes
lastZoneCheck	Time of last zone check	dateTime	Yes
slaveDns			Yes
... name	Hostname of the nameserver	hostname
... ip	Ip address of the nameserver	ip
SOAserial	SOA-RR serial	text064	Yes
count	Total number of domain records	int	Yes
record			Yes
... id	Id of the nameserver record	int
... name	Name of the nameserver record	token255
... type	Type of the nameserver record	recordType
... content	Content of the nameserver record	text1024
... ttl	TTL (time to live) of the nameserver record	int
... prio	Priority of the nameserver record	int
... urlRedirectType	Type of the url redirection	urlRedirectType	Yes
... urlRedirectTitle	Title of the frame redirection	token255	Yes
... urlRedirectDescription	Description of the frame redirection	token255	Yes
... urlRedirectKeywords	Keywords of the frame redirection	token255	Yes
... urlRedirectFavIcon	FavIcon of the frame redirection	token255	Yes
... urlAppend	Append the path to redirection	boolean	Yes

2.15.11. nameserver.list

List all nameserver domains.

2.15.11.1. Input

Table 2.200. Parameters

Parameter	Description	Type	Required	Default
domain	Search by domain name	token0255	false	*
wide	More detailed output	int	false	1
page	Page number for paging	int	false	1
pagelimit	Max number of results per page	int	false	20

2.15.11.2. Output

Table 2.201. Parameters

Parameter	Description	Type	Optional
count	Total number of nameserver domains	int
domains
... roId	Id (Repository Object Identifier) of the DNS domain	int
... domain	Domain name	array_domain
... type	Type of nameserver domain	nsType
... masterIp	Master ip address	ip	Yes
... mail	Mail nameserver entry	ip_url	Yes
... web	Web nameserver entry	ip_url	Yes
... url	Web forwarding url	ip_url	Yes
... urlType	The redirect type of the forwarding url (only if `url` is set)	urlRedirectType	Yes
... ipv4	Web IPv4 address	ip	Yes
... ipv6	Web IPv6 address	ip	Yes

2.15.12. nameserver.update

Updates a nameserver domain.

2.15.12.1. Input

Table 2.202. Parameters

Parameter	Description	Type	Required	Default
domain	Domain name	token255	false
roId	Id (Repository Object Identifier) of the DNS domain	int	false
type	Type of nameserver entry	nsType	false
masterIp	Master ip address	ip	false
ns	List of nameserver	nsList	false
web	Web nameserver entry	token255	false
mail	Mail nameserver entry	token255	false
urlRedirectType	Type of the url redirection	urlRedirectType	false
urlRedirectTitle	Title of the frame redirection	token0255	false
urlRedirectDescription	Description of the frame redirection	token0255	false
urlRedirectFavIcon	FavIcon of the frame redirection	token0255	false
urlRedirectKeywords	Keywords of the frame redirection	token0255	false
testing	Execute command in testing mode	boolean	false	false

2.15.12.2. Output

No additional return parameters

2.15.13. nameserver.updateRecord

Updates a nameserver record.

2.15.13.1. Input

Table 2.203. Parameters

Parameter	Description	Type	Required	Default
id	Id of the record	array_int	true
name	Name of the nameserver record	token0255	false
type	Type of the nameserver record	recordType	false
content	Content of the nameserver record	text	false
prio	Priority of the nameserver record	int	false
ttl	TTL (time to live) of the nameserver record	int	false
urlRedirectType	Type of the url redirection	urlRedirectType	false
urlRedirectTitle	Title of the frame redirection	token0255	false
urlRedirectDescription	Description of the frame redirection	token0255	false
urlRedirectFavIcon	FavIcon of the frame redirection	token0255	false
urlRedirectKeywords	Keywords of the frame redirection	token0255	false
urlAppend	Append the path for redirection	boolean	false	false
testing	Execute command in testing mode	boolean	false	false