Version: API v1
Get dns overview
GET/v1/accounts/{accountIdentifier}/dns
API version
v1
Request method
GET
Operation ID
getDnsOverview
Get the data for the dns overview
Request
- accountIdentifierstringrequired
Account name or uid.
Responses
Format
application/json
Description
List of dns records for the dns overview
- Array[
- *object
- uidnumberrequired
- _classstringrequired
- isSubdomainbooleanrequired
- isReadybooleanrequired
- hasSslCertificatebooleanrequired
- fullNamestringrequired
- domainNamestringrequired
- defaultAccountIpstringrequired
- defaultDomainIpobject
- 4string
- 6string
- recordsobjectrequired
- Aarray of objectrequired
- Array[
- *object
- hoststringrequired
- valuestringrequired
- ttlnumberrequired
- prioritynumberrequired
]
- AAAAarray of objectrequired
- Array[
- *object
- hoststringrequired
- valuestringrequired
- ttlnumberrequired
- prioritynumberrequired
]
- CNAMEarray of objectrequired
- Array[
- *object
- hoststringrequired
- valuestringrequired
- ttlnumberrequired
- prioritynumberrequired
]
- NSarray of objectrequired
- Array[
- *object
- hoststringrequired
- valuestringrequired
- ttlnumberrequired
- prioritynumberrequired
]
- MXarray of objectrequired
- Array[
- *object
- hoststringrequired
- valuestringrequired
- ttlnumberrequired
- prioritynumberrequired
]
- TXTarray of objectrequired
- Array[
- *object
- hoststringrequired
- valuestringrequired
- ttlnumberrequired
- prioritynumberrequired
]
- SRVarray of objectrequired
- Array[
- *object
- hoststringrequired
- valuestringrequired
- ttlnumberrequired
- prioritynumberrequired
]
- CAAarray of objectrequired
- Array[
- *object
- hoststringrequired
- valuestringrequired
- ttlnumberrequired
- prioritynumberrequired
]
]
Content-Type: application/json
[
{
"uid": 123,
"_class": "string",
"isSubdomain": true,
"isReady": true,
"hasSslCertificate": true,
"fullName": "string",
"domainName": "string",
"defaultAccountIp": "string",
"defaultDomainIp": {
"4": "string",
"6": "string"
},
"records": {
"A": [
{
"host": "string",
"value": "string",
"ttl": 123,
"priority": 123
}
],
"AAAA": [
{
"host": "string",
"value": "string",
"ttl": 123,
"priority": 123
}
],
"CNAME": [
{
"host": "string",
"value": "string",
"ttl": 123,
"priority": 123
}
],
"NS": [
{
"host": "string",
"value": "string",
"ttl": 123,
"priority": 123
}
],
"MX": [
{
"host": "string",
"value": "string",
"ttl": 123,
"priority": 123
}
],
"TXT": [
{
"host": "string",
"value": "string",
"ttl": 123,
"priority": 123
}
],
"SRV": [
{
"host": "string",
"value": "string",
"ttl": 123,
"priority": 123
}
],
"CAA": [
{
"host": "string",
"value": "string",
"ttl": 123,
"priority": 123
}
]
}
}
]
{
"type": "array",
"items": {
"type": "object",
"required": [
"uid",
"_class",
"isSubdomain",
"isReady",
"hasSslCertificate",
"fullName",
"domainName",
"defaultAccountIp",
"records"
],
"properties": {
"uid": {
"type": "number"
},
"_class": {
"type": "string"
},
"isSubdomain": {
"type": "boolean"
},
"isReady": {
"type": "boolean"
},
"hasSslCertificate": {
"type": "boolean"
},
"fullName": {
"type": "string"
},
"domainName": {
"type": "string"
},
"defaultAccountIp": {
"type": "string"
},
"defaultDomainIp": {
"type": "object",
"properties": {
"4": {
"type": "string"
},
"6": {
"type": "string"
}
}
},
"records": {
"type": "object",
"required": [
"A",
"AAAA",
"CNAME",
"NS",
"MX",
"TXT",
"SRV",
"CAA"
],
"properties": {
"A": {
"type": "array",
"items": {
"type": "object",
"required": [
"host",
"value",
"ttl",
"priority"
],
"properties": {
"host": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "number"
},
"priority": {
"type": "number"
}
}
}
},
"AAAA": {
"type": "array",
"items": {
"type": "object",
"required": [
"host",
"value",
"ttl",
"priority"
],
"properties": {
"host": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "number"
},
"priority": {
"type": "number"
}
}
}
},
"CNAME": {
"type": "array",
"items": {
"type": "object",
"required": [
"host",
"value",
"ttl",
"priority"
],
"properties": {
"host": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "number"
},
"priority": {
"type": "number"
}
}
}
},
"NS": {
"type": "array",
"items": {
"type": "object",
"required": [
"host",
"value",
"ttl",
"priority"
],
"properties": {
"host": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "number"
},
"priority": {
"type": "number"
}
}
}
},
"MX": {
"type": "array",
"items": {
"type": "object",
"required": [
"host",
"value",
"ttl",
"priority"
],
"properties": {
"host": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "number"
},
"priority": {
"type": "number"
}
}
}
},
"TXT": {
"type": "array",
"items": {
"type": "object",
"required": [
"host",
"value",
"ttl",
"priority"
],
"properties": {
"host": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "number"
},
"priority": {
"type": "number"
}
}
}
},
"SRV": {
"type": "array",
"items": {
"type": "object",
"required": [
"host",
"value",
"ttl",
"priority"
],
"properties": {
"host": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "number"
},
"priority": {
"type": "number"
}
}
}
},
"CAA": {
"type": "array",
"items": {
"type": "object",
"required": [
"host",
"value",
"ttl",
"priority"
],
"properties": {
"host": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "number"
},
"priority": {
"type": "number"
}
}
}
}
}
}
}
}
}
Format
application/json
Description
General error.
- messagestring
Content-Type: application/json
{
"message": "string"
}
{
"title": "Message",
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
Usage examples
$ curl \
--fail \
--location \
-H "Authorization: Bearer $MITTWALD_API_TOKEN" \
https://api.mittwald.de/v1/accounts/string/dns