Introduction

Search and display zones and records.
Edit your zone properties and resource records, import and export zones and secure zone modifications through a validation system.

API Versions

The current version of the DNS API is version 3.
We encourage you to keep your API client up to date so you can take advantage of the latest features.
The changelog lists all changes made to our API routes and objects and will help you update your API client.

The DNS API base URL for the production environment is :

https://api.nameshield.net/dns/v3

The DNS API base URL for the OTE environment is :

https://ote-api.nameshield.net/dns/v3

Zone modification

Take care

All changes made in a zone must be validated to be applied.

This mechanism allows you to perform several operations to prepare your zone and then validate it.
Changes are retained until you validate them with the validation endpoint or cancel them with the cancellation endpoint.

Changes made via the API can be viewed on the web application, and vice versa.
You have the possibility to use the API to prepare the changes in your zone, and have them validated by someone else from the web interface.

Supported record types

The DNS record types supported by the API are :

• A
• AAAA
• ALIAS
• CAA
• CNAME
• HTTPS
• LOC
• MX
• NAPTR
• NS
• PTR
• RP
• SPF
• SRV
• SSHFP
• SVCB
• TLSA
• TXT

Record types specifications

You can’t create, update or delete NS records at the APEX of a zone or NS records matching a subzone.

Some types of records must follow a specific format :

Type	Example
MX	0 mx.example.com.
SRV	0 33 5060 serveursip1.example.com.
RP	admin.example.com. other.example.com.
CAA	0 issue "ca.example.net"
NAPTR	100 10 "U" "E2U+sip" "!^.*$!sip:customer-service@example.com!" .
LOC	52 22 23.000 N 4 53 32 E 2m 0m 10000m 10m

Some records need to add double quotes to separate the different fields.
The JSON format requires escaping them by adding backslashes.

Example :

{
    "name": "test",
    "type": "NAPTR",
    "data": "100 10 \"U\" \" E2U+sip\" \"!^.*$!sip:customer- service@example.com!\" ."
}

In addition, to fill double quotes inside a field delimited by double quotes, you must add three backslashes to escape the character.

{
    "name": "test",
    "type": "TXT",
    "data": "\"text \\\" text\""
}

Search parameters

Case sensitivity

Search parameters are case-insensitive (e.g., Comment and comment are treated the same).

Wildcard compatibility

Properties marked as "Wildcard compatible" support the use of the * character to perform partial (fuzzy) searches.
This allows you to query values without knowing the exact string or match several elements with one request.

Usage

• Use * at the end of a term to match values that start with the given text.
• Use * at the beginning of a term to match values that end with the given text.
• Use * on both sides of a term to match values that contain the given text.
• Use * inside a term to match values that contain additional characters in between.

The * wildcard may also match zero characters (e.g., name*shield.net matches nameshield.net).

Examples

Query	Matches
nameshield.*	nameshield.com, nameshield.net
*.com	nameshield.com, example.com
*shield.co.*	nameshield.co.uk, othershield.co.jp
name*.com	nameshield.com, name-example.com
*name*.*	nameshield.com, other-name-example.net