Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Prerequisite: You need a domain name. If you do not have one already, get a domain name and register it with a domain registrar.
To connect your domain name to the IONOS Cloud DNS zone that you created, specify the IONOS Cloud DNS nameservers as the domain's authoritative nameservers.
To connect a domain nameserver to a DNS zone, follow these steps:
Create a DNS Zone for your domain and the associated DNS records.
Save the four nameservers Cloud DNS provided upon creating the DNS zone.
Go to your Domain Registrar and update your domain's nameservers with the four nameservers from the previous step.
Note: Changes to nameservers can take up to 48 hours, but they usually happen much faster.
Result: The domain nameserver is connected to the Cloud DNS.
Prerequisite: You need administrative privileges to create and assign user privileges by using the Cloud API.
To set user privileges using the Cloud API for managing DNS zones and records, follow these steps:
Authenticate to the Cloud API using your API credentials.
Create a user using the POST /cloudapi/v6/um/users endpoint.
Set the following required parameters for the user: user's name, email address, and password.
Create a group using the POST /cloudapi/v6/um/groups endpoint.
Set "accessAndManageDns" privilege to true.
Assign the user to the created group using POST /cloudapi/v6/um/groups/{groupId}/users endpoint and provide the user ID in the header.
Result: The Access and Manage DNS privilege is granted to the user.
Note: Only contract administrators, owners, and users with "accessAndManageDns" privilege can create and manage DNS zones and DNS records via API. You can also set User privileges in the DCD.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To create a DNS zone with Cloud DNS API, follow this step:
Perform a POST request with the domain or subdomain, a description of your DNS zone (optional), and the DNS zone status (enable), true or false.
Result: On a successful POST request, you receive a response containing the DNS zone UUID, Name Servers, and the request status.
202 Successful operation
Similar to creating a DNS zone, you need to provide the UUID of the DNS zone to host the new record.
Note: There are various record types for DNS records, and each of them has unique specifications.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To create a DNS zone of Type A, follow this step:
Perform a POST request with these details:
corresponding UUID of the DNS zone,
name of the subdomain; example: www
record type; in this case: A,
content or destination of the A record in the form of an IPv4 address; example: 1.1.1.1
TTL you need (minimum 60 seconds and maximum 86.400 seconds), and
status of the DNS record (enable), true or false.
Result: On a successful POST request, you receive a response with the DNS record having the UUID assigned.
Info: If you want to create a Wildcard DNS record, you need to provide “*” as the name of your DNS record to match the requests for all non-existent names under your DNS zone name.
202 Successful operation
Create records of other types Cloud DNS supports the following record types: A, AAAA , CNAME, ALIAS, MX, NS, SOA, SRV, TXT, CAA, SSHFP, TLSA, SMIMEA, DS, HTTPS, SVCB, OPENPGPKEY, CERT, URI, RP and LOC.
Here is a brief explanation of the most common record types:
A: Specifies the IPv4 address associated with a zone name.
AAAA: Specifies the IPv6 address associated with a zone name.
MX: Specifies the mail exchange servers for a zone name.
CNAME: Specifies an alias for a zone name, allowing multiple names to resolve to the same IP address.
TXT: Allows arbitrary text to be associated with a zone name that is commonly used for SPF records and other types of verification.
NS: Specifies the name servers for a zone name.
SRV: Specifies the location of services for a zone name that is commonly used for Session Initiation Protocol (SIP) and other protocols.
Here you can see examples of records with different record types:
The lets you manage DNS zones and records programmatically using conventional HTTP requests.
Prerequisite: To start using the Cloud DNS API, you need a domain name. If you do not have one already, get a domain name and register it with a domain registrar.
On successful registration of the domain name, you can now assign more users with the privilege to manage DNS zones and records via the API. By default, only contract owners and administrators have permission to use the Cloud DNS API.
To set user privileges via the API, see .
On assigning user privileges, continue with the following API How-Tos:
If you already have a primary zone hosted elsewhere, you can to improve reliability, redundancy, load balancing, and performance.
Additionally, try the following features for your primary zones hosted in Cloud DNS:
You can import a DNS zone from your existing DNS provider to IONOS Cloud.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To import an existing zone to IONOS Cloud DNS, follow these steps:
Create a DNS zone without records.
Perform a PUT request providing the zoneId of the newly created zone and the zone file.
Result: On a successful PUT request, the records provided in the zone file will be added to your DNS zone.
Important: If the zone file you import contains CNAME entries that point to names in another private zone, Azure DNS resolution of the CNAME will fail unless the other private zone is imported or the CNAME entries are modified.
200 Successful operation
The imported file has to be in BIND format, a widely used format supported by most DNS software, including the popular BIND DNS server.
The file should include all the record types associated with the selected zone. The Start of Authority (SOA) and Name Server (NS) records are not to be considered since IONOS Cloud uses its name server configuration.
Similar to retrieving a DNS zone, you need to provide the UUID of the DNS zone that you want to export.
Prerequisite: You need an IONOS Cloud account with API credentials configured with the appropriate permissions.
To export an existing zone at IONOS Cloud DNS in a BIND format, follow this step:
Perform a GET request providing the zoneId of your zone.
Result: On a successful GET request, you receive the BIND file with the DNS zone having the UUID assigned.
200 Successful operation
The exported zone file is in BIND format, a widely used format supported by most DNS software, including the BIND DNS server.
The file includes all record types associated with the selected zone, including SOA record, NS record, Service (SRV) record, and configuration information such as TTL values.
An example of a file in BIND format with an updated SRV record is as follows:
Prerequisite: Before creating a secondary DNS zone with IONOS Cloud DNS, ensure that the primary zone is capable of establishing a zone transfer with the secondary DNS server; this means port 53 is open for TCP and UDP connections.
To create a secondary zone on the IONOS Cloud DNS, follow this step:
Perform a POST request to the /secondaryzones endpoint by providing the zoneName, description, and primaryIps for the IP address of the primary nameserver.
Note: For sending DNS notify messages, Cloud DNS uses following Anycast addresses: IPv4 212.227.123.25 or IPv6 2001:8d8:fe:53::5cd:25.
Result: On a successful POST request, you receive a response containing the secondary DNS zone UUID, Name Servers, primaryIps, and the request status.
202 Accepted
To retrieve information about all the secondary zones, follow this step:
Send a GET request to the /secondaryzones endpoint.
Result: On a successful GET request, you receive a response containing all secondary DNS zones.
200 OK
To retrieve information about a specific secondary zone, follow this step:
Send a GET request to the /secondaryzones/{secondaryzoneId} endpoint.
Result: On a successful GET request, you receive a response containing the secondary DNS zone UUID, Name Servers, primaryIps, and secondary zone status.
To retrieve records information about a specific secondary zone, follow this step:
Send a GET request to the /secondaryzones/{secondaryzoneId}/records endpoint.
Result: On a successful GET request, you receive a response containing the secondary DNS zone records information: status,content, type, priority, TTL and name.
To modify the description of a secondary zone or update the IP addresses of its primary nameserver, follow this step:
Send a PUT request to the /secondaryzones/{secondaryzoneId} endpoint.
Result: On a successful PUT request, you receive a response containing the secondary DNS zone metadata with the new updated properties.
202 Accepted
Note: The creation of a secondary zone initiates zone transfer. In case of disrupted network connectivity at this time, you can initiate the zone transfer manually between the primary and secondary (i.e. secondary name server could not access primary nameserver on port 53) zones.
To initiate zone transfer from the primary zone to the secondary zone, follow this step:
Send a PUT request to the /secondaryzones/{secondaryzoneId}/axfr endpoint.
Note: For sending DNS notify messages, Cloud DNS uses following Anycast addresses: IPv4 212.227.123.25 or IPv6 2001:8d8:fe:53::5cd:25.
Result: On a successful PUT request, you receive an HTTP response 200 OK.
200 OK
To check zone transfer status, follow this step:
Perform a GET request to /secondaryzones/{secondaryzoneId}/axfr endpoint.
Result: On a successful GET request, you receive a response for AXFR communication status for each of primaryIps.
200 OK
To delete a secondary zone from the IONOS Cloud DNS, follow this step:
Send a DELETE request to the /secondaryzones/{zoneId} endpoint.
Result: On a successful DELETE request, you receive an HTTP status 200 Accepted.
200 Accepted
| Field | Type | Description | Example |
|---|---|---|---|
| Field | Type | Description | Example |
|---|---|---|---|
| Record Type | Record Name | Record Value | Notes |
|---|---|---|---|
id
string
UUID of the newly created DNS zone
2a4428b3-dbe0-4357-9c02-609025b3a40f
createdDate
string
DNS zone creation timestamp
2023-03-15T09:58:59.147746133Z
lastModifiedDate
string
DNS zone update timestamp
2023-03-15T09:58:59.147746133Z
nameservers
array
Name Servers assigned to the DNS zone
"ns-ic.ui-dns.com", "ns-ic.ui-dns.de", "ns-ic.ui-dns.org", "ns-ic.ui-dns.biz"
state
string
State of the request
CREATED
id
string
UUID of the newly created DNS record
90d81ac0-3a30-44d4-95a5-12959effa6ee
createdDate
string
DNS record creation timestamp
2023-03-15T09:58:59.147746133Z
lastModifiedDate
string
DNS record update timestamp
2023-03-15T09:58:59.147746133Z
zoneId
string
UUID of the DNS zone of the DNS record
2a4428b3-dbe0-4357-9c02-609025b3a40f
fqdn
string
Fully qualified domain name resulting from the record name and the zoneName
*.example.com
state
string
State of the request
CREATED
A
example.com
192.168.1.1
AAAA
example.com
2001:0db8:85a3:0000:0000:8a2e:0370:7334
MX
example.com
mail.example.com
Priority has to be provided
CNAME
www.example.com
example.com
TXT
example.com
v=spf1 mx -all
NS
example.com
ns1.example.com
SRV
_sip._tcp.example.com
10 5060 sipserver.example.com
Priority weight port has to be provided
Prerequisite: To sign a zone, you need to first Create a DNS Zone.
To enable DNSSEC keys for a DNS zone at IONOS Cloud DNS, follow these steps:
1. Perform a POST request to the /zones/{zoneId}/keys endpoint.
2. Replace {zoneId} with the UUID of the DNS zone where you want to enable DNSSEC keys.
3. In the request body, provide the key parameters used to sign the zone. These parameters include the signing algorithm, key length for both Key Signing Keys (KSK), Zone Signing Keys (ZSK), NSEC mode (NSEC or NSEC3), and other relevant settings.
Result: The DNSSEC keys for a DNS zone are successfully enabled.
202 Accepted
To retrieve DNSSEC keys for a specific DNS zone at Cloud DNS, follow these steps:
1. Perform a GET request to the /zones/{zoneId}/keys endpoint.
2. Replace {zoneId} with the UUID of the DNS zone you want to retrieve keys for.
Result: The API response contains a list of DNSSEC keys associated with the specified DNS zone.
200 OK
To disable and delete DNSSEC keys for a DNS zone at Cloud DNS, follow these steps:
1. Perform a DELETE request to the /zones/{zoneId}/keys endpoint.
2. Replace {zoneId} with the UUID of the DNS zone from which you want to remove DNSSEC keys.
Result: The DNSSEC keys for the selected DNS zone are successfully disabled. The associated DNSSEC key records for the DNS zone is removed.
202 Accepted
If you have an infrastructure that uses public DNS records and manage it by defining the required state, you can use Cloud DNS as follows:
Create a DNS Zone with Cloud DNS.
Generate a UUID (v3, v4, and v5 supported) for your DNS record.
Add to your infrastructure a PUT call for the desired record configuration with your UUID and assign it to the corresponding DNS zone ID.
Result: On a successful PUT request,
If the record does not exist, Cloud DNS creates the record with the specified configuration.
If a record already exists but with a different configuration, the record is updated.
202 Successful operation
| Field | Type | Description | Example |
|---|---|---|---|
id
string
UUID of the newly created DNS record
90d81ac0-3a30-44d4-95a5-12959effa6ee
createdDate
string
DNS record creation timestamp
2023-03-15T09:58:59.147746133Z
lastModifiedDate
string
DNS record update timestamp
2023-03-15T09:58:59.147746133Z
zoneId
string
UUID of the DNS zone of the DNS record
2a4428b3-dbe0-4357-9c02-609025b3a40f
fqdn
string
Fully qualified domain name resulting from the record name and the zoneName
app.example.com
state
string
State of the request
CREATED