Your browser don't permit web-fonts to be installed. Our websites use web-fonts based icons. For a better experience please allow your browser to use web-fonts.
We are hiring!
Deutsch | English | Español

2.13. Nameserver

The nameserver object provides methods to manage the nameserver domains and their records.

2.13.1. nameserver.check

Checks if the given nameservers are responding accordingly.

2.13.1.1. Input

Table 2.140. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 
nsList of nameserver nsList true 

2.13.1.2. Output

Table 2.141. Parameters

ParameterDescriptionTypeOptional
details   
... nsGiven nameserver token255  
... ... Check message token255  
... statusStauts of the nameserver check text64  

2.13.2. nameserver.create

Creates a doamin in the nameserver.

2.13.2.1. Input

Table 2.142. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 
typeType of nameserver entry nsType true 
nsList of nameserver nsList false 
masterIpMaster IP address ip false 
webWeb nameserver entry token0255 false 
mailMail nameserver entry text0255 false 
soaEmailEmail address for SOA record email false 
urlRedirectTypeType of the url redirection urlRedirectType false 
urlRedirectTitleTitle of the frame redirection token0255 false 
urlRedirectDescriptionDescription of the frame redirection token0255 false 
urlRedirectFavIconFavIcon of the frame redirection token0255 false 
urlRedirectKeywordsKeywords of the frame redirection token0255 false 
testingExecute command in testing mode boolean falsefalse

2.13.2.2. Output

Table 2.143. Parameters

ParameterDescriptionTypeOptional
roIdCreated DNS domain id int  

2.13.3. nameserver.createRecord

Creates a new nameserver record.

2.13.3.1. Input

Table 2.144. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 false 
roIdDNS domain id int false 
typeType of the nameserver record recordType true 
contentContent of the nameserver record text true 
nameName of the nameserver record token0255 false 
ttlTTL (time to live) of the nameserver record int false3600
prioPriority of the nameserver record int false0
urlRedirectTypeType of the url redirection urlRedirectType false 
urlRedirectTitleTitle of the frame redirection token0255 false 
urlRedirectDescriptionDescription of the frame redirection token0255 false 
urlRedirectFavIconFavIcon of the frame redirection token0255 false 
urlRedirectKeywordsKeywords of the frame redirection token0255 false 
urlAppendAppend the path for redirection boolean falsefalse
testingExecute command in testing mode boolean falsefalse

2.13.3.2. Output

Table 2.145. Parameters

ParameterDescriptionTypeOptional
idCreated record id int  

2.13.4. nameserver.delete

Deletes a nameserver domain

2.13.4.1. Input

Table 2.146. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 false 
roIdId (Repository Object Identifier) of the DNS domain int false 
testingExecute command in testing mode boolean falsefalse

2.13.4.2. Output

No additional return parameters

2.13.5. nameserver.deleteRecord

Deletes a nameserver record.

2.13.5.1. Input

Table 2.147. Parameters

ParameterDescriptionTypeRequiredDefault
idId of the nameserver record int true 
testingExecute command in testing mode boolean falsefalse

2.13.5.2. Output

No additional return parameters

2.13.6. nameserver.export

Creates a nameserver.export TXT Datei

2.13.6.1. Input

Table 2.148. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 

2.13.6.2. Output

Table 2.149. Parameters

ParameterDescriptionTypeOptional
exportexport result text  

2.13.7. nameserver.exportlist

Nameserver List export as file

2.13.7.1. Input

Table 2.150. Parameters

ParameterDescriptionTypeRequiredDefault
formatFormat of the requested document documentformat falseraw
domainSearch by domain name token0255 false*
wideMore detailed output int false1
pagePage number for paging int false1
pagelimitMax number of results per page int false20

2.13.7.2. Output

Table 2.151. Parameters

ParameterDescriptionTypeOptional
countLog timestamp int  
pageAmount value int  
pagelimtType of action int  
pagecountLog details int  
formatLog details documentformat  

2.13.8. nameserver.exportrecords

Export nameserver records as file

2.13.8.1. Input

Table 2.152. Parameters

ParameterDescriptionTypeRequiredDefault
formatRequest output of given format. Defaults to csv. documentformat falsecsv
nameFilter results by given record name. You can, for example, set domain names here. Wildcard * is allowed. token255 false 
pageIf limit is set, show entries from {page - 1}*{limit}. Defaults to 1. int false1
limitOnly return {limit} entries at once. Set to 0 for no limit. Defaults to 0. int false0

2.13.8.2. Output

Table 2.153. Parameters

ParameterDescriptionTypeOptional
countAmount 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.13.9. nameserver.info

Get nameserver record details.

2.13.9.1. Input

Table 2.154. Parameters

ParameterDescriptionTypeRequiredDefault
domainSearch by domain name token255 false 
roIdId (Repository Object Identifier) of the DNS domain int false 
recordIdSearch by record id int false 
typeSearch by record type text64 false 
nameSearch by record name text064 false 
contentSearch by record content text1024 false 
ttlSearch by record ttl int false 
prioSearch by record priority int false 

2.13.9.2. Output

Table 2.155. Parameters

ParameterDescriptionTypeOptional
roIdId (Repository Object Identifier) of the DNS domain int Yes
domainDomain name token255 Yes
typeType of nameserver domain nsType Yes
masterIpMaster IP address ip Yes
lastZoneCheckTime of last zone check dateTime Yes
slaveDns  Yes
... nameHostname of the nameserver hostname  
... ipIp address of the nameserver ip  
SOAserialSOA-RR serial text064 Yes
countTotal number of domain records int Yes
record  Yes
... idId of the nameserver record int  
... nameName of the nameserver record token255  
... typeType of the nameserver record recordType  
... contentContent of the nameserver record text1024  
... ttlTTL (time to live) of the nameserver record int  
... prioPriority of the nameserver record int  
... urlRedirectTypeType of the url redirection urlRedirectType Yes
... urlRedirectTitleTitle of the frame redirection token255 Yes
... urlRedirectDescriptionDescription of the frame redirection token255 Yes
... urlRedirectKeywordsKeywords of the frame redirection token255 Yes
... urlRedirectFavIconFavIcon of the frame redirection token255 Yes
... urlAppendAppend the path to redirection boolean Yes

2.13.10. nameserver.list

List all nameserver domains.

2.13.10.1. Input

Table 2.156. Parameters

ParameterDescriptionTypeRequiredDefault
domainSearch by domain name token0255 false*
wideMore detailed output int false1
pagePage number for paging int false1
pagelimitMax number of results per page int false20

2.13.10.2. Output

Table 2.157. Parameters

ParameterDescriptionTypeOptional
countTotal number of nameserver domains int  
domain   
... roIdId (Repository Object Identifier) of the DNS domain int  
... domainDomain name array_domain  
... typeType of nameserver domain nsType  
... masterIpMaster ip address ip Yes
... mailMail nameserver entry ip_url Yes
... webWeb nameserver entry ip_url Yes
... urlWeb forwardiung url url Yes
... urlTypeThe redirect type of the forwardiung url (only if `url` is set) url Yes
... ipv4Web IPv4 address ip Yes
... ipv6Web IPv6 address ip Yes

2.13.11. nameserver.update

Updates a nameserver domain.

2.13.11.1. Input

Table 2.158. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 false 
roIdId (Repository Object Identifier) of the DNS domain int false 
typeType of nameserver entry nsType false 
masterIpMaster ip address ip false 
nsList of nameserver nsList false 
webWeb nameserver entry token255 false 
mailMail nameserver entry token255 false 
urlRedirectTypeType of the url redirection urlRedirectType false 
urlRedirectTitleTitle of the frame redirection token0255 false 
urlRedirectDescriptionDescription of the frame redirection token0255 false 
urlRedirectFavIconFavIcon of the frame redirection token0255 false 
urlRedirectKeywordsKeywords of the frame redirection token0255 false 
testingExecute command in testing mode boolean falsefalse

2.13.11.2. Output

No additional return parameters

2.13.12. nameserver.updateRecord

Updates a nameserver record.

2.13.12.1. Input

Table 2.159. Parameters

ParameterDescriptionTypeRequiredDefault
idId of the record array_int true 
nameName of the nameserver record token0255 false 
typeType of the nameserver record recordType false 
contentContent of the nameserver record text false 
prioPriority of the nameserver record int false 
ttlTTL (time to live) of the nameserver record int false 
urlRedirectTypeType of the url redirection urlRedirectType false 
urlRedirectTitleTitle of the frame redirection token0255 false 
urlRedirectDescriptionDescription of the frame redirection token0255 false 
urlRedirectFavIconFavIcon of the frame redirection token0255 false 
urlRedirectKeywordsKeywords of the frame redirection token0255 false 
urlAppendAppend the path for redirection boolean falsefalse
testingExecute command in testing mode boolean falsefalse

2.13.12.2. Output

No additional return parameters