Get domain overview

GET /v1/accounts/{accountIdentifier}/domainOverview/

API version

v1

Request method

GET

Operation ID

getDomainOverview

---

Get the data for the domain overview

Request

• accountIdentifierstring

  required

  Account name or uid.

Responses

Format

application/json

Description

List of domain records for the domain overview

Schema documentation

• Array[
• *object
  • uidnumber

    required
  • _classstring

    required
  • fullnamestring

    required
  • domainstring

    required
  • targetstring

    required
  • accountUidnumber

    required
  • accountNamestring

    required
  • useAutodiscoverboolean

    required
  • hasSslCertificateboolean

    required
  • hasVarnishboolean

    required
  • isSubDomainboolean

    required
  • isExternalboolean

    required
  • isSslReadyboolean

    required
  • isTodoReadyboolean

    required
  • isRegistrarJobOpenboolean

    required
  • isReadyboolean

    required
]

Example

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

JSON Schema

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