Skip to content
CentralNic Reseller
SupportSign in

Additional Parameters and Responses for Commands

The following API commands now support the COMMAND parameters DomainTag[0-4095]= and ZoneTag[0-4095]= to limit the search results:

  • QueryRegisteredPremiumDomainList
  • QueryDomainRenewList
  • QueryTrusteeDomainList
  • QueryAccountingList
  • QueryDomainListByContact
  • QueryDomainHistoryList
  • QueryUpcomingAccountingList
  • QueryDomainExpireList
  • QueryDomainList

Example Parameters

Section titled “Example Parameters”
Command
...
ZoneTag0=
...
ZoneTag4095=
...
DomainTag0=
...
DomainTag4095=
...

Responses for StatusDomain, StatusDomain and GetZoneInfo

Section titled “Responses for StatusDomain, StatusDomain and GetZoneInfo”

The following API commands now additionally respond with property[domaintag][0-X]=

  • StatusDomainHistory
  • StatusDomain
  • GetZoneInfo (now additionally responds with property[tag][0-X]=)

AddDomain

Section titled “AddDomain”

AddDomain now supports DOMAINTAG[0-4095]= for the direct assignment of Tags during the registration request.

Example parameters:

Command
[[AddDomain|AddDomain]]
DomainTag0=
DomainTagN=
- or -
AddDomainTag0=
AddDomainTagN=

ModifyDomain

Section titled “ModifyDomain”

ModifyDomain now supports DOMAINTAG[0-4095]= for direct assignment of Tags during the registration request along with ADDDOMAINTAG[0-4095]= and DELDOMAINTAG[0-4095]=.

Example parameters:

Command
[[ModifyDomain|ModifyDomain]]
DomainTag0=
DomainTagN=
- or -
AddDomainTag0=
AddDomainTagN=
DelDomainTag0=
DelDomainTagN=

CheckDomains With TLD Zone Tags

Section titled “CheckDomains With TLD Zone Tags”

The command CheckDomains now also works with TLD Zone Tags and checks for a given search string. The search string can be stated without any TLD. The response automatically displays results for TLDs that belong to a certain TLD Zone Tag. Of course default and individual TLD Zone Tags can be combined.

Command
Command=CheckDomains
Domain0=cooldomainname
ZONETAG=DEFAULT_GENERIC
Response
code = 200
description = Command completed successfully
queuetime = 0
runtime = 10.36
property[column][0] = domain
property[column][1] = domaincheck
property[column][2] = domainchecktime
property[count][0] = 15
property[domain][0] = cooldomainname.biz
property[domaincheck][0] = 210 Domain name available
property[domainchecktime][0] = 0.001
property[domain][1] = cooldomainname.com
property[domaincheck][1] = 210 Domain name available
property[domainchecktime][1] = 0.001
property[domain][2] = cooldomainname.info
property[domaincheck][2] = 210 Domain name available
property[domainchecktime][2] = 0.001
...
property[first][0] = 0
property[last][0] = 14
property[limit][0] = 32
property[total][0] = 16

Using Query Commands With Tags

Section titled “Using Query Commands With Tags”

We integrated Tag support for Several Query Commands:

  • QueryDomainList
  • QueryAccountingList
  • QueryDomainExpireList
  • QueryDomainHistoryList
  • QueryDomainListByContact
  • QueryDomainRenewList
  • QueryRegisteredPremiumDomainList
  • QueryTrusteeDomainList
  • QueryUpcomingAccountingList

Using QueryDomainList and Tags To Narrow Down the List of Domains

Section titled “Using QueryDomainList and Tags To Narrow Down the List of Domains”

To narrow down a query using tags the parameters DomainTag[x] and ZoneTag[x] can be used. You can query for up to 4096 Tags (from 0 to 4095) of each type and work as logical conjunction. The response lists the intersection, i.e. all objects assigned to all Tags stated in the query command.

Command
command=QueryDomainlist
ZoneTag0=DEFAULT_GENERIC
Response
code = 200
description = Command completed successfully
runtime = 0.009
property[column][0] = domain
property[count][0] = 2
property[domain][0] = first-domain1.com
property[domain][1] = first-domain2.com
property[first][0] = 0
property[last][0] = 1
property[limit][0] = 1000
property[total][0] = 2

Sub-Reseller Management With TLD Zone Tags

Section titled “Sub-Reseller Management With TLD Zone Tags”

Tags can be used to activate TLD zones for Sub-Resellers, during the creation (AddRegistrar) and modification (ModifyRegistrar) of a Sub-Reseller account. Important: Tags are not inherited to Sub-Reseller accounts!

AddRegistrar With TLD Zone Tags

Section titled “AddRegistrar With TLD Zone Tags”
Command
Command=AddRegistrar
...
ZoneTag0=
...
ZoneTag4095=
...

ModifyRegistrar With TLD Zone Tags

Section titled “ModifyRegistrar With TLD Zone Tags”

Deleting of ZoneTags containing Zones that are not activated for the respective Sub-Reseller account, will be ignored.

Command
Command=ModifyRegistrar
AddZoneTag0=
...
AddZoneTag4095=
...
DelZoneTag0=
...
DelZoneTag4095=