API V1 Feld Definition

[paul-hph]

Affected URL

https://developer.mittwald.de/de/docs/v1/reference/domains/listDomainrecordsByAccount/
https://developer.mittwald.de/de/docs/v1/reference/domains/getDomainOverview/

Describe the issue

In den allermeisten Fällen kann man sich den Sinn der Felder denken. Es wäre aber generell hilfreich, wenn die Felder beschrieben werden würden.

Ich habe keine große Hoffnung, dass ihr noch an der API V1 Doku große Anpassungen vornehmen werdet, daher wäre es super, wenn mir jemand auf kurzen Dienstweg zurufen könnte, was genau die folgenden Felder beschreiben. Ggf. noch wie diese Werte ermittelt werden und wie oft diese aktualisiert werden.

• isSslReady
• isTodoReady
• isUsingMittwaldMailsystem
• ipAddress

[martin-helmich]

Hey Paul. Ich kümmere mich mal darum, die entsprechenden Felder nachzudokumentieren (da ein paar scheduled Pipelines dazwischen hängen, kann es ein paar Tage dauern, bis das tatsächlich in der generierten Dokumentation angekommen ist).

Kurzübersicht, vorab:

• isSslReady: 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.
• isTodoReady: Deprecated in favor of isReady.
• isUsingMittwaldMailsystem: true if this domain record uses the mittwald mail system. In this case, the DNS zone's MX records will point to the mittwald-operated email server.
• ipAddress: The IP address of the server which is hosting this domain. If the domain is registered via mittwald (more precisely: if its DNS zone is managed by mittwald), this will automatically be the content of the DNS A record. If the DNS zone is managed by an external DNS vendor, this IP address needs to be configured as A record there.

[paul-hph]

Hallo Martin,

danke für dein schnelles Feedback. Kurze Rückfrage:

isUsingMittwaldMailsystem: true if this domain record uses the mittwald mail system. In this case, the DNS zone's MX records will point to the mittwald-operated email server.
Ich habe 3-4 Tests gemacht. Mir wird für Domains die keinen Mittwald-MX Record haben trotzem ein isUsingMittwaldMailsystem: true ausgegegeben. Kannst du das noch mal prüfen.

[martin-helmich]

Äh, gute Frage. Schick mir am besten mal ein paar Beispiele über einen anderen Kanal (E-Mail oder Slack). Sind die betroffenen Domains denn über uns registriert (bzw. genauer, wird die DNS-Zone von uns verwaltet)?

[paul-hph]

Habe dir per Slack geschrieben.
Die Domains sind nicht bei euch registriert.

[martin-helmich]

Alrighty. Bei extern verwalteten Domains hat das Feld leider keine Aussagekraft; es beschreibt lediglich den "Soll-Zustand" auf unseren eigenen DNS-Servern (der dann relevant wäre, wenn die Domains über uns verwaltet wird), scannt aber nicht tatsächlich die (extern verwalteten) MX-Records durch.

Ich passe die Dokumentation nochmal an.