Alle SSL/TLS-Zertifikate einer Domain auflisten¶

Note

Die Attribute cert und key sind in der API-Antwort aus Sicherheitsgründen immer leer.

Senden einer GET-Anfrage an den Endpunkt /domain/{domainId}/ssl/certificates.

Beschreibung¶

Mit der List-SSL-Certificates-Anfrage rufen Sie eine Liste aller SSL/TLS-Zertifikate einer Domain der Organisation ab.

Voraussetzungen¶

Werte der Anfrage: Domain-ID {domainId}

Objekte: keine

Anfrage¶

Um eine Liste aller SSL/TLS-Zertifikate einer Domain abzurufen, fügen Sie die Domain-ID {domainId} dem Pfad der HTTP-Anfrage hinzu.

Als Ergebnis erhalten Sie ein oder mehrere Objekte SslCertVO und SslIntermediateVO mit den angefragten Informationen.

Das Objekt SslCertVO liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`subject`	Der Subject des Zertifikats.
`algorithm`	Der für die Verschlüsselung des Zertifikats verwendete Algorithmus.
`validFrom`	Das Datum im ISO-8601-Format, ab dem das Zertifikat gültig ist.
`validTo`	Das Datum im ISO-8601-Format, bis zu dem das Zertifikat gültig ist.
`cert`	Das Attribut `cert` enthält das Zertifikat.
`fingerprint`	Der Fingerprint des Zertifikats.
`serialNumber`	Die Seriennummer des Zertifikats.
`subjectAlternatives`	Ein Array aller Subdomains, für die das Zertifikat gültig ist.
`intermediates`	Ein oder mehrere Objekte `SslIntermediateVO`.
`key`	Der verschlüsselte private Schlüssel.
`wildcard`	Die Gültigkeit des Zertifikats für mehrere Subdomains einer Domain. Das Zertifikat muss einen *.domain.tld-Subject haben, damit `true` zurückgegeben wird.	`true` `false`
`extendedValidation`	`True`, wenn der Browser das Zertifikat als Extended Validation behandelt. Myra verwendet die OIDs von Google Chrome™, um den Extended-Validation-Level zu ermitteln.	`true` `false`
`ipList`	Ein Array aller IPs.
`subdomains`	Ein Array aller im Zertifikat enthaltenen Subdomains.
`certToRefresh`	Die ID des Zertifikats, um ein vorhandenes Zertifikat zu aktualisieren.
`certRefreshForced`	Jedes Mal, wenn ein Zertifikat durch ein anderes, nicht passendes Zertifikat erneuert wird, wird der Vorgang mit einem Fehler abgebrochen. Wird `certRefreshForced` gesetzt, werden solche Fehler ignoriert und das Zertifikat trotzdem erneuert. Verwenden Sie das Attribut nur, wenn Sie sicher sind, dass Sie einen Fehler beim Erneuern eines Zertifikats ignorieren können.	`true` `false`
`sniAllowed`	Legt fest, ob die Server Name Indication zulässig ist.	`true` `false`
`password`	Das Passwort zum Entschlüsseln eines verschlüsselten Zertifikats. Ein verschlüsseltes Zertifikat sollte im PKCS12-Format vorliegen. In diesem Fall enthält das Attribut `cert` einen base64-codierten Wert des binär verschlüsselten Zertifikats (da sich ein Binärinhalt nicht in ein JSON-Feld setzen lässt). Das Passwortfeld wird ignoriert, wenn der Inhalt des Attributs `cert` nicht im PKCS12-Format vorliegt.
`managed`	Legt fest, ob das Zertifikat von Myra verwaltet wird. Wird das Zertifikat von Myra verwaltet, ist es nicht über die API bearbeitbar und kann nur gelesen werden. Der Wert des Attributs kann beim Erstellen oder Aktualisieren eines Zertifikats über die API nicht gesetzt werden.	`true` `false`
`sslConfigurationName`	Der Konfigurationsname aus der Tabelle SSLConfiguration.
`comment`	Ein individueller Kommentar für den Eintrag.	`string`
`id`	Die ID des Zertifikats.
`modified`	Das Datum der letzten Änderung im ISO-8601-Format.	`string($date-time)`
`created`	Das Erstellungsdatum im ISO-8601-Format.	`string($date-time)`

Das Objekt SslIntermediateVO liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`subject`	Der Subject des Intermediate-Zertifikats.
`algorithm`	Der für die Verschlüsselung des Intermediate-Zertifikats verwendete Algorithmus.
`validFrom`	Das Datum im ISO-8601-Format, ab dem das Intermediate-Zertifikat gültig ist.
`validTo`	Das Datum im ISO-8601-Format, bis zu dem das Intermediate-Zertifikat gültig ist.
`cert`	Das Attribut `cert` enthält das Intermediate-Zertifikat.
`fingerprint`	Der Fingerprint des Intermediate-Zertifikats.
`serialNumber`	Die Seriennummer des Intermediate-Zertifikats.
`issuer`	Der Name des Zertifikatsausstellers.
`comment`	Ein individueller Kommentar für den Eintrag.	`string`
`id`	Die ID des Intermediate-Zertifikats.
`modified`	Das Datum der letzten Änderung im ISO-8601-Format.	`string($date-time)`
`created`	Das Erstellungsdatum im ISO-8601-Format.	`string($date-time)`

Beispiel¶

Beispiel-Antwort:

[
  {
    "objectType": "string",
    "subject": "string",
    "algorithm": "string",
    "validFrom": "string",
    "validTo": "string",
    "cert": "string",
    "fingerprint": "string",
    "serialNumber": "string",
    "id": 0,
    "modified": "string",
    "created": "string",
    "comment": "string",
    "subjectAlternatives": [
      "string"
    ],
    "intermediates": [
      {
        "objectType": "string",
        "subject": "string",
        "algorithm": "string",
        "validFrom": "string",
        "validTo": "string",
        "cert": "string",
        "fingerprint": "string",
        "serialNumber": "string",
        "id": 0,
        "modified": "string",
        "created": "string",
        "comment": "string",
        "issuer": "string"
      }
    ],
    "key": "string",
    "wildcard": true,
    "extendedValidation": true,
    "ipList": "string",
    "subdomains": "string",
    "certToRefresh": 0,
    "certRefreshForced": true,
    "sniAllowed": true,
    "password": "string",
    "managed": true,
    "multidomain": true,
    "sslConfigurationName": "string",
    "requestId": 0
  }
]

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
200	Die Anfrage war erfolgreich.
400	Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.