Get domain overview

GET/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

      Indicates if a TLS certificate should be provisioned for this domain item. See isSslReady for the actual readiness of the certificate.

    • hasVarnishboolean

      required

      Indicates if a Varnish cache is active for this domain item.

    • isSubDomainboolean

      required
    • isExternalboolean

      required

      Indicates if this domain item is registered via mittwald, or via an external registry.

    • isSslReadyboolean

      required

      This property is false when a TLS certificate is currently being provisioned, or otherwise true. This means that this property is true, when A) no certificate is active at all (see hasSslCertificate, in this case), or B) a certificate has successfully been provisioned.

    • isTodoReadyboolean

      deprecated

      required

      Deprecated in favor of isReady.

    • isRegistrarJobOpenboolean

      required
    • isReadyboolean

      required

      Indicates if the domain has been provisioned successfully (true), or if it is currently being provisioned or edited (false).

  ]

Example

Content-Type: application/json

[
  {
    "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,
    "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",
        "description": "Indicates if a TLS certificate should be provisioned for this domain item. See `isSslReady` for the actual readiness of the certificate.\n"
      },
      "hasVarnish": {
        "type": "boolean",
        "description": "Indicates if a Varnish cache is active for this domain item.\n"
      },
      "isSubDomain": {
        "type": "boolean"
      },
      "isExternal": {
        "type": "boolean",
        "description": "Indicates if this domain item is registered via mittwald, or via an external registry.\n"
      },
      "isSslReady": {
        "type": "boolean",
        "description": "This property is `false` when a TLS certificate is currently being provisioned, or otherwise `true`. This means that this property is `true`, when A) no certificate is active at all (see `hasSslCertificate`, in this case), or B) a certificate has successfully been provisioned.\n"
      },
      "isTodoReady": {
        "type": "boolean",
        "deprecated": true,
        "description": "Deprecated in favor of `isReady`.\n"
      },
      "isRegistrarJobOpen": {
        "type": "boolean"
      },
      "isReady": {
        "type": "boolean",
        "description": "Indicates if the domain has been provisioned successfully (`true`), or if it is currently being provisioned or edited (`false`).\n"
      }
    }
  }
}

Usage examples

cURL

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