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

• accountIdentifierstring

  required

  Account name or uid.

Responses

Format

application/json

Description

List of dns records for the dns overview

Schema documentation

• Array[
• *object
  • uidnumber

    required
  • _classstring

    required
  • isSubdomainboolean

    required
  • isReadyboolean

    required
  • hasSslCertificateboolean

    required
  • fullNamestring

    required
  • domainNamestring

    required
  • defaultAccountIpstring

    required
  • defaultDomainIpobject
    • 4string
    • 6string
  • recordsobject

    required
    • Aarray of object

      required
      • Array[
      • *object
        • hoststring

          required
        • valuestring

          required
        • ttlnumber

          required
        • prioritynumber

          required
      ]
  • AAAAarray of object

    required
    • Array[
    • *object
      • hoststring

        required
      • valuestring

        required
      • ttlnumber

        required
      • prioritynumber

        required
    ]
• CNAMEarray of object

  required
  • Array[
  • *object
    • hoststring

      required
    • valuestring

      required
    • ttlnumber

      required
    • prioritynumber

      required
  ]

NSarray of object

required

• Array[
• *object
  • hoststring

    required
  • valuestring

    required
  • ttlnumber

    required
  • prioritynumber

    required
]

MXarray of object

required

• Array[
• *object
  • hoststring

    required
  • valuestring

    required
  • ttlnumber

    required
  • prioritynumber

    required
]

TXTarray of object

required

• Array[
• *object
  • hoststring

    required
  • valuestring

    required
  • ttlnumber

    required
  • prioritynumber

    required
]

SRVarray of object

required

• Array[
• *object
  • hoststring

    required
  • valuestring

    required
  • ttlnumber

    required
  • prioritynumber

    required
]

CAAarray of object

required

• Array[
• *object
  • hoststring

    required
  • valuestring

    required
  • ttlnumber

    required
  • prioritynumber

    required
]

]

Example

[
  {
    "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
        }
      ]
    }
  }
]

JSON Schema

{
  "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"
                }
              }
            }
          }
        }
      }
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/accounts/string/dns