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

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

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

---

---

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.

InputNameserver

Name	Required	Type	Default value	Description
name	Yes	String		The name of the server.
primary	Yes	Boolean		Only one server can be defined as primary.

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

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