Get domain overview
GET /v1/ accounts/ {accountIdentifier}/ domainOverview/
v1
GET
getDomainOverview
Get the data for the domain overview
Request
- accountIdentifierstringrequired
Account name or uid.
Responses
application/json
List of domain records for the domain overview
- Schema-Dokumentation
- Beispiel
- JSON Schema
- Array[
- *object
- uidnumberrequired
- _classstringrequired
- fullnamestringrequired
- domainstringrequired
- targetstringrequired
- accountUidnumberrequired
- accountNamestringrequired
- useAutodiscoverbooleanrequired
- hasSslCertificatebooleanrequired
- hasVarnishbooleanrequired
- isSubDomainbooleanrequired
- isExternalbooleanrequired
- isSslReadybooleanrequired
- isTodoReadybooleanrequired
- isRegistrarJobOpenbooleanrequired
- isReadybooleanrequired
]
[
{
"uid": 123,
"_class": "string",
"fullname": "string",
"domain": "string",
"target": "string",
"accountUid": 123,
"accountName": "string",
"useAutodiscover": true,
"hasSslCertificate": true,
"hasVarnish": true,
"isSubDomain": true,
"isExternal": true,
"isSslReady": true,
"isTodoReady": true,
"isRegistrarJobOpen": true,
"isReady": true
}
]
{
"type": "array",
"items": {
"type": "object",
"required": [
"uid",
"_class",
"fullname",
"domain",
"target",
"accountUid",
"accountName",
"useAutodiscover",
"hasSslCertificate",
"hasVarnish",
"isSubDomain",
"isExternal",
"isSslReady",
"isTodoReady",
"isRegistrarJobOpen",
"isReady"
],
"properties": {
"uid": {
"type": "number"
},
"_class": {
"type": "string"
},
"fullname": {
"type": "string"
},
"domain": {
"type": "string"
},
"target": {
"type": "string"
},
"accountUid": {
"type": "number"
},
"accountName": {
"type": "string"
},
"useAutodiscover": {
"type": "boolean"
},
"hasSslCertificate": {
"type": "boolean"
},
"hasVarnish": {
"type": "boolean"
},
"isSubDomain": {
"type": "boolean"
},
"isExternal": {
"type": "boolean"
},
"isSslReady": {
"type": "boolean"
},
"isTodoReady": {
"type": "boolean"
},
"isRegistrarJobOpen": {
"type": "boolean"
},
"isReady": {
"type": "boolean"
}
}
}
}
Usage examples
- cURL
$ curl \
--fail \
--location \
-H "Authorization: Bearer $MITTWALD_API_TOKEN" \
https://api.mittwald.de/v1/accounts/string/domainOverview