JSON objects

Response objects

ZoneSummary

Name	Type	Default value	Description
id	Integer		The ID of the zone. This information is not currently used by the API
customer_id	Integer		The customer ID associated with the zone
name	String		The name of the zone
parent_zone	String		The name of the parent zone if the zone is a subzone
status	String		The status of the zone. Allowed values : ACTIVE: The zone is active INSTALLING: The zone is awaiting installation on DNS WAITING_VALIDATION: Modifications have been made and are awaiting validation DNS_PROPAGATION : Modifications have been validated and are awaiting propagation on DNS
dnssec_status	String		The DNSSEC status of the zone. Allowed values : UNSECURED: DNSSEC is disabled for the zone SECURING: Enabling DNSSEC is in progress for the zone SECURED: DNSSEC is enabled for the zone UNSECURING: Disabling DNSSEC is in progress for the zone
strategic	Boolean		Zone defined as strategic
dns_hosting_only	Boolean		Zone with dns hosting only (the associated domain is not registered with Nameshield)
managed_primary_dns	Boolean		Zone with a primary nameserver managed by Nameshield
nameservers	List of Nameserver		The list of nameservers

Zone

Name	Type	Default value	Description
id	Integer		The ID of the zone. This information is not currently used by the API
customer_id	Integer		The customer ID associated with the zone
name	String		The name of the zone
parent_zone	String		The name of the parent zone if the zone is a subzone
status	String		The status of the zone Allowed values : ACTIVE: The zone is active WAITING_VALIDATION: Modifications have been made and are awaiting validation DNS_PROPAGATION : Modifications have been validated and are awaiting propagation on DNS
dnssec_status	String		The DNSSEC status of the zone Allowed values : UNSECURED: DNSSEC is disabled for the zone SECURING: Enabling DNSSEC is in progress for the zone SECURED: DNSSEC is enabled for the zone UNSECURING: Disabling DNSSEC is in progress for the zone
strategic	Boolean		Zone defined as strategic
dns_hosting_only	Boolean		Zone with dns hosting only (the associated domain is not registered with Nameshield)
managed_primary_dns	Boolean		Zone with a primary nameserver managed by Nameshield
nameservers	List of Nameserver		The list of nameservers
ttl	Integer		The default Time to live for the zone, in seconds. Allowed values : 300, 600, 3600, 43200, 86400
soa	SOA		The SOA of the zone
records	List of Record		The list of DNS records

Nameserver

Name	Type	Default value	Description
name	String		The name of the nameserver
primary	Boolean		Nameserver defined as primary
hidden	Boolean		Nameserver defined as hidden. Available for primary nameservers only
synchronized	Boolean		Nameserver synchronized with Nameshield's nameservers. Available for external secondary nameservers only

SOA

Name	Type	Default value	Description
master	String		The primary nameserver
email	String	technical@nameshield.net	The email address of the administrator
serial	String		The serial number for the zone
refresh	Integer	28800	The refresh interval, in seconds. Allowed values: 1800, 3600, 7200, 28800, 43200, 86400
retry	Integer	7200	The retry interval, in seconds. Allowed values: 3600, 10800, 28800, 43200, 86400
expire	Integer	604800	The time to expire, in seconds. Allowed values: 604800, 1209600, 2419200
minimum	Integer	7200	The negative cache, in seconds. Allowed values: 300, 600, 3600, 7200, 43200, 86400

Record

Name	Type	Default value	Description
id	Integer		The ID of the DNS record
name	String		The name of the DNS record
type	String		The type of the DNS record
data	String		The content of the DNS record
ttl	Integer	null	The Time to live for the DNS record, in seconds. Allowed values: 300, 600, 3600, 43200, 86400
created_at	Date		The creation date of the record
modified_at	Date		Last time the record was modified
modified_by	String		The last user who modified the record
action	String		The type of action. Defined values: CREATED: Record added UPDATED: Record modified DELETED: Record deleted
comment	Comment	null	The comment on the record
tags	List of Tag	null	The list of tags on the record
zone	String		The name of the zone to which the record belongs. This property is only specified on the List all zones records route
routing	RoutingPolicy	null	The routing policy configured for the record. This feature requires to activate the GSLB service

Comment

Name	Type	Default value	Description
value	String		The value of the comment
modified_at	Date		Last time the comment was modified
modified_by	String		The last user who modified the comment

Tag

Name	Type	Default value	Description
tag	String		The name of the tag
value	String		The value of the tag
created_at	Date		Creation date of the tag
created_by	String		The user who created the tag

DnssecKey

Name	Type	Default value	Description
id	Integer		The key ID
domain	String		The name of the domain related to the key
keytag	Integer		The keytag of the key
flags	Integer		The key flags. Possible values : 257: KSK key 256: ZSK key
algorithm	Integer		The key algorithm. Possible values : 5: RSASHA1 (deprecated) 7: RSASHA1NSEC3SHA1 (deprecated) 8: RSASHA256 10: RSASHA512 13: ECDSA256 14: ECDSA384
digest	String		The key digest
digest_type	Integer		The key digest type value. Possible values : 1: SHA1 (deprecated) 2: SHA256 4: SHA384
public_key	String		The public key
status	String		The key status. Possible values : PENDING_PUBLISH: The key has been added and is awaiting publication to the registry PUBLISHED: The key is published to the registry PENDING_UNPUBLISH: The key has been removed and is awaiting unpublication to the registry UNPUBLISHED: The key is unpublished to the registry
created_at	Date		Creation date of the key
published_at	Date		Publish date to the registry
deleted_at	Date		Deletion date of the key
unpublished_at	Date		Unpublish date to the registry

ZoneSearchResults

Name	Type	Default value	Description
total	Integer		Total number of zones matching the search criteria
limit	Integer	100	Number of zones returned
offset	Integer	0	Offset used
results	List of ZoneSummary		List of zones matching the search criteria

RecordSearchResults

Name	Type	Default value	Description
total	Integer		Total number of DNS records matching the search criteria
limit	Integer		Number of DNS records returned
offset	Integer	0	Offset used
results	List of Record		List of DNS records matching the search criteria

DnssecKeySearchResults

Name	Type	Default value	Description
total	Integer		Total number of keys matching the search criteria
limit	Integer	100	Number of keys returned
offset	Integer	0	Offset used
sort	String	domain	Field used to sort the results
domain	String		Search filter on the domain name
status	String		Search filter on the key status
algorithm	String		Search filter on the key algorithm
digest_type	String		Search filter on the key digest type
customer_id	String		Search filter on customer
include_subsidiaries	Boolean	True	Include subsidiaries in the search
results	List of DnssecKey		List of keys matching the search criteria

RoutingPolicy

Name	Type	Default value	Description
policy	String		The type of routing policy. Routing policies allows you to configure multiple (A, AAAA, CNAME) records for the same subdomain and determine the amount of traffic routed to each resource. Allowed values: WEIGHTED: The proportion of traffic allocated to the resource is based on the weight of the record relative to the total weight of all records in the same RRset. The "weight" parameter must be specified GEOIP: The traffic is based on the geographic location of users (by mapping IP addresses to locations). The "location" parameter must be specified FAILOVER: The traffic is routed to the resource with the lowest priority having an 'Healthy' health check. Failover routing must be associated with a health check to monitor the status of the resource. The "priority" parameter must be specified
weight	Integer		The relative weight defined for the record (value between 1 and 1000). Required for Weighted routing policy
priority	Integer		The priority defined for the record (value between 1 and 1000). Required for Failover routing policy
location	String		The geographic location defined for the record. Required for Geolocation routing policy. You can configure geographic locations by continent or by country, or specify IP ranges. A default location must be specified to handle requests that do not match any of the configured geographic locations
healthcheck	String		A health check uuid. Required for Failover routing policy and optional for Weighted and Geolocation routing policies. Associating a health check with a Failover routing policy allows the traffic to be switched to another active resource when the health check becomes 'Unhealthy' Associating a health check with a Weighted routing policy allows the resource to be automatically removed from the zone when the health check becomes 'Unhealthy' Associating a health check with a Geolocation routing policy allows the corresponding location to be automatically removed from the zone when the health check becomes 'Unhealthy'. Queries are routed to the next higher available level

---

---

Input objects

InputZone

Name	Required	Type	Default value	Description
ttl	Yes	Integer		The default Time to live for the zone, in seconds. Allowed values : 300, 600, 3600, 43200, 86400
soa	No	InputSOA		The SOA of the zone
records	No	List of InputRecord		The list of DNS records

InputSOA

Name	Required	Type	Default value	Description
email	No	String	technical@nameshield.net	The email address of the administrator
refresh	No	Integer	28800	The refresh interval, in seconds. Allowed values: 1800, 3600, 7200, 28800, 43200, 86400
retry	No	Integer	7200	The retry interval, in seconds. Allowed values: 3600, 10800, 28800, 43200, 86400
expire	No	Integer	604800	The time to expire, in seconds. Allowed values: 604800, 1209600, 2419200
minimum	No	Integer	7200	The negative cache, in seconds. Allowed values: 300, 600, 3600, 7200, 43200, 86400

InputZoneCreation

Name	Required	Type	Default value	Description
name	Yes	String		The name of the zone
customer_id	No	Integer		The customer ID associated with the zone. If not set, the customer associated with the user will be used
nameservers	No	List of InputNameserver	Nameshield Premium nameservers	List of nameservers associated with the zone. You can define up to 12 nameservers

InputZoneUpdate

Name	Required	Type	Default value	Description
customer_id	No	Integer		The customer ID associated with the zone
nameservers	No	List of InputNameserver	Nameshield Premium nameservers	List of nameservers associated with the zone. You can define up to 12 nameservers

InputNameserver

Name	Required	Type	Default value	Description
name	Yes	String		The name of the server
primary	Yes	Boolean		Define the nameserver as primary. Only one nameserver can be defined as primary
hidden	No	Boolean		Define the nameserver as hidden. Only the primary nameserver can be defined as hidden
synchronized	No	Boolean		Enable synchronisation with Nameshield's nameservers. Available for external secondary nameservers only

InputRecord

Name	Required	Type	Default value	Description
name	Yes	String		The name of the DNS record
type	Yes	String		The type of the DNS record
data	Yes	String		The content of the DNS record
ttl	No	Integer	null	The Time to live for the DNS record, in seconds. Allowed values: 300, 600, 3600, 43200, 86400
comment	No	String	null	The comment on the record
tags	No	List of InputTag	null	List of tags on the record
routing	No	InputRoutingPolicy	null	Configure a routing policy for the record. This feature requires to activate the GSLB service, please contact your account manager for more information

InputTag

Name	Required	Type	Default value	Description
tag	Yes	String		The name of the tag
value	No	String		The value of the tag

InputDnssecKey

Name	Required	Type	Default value	Description
public_key	Yes	String		The public key
algorithm	Yes	Integer		The key algorithm. Allowed values : 8: RSASHA256 10: RSASHA512 13: ECDSA256 14: ECDSA384
digest_type	No	Integer	2	The key digest type. Allowed values : 2: SHA256 4: SHA384

InputRoutingPolicy

Name	Required	Type	Default value	Description
policy	Yes	String		The type of routing policy. Routing policies allows you to configure multiple (A, AAAA, CNAME) records for the same subdomain and determine the amount of traffic routed to each resource. Allowed values: WEIGHTED: The proportion of traffic allocated to the resource is based on the weight of the record relative to the total weight of all records in the same RRset. The "weight" parameter must be specified GEOIP: The traffic is based on the geographic location of users (by mapping IP addresses to locations). The "location" parameter must be specified FAILOVER: The traffic is routed to the resource with the lowest priority having an 'Healthy' health check. Failover routing must be associated with a health check to monitor the status of the resource. The "priority" parameter must be specified
weight	No	Integer		The relative weight defined for the record (value between 1 and 1000). Required for Weighted routing policy
priority	No	Integer		The priority defined for the record (value between 1 and 1000). Required for Failover routing policy
location	No	String		The geographic location defined for the record. Required for Geolocation routing policy. You can configure geographic locations by continent or by country, or specify IP ranges. A default location must be specified to handle requests that do not match any of the configured geographic locations
healthcheck	No	String		A health check uuid. Required for Failover routing policy and optional for Weighted and Geolocation routing policies. Associating a health check with a Failover routing policy allows the traffic to be switched to another active resource when the health check becomes 'Unhealthy'. Associating a health check with a Weighted routing policy allows the resource to be automatically removed from the zone when the health check becomes 'Unhealthy' Associating a health check with a Geolocation routing policy allows the corresponding location to be automatically removed from the zone when the health check becomes 'Unhealthy'. Queries are routed to the next higher available level

Location

Continent

Code	Description
default	default
AF	Africa
AN	Antarctica
AS	Asia
EU	Europe
NA	North America
OC	Oceania
SA	South America

---

Country

Africa AF

Code	Description
AF_AO	Angola
AF_BF	Burkina Faso
AF_BI	Burundi
AF_BJ	Benin
AF_BW	Botswana
AF_CD	DR Congo
AF_CF	Central African Republic
AF_CG	Congo Republic
AF_CI	Ivory Coast
AF_CM	Cameroon
AF_CV	Cabo Verde
AF_DJ	Djibouti
AF_DZ	Algeria
AF_EG	Egypt
AF_EH	Western Sahara
AF_ER	Eritrea
AF_ET	Ethiopia
AF_GA	Gabon
AF_GH	Ghana
AF_GM	The Gambia
AF_GN	Guinea
AF_GQ	Equatorial Guinea
AF_GW	Guinea-Bissau
AF_KE	Kenya
AF_KM	Comoros
AF_LR	Liberia
AF_LS	Lesotho
AF_LY	Libya
AF_MA	Morocco
AF_MG	Madagascar
AF_ML	Mali
AF_MR	Mauritania
AF_MU	Mauritius
AF_MW	Malawi
AF_MZ	Mozambique
AF_NA	Namibia
AF_NE	Niger
AF_NG	Nigeria
AF_RE	Réunion
AF_RW	Rwanda
AF_SC	Seychelles
AF_SD	Sudan
AF_SH	Saint Helena
AF_SL	Sierra Leone
AF_SN	Senegal
AF_SO	Somalia
AF_SS	South Sudan
AF_ST	São Tomé and Príncipe
AF_SZ	Eswatini
AF_TD	Chad
AF_TG	Togo
AF_TN	Tunisia
AF_TZ	Tanzania
AF_UG	Uganda
AF_YT	Mayotte
AF_ZA	South Africa
AF_ZM	Zambia
AF_ZW	Zimbabwe

Antarctica AN

Code	Description
AN_AQ	Antarctica
AN_BV	Bouvet Island
AN_GS	South Georgia and South Sandwich Islands
AN_HM	Heard and McDonald Islands
AN_TF	French Southern Territories

Asia AS

Code	Description
AS_AE	United Arab Emirates
AS_AF	Afghanistan
AS_AM	Armenia
AS_AZ	Azerbaijan
AS_BD	Bangladesh
AS_BH	Bahrain
AS_BN	Brunei
AS_BT	Bhutan
AS_CC	Cocos (Keeling) Islands
AS_CN	China
AS_GE	Georgia
AS_HK	Hong Kong
AS_ID	Indonesia
AS_IL	Israel
AS_IN	India
AS_IO	British Indian Ocean Territory
AS_IQ	Iraq
AS_IR	Iran
AS_JO	Jordan
AS_JP	Japan
AS_KG	Kyrgyzstan
AS_KH	Cambodia
AS_KP	North Korea
AS_KR	South Korea
AS_KW	Kuwait
AS_KZ	Kazakhstan
AS_LA	Laos
AS_LB	Lebanon
AS_LK	Sri Lanka
AS_MM	Myanmar
AS_MN	Mongolia
AS_MO	Macao
AS_MV	Maldives
AS_MY	Malaysia
AS_NP	Nepal
AS_OM	Oman
AS_PH	Philippines
AS_PK	Pakistan
AS_PS	Palestine
AS_QA	Qatar
AS_SA	Saudi Arabia
AS_SG	Singapore
AS_SY	Syria
AS_TH	Thailand
AS_TJ	Tajikistan
AS_TM	Turkmenistan
AS_TR	Turkey
AS_TW	Taiwan
AS_UZ	Uzbekistan
AS_VN	Vietnam
AS_YE	Yemen

Europe EU

Code	Description
EU_AD	Andorra
EU_AL	Albania
EU_AT	Austria
EU_AX	Åland
EU_BA	Bosnia and Herzegovina
EU_BE	Belgium
EU_BG	Bulgaria
EU_BY	Belarus
EU_CH	Switzerland
EU_CY	Cyprus
EU_CZ	Czechia
EU_DE	Germany
EU_DK	Denmark
EU_EE	Estonia
EU_ES	Spain
EU_FI	Finland
EU_FO	Faroe Islands
EU_FR	France
EU_GB	United Kingdom
EU_GG	Guernsey
EU_GI	Gibraltar
EU_GR	Greece
EU_HR	Croatia
EU_HU	Hungary
EU_IE	Ireland
EU_IM	Isle of Man
EU_IS	Iceland
EU_IT	Italy
EU_JE	Jersey
EU_LI	Liechtenstein
EU_LT	Lithuania
EU_LU	Luxembourg
EU_LV	Latvia
EU_MC	Monaco
EU_MD	Moldova
EU_ME	Montenegro
EU_MK	North Macedonia
EU_MT	Malta
EU_NL	Netherlands
EU_NO	Norway
EU_PL	Poland
EU_PT	Portugal
EU_RO	Romania
EU_RS	Serbia
EU_RU	Russia
EU_SE	Sweden
EU_SI	Slovenia
EU_SJ	Svalbard and Jan Mayen
EU_SK	Slovakia
EU_SM	San Marino
EU_UA	Ukraine
EU_VA	Vatican City
EU_XK	Kosovo

North America NA

Code	Description
NA_AG	Antigua and Barbuda
NA_AI	Anguilla
NA_AW	Aruba
NA_BB	Barbados
NA_BL	Saint Barthélemy
NA_BM	Bermuda
NA_BQ	Bonaire, Sint Eustatius, and Saba
NA_BS	Bahamas
NA_BZ	Belize
NA_CA	Canada
NA_CR	Costa Rica
NA_CU	Cuba
NA_CW	Curaçao
NA_DM	Dominica
NA_DO	Dominican Republic
NA_GD	Grenada
NA_GL	Greenland
NA_GP	Guadeloupe
NA_GT	Guatemala
NA_HN	Honduras
NA_HT	Haiti
NA_JM	Jamaica
NA_KN	Saint Kitts and Nevis
NA_KY	Cayman Islands
NA_LC	Saint Lucia
NA_MF	Saint Martin
NA_MQ	Martinique
NA_MS	Montserrat
NA_MX	Mexico
NA_NI	Nicaragua
NA_PA	Panama
NA_PM	Saint Pierre and Miquelon
NA_PR	Puerto Rico
NA_SV	El Salvador
NA_SX	Saint Martin
NA_TC	Turks and Caicos Islands
NA_TT	Trinidad and Tobago
NA_US	United States
NA_VC	Saint Vincent and the Grenadines
NA_VG	British Virgin Islands
NA_VI	U.S. Virgin Islands

Oceania OC

Code	Description
OC_AS	American Samoa
OC_AU	Australia
OC_CK	Cook Islands
OC_CX	Christmas Island
OC_FJ	Fiji
OC_FM	Micronesia
OC_GU	Guam
OC_KI	Kiribati
OC_MH	Marshall Islands
OC_MP	Northern Mariana Islands
OC_NC	New Caledonia
OC_NF	Norfolk Island
OC_NR	Nauru
OC_NU	Niue
OC_NZ	New Zealand
OC_PF	French Polynesia
OC_PG	Papua New Guinea
OC_PN	Pitcairn Islands
OC_PW	Palau
OC_SB	Solomon Islands
OC_TK	Tokelau
OC_TL	Timor-Leste
OC_TO	Tonga
OC_TV	Tuvalu
OC_UM	U.S. Outlying Islands
OC_VU	Vanuatu
OC_WF	Wallis and Futuna
OC_WS	Samoa

South America SA

Code	Description
SA_AR	Argentina
SA_BO	Bolivia
SA_BR	Brazil
SA_CL	Chile
SA_CO	Colombia
SA_EC	Ecuador
SA_FK	Falkland Islands
SA_GF	French Guiana
SA_GY	Guyana
SA_PE	Peru
SA_PY	Paraguay
SA_SR	Suriname
SA_UY	Uruguay
SA_VE	Venezuela