Ein SSL/TLS-Zertifikat aktualisieren¶
Note
Die Attribute cert und key können über die API nicht geändert werden. Es ist nur möglich, die Liste der Subdomains und das Intermediate-Zertifikat zu ändern. Wenn Sie die Verifizierung oder den Schlüssel ändern müssen, verwenden Sie die Add-SSL-Certificate-Anfrage, um ein neues Zertifikat hochzuladen.
Note
Der Body muss die Attribute id und modified enthalten, um den entsprechenden Eintrag zu identifizieren.
Note
Die ID des Eintrags im Pfad der Anfrage muss mit dem Wert des Attributs id im Body übereinstimmen.
Note
Die Attribute cert und key sind in der API-Antwort aus Sicherheitsgründen immer leer.
Senden einer PUT-Anfrage an den Endpunkt /domain/{domainId}/certificates/{id}.
Beschreibung¶
Mit der Update-SSL-Certificate-Anfrage aktualisieren Sie ein SSL/TLS-Zertifikat einer Domain der Organisation.
Voraussetzungen¶
Werte der Anfrage: Domain-ID {domainId}, SSL-ID {id}
Objekte: SslCertVO, SslIntermediateVO
Anfrage¶
Um ein SSL/TLS-Zertifikat einer Domain zu aktualisieren, fügen Sie die Domain-ID {domainId} und die SSL-ID {id} dem Pfad der HTTP-Anfrage hinzu.
Für eine detaillierte Spezifikation, welche Informationen zum Aktualisieren eines SSL/TLS-Zertifikats erforderlich sind, müssen im Body die Objekte SslCertVO und SslIntermediateVO mit den folgenden Attributen definiert werden:
SslCertVO¶
| Attribut | Beschreibung | Werte |
|---|---|---|
subdomains |
Ein Array aller im Zertifikat enthaltenen Subdomains. | |
intermediates |
Ein oder mehrere Objekte SslIntermediateVO. |
|
id |
Die ID des Zertifikats. | |
modified |
Das Datum der letzten Änderung im ISO-8601-Format. | string($date-time) |
SslIntermediateVO¶
| Attribut | Beschreibung | Werte |
|---|---|---|
cert |
Das Attribut cert enthält das Zertifikat. |
|
issuer |
Der Name des Zertifikatsausstellers. | |
id |
Die ID des Intermediate-Zertifikats. | |
modified |
Das Datum der letzten Änderung im ISO-8601-Format. | string($date-time) |
Die folgenden Attribute sind optional:
SslCertVO¶
| 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. | |
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. |
|
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. |
|
ipList |
Ein Array aller IPs. | |
sniAllowed |
Legt fest, ob die Server Name Indication zulässig ist. |
|
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. |
|
sslConfigurationName |
Der Konfigurationsname aus der Tabelle SSLConfiguration. | |
comment |
Ein individueller Kommentar für den Eintrag. | string |
SslIntermediateVO¶
| 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. | |
fingerprint |
Der Fingerprint des Intermediate-Zertifikats. | |
serialNumber |
Die Seriennummer des Intermediate-Zertifikats. | |
comment |
Ein individueller Kommentar für den Eintrag. | string |
Das System gibt die Objekte SslCertVO und SslIntermediateVO mit den geänderten Informationen zurück.
Beispiel¶
Beispiel-Request-Body:
{
"objectType": "string",
"subject": "string",
"algorithm": "string",
"validFrom": "string",
"validTo": "string",
"cert": "string",
"fingerprint": "string",
"serialNumber": "string",
"comment": "string",
"subjectAlternatives": [
"string"
],
"intermediates": [
{
"objectType": "string",
"subject": "string",
"algorithm": "string",
"validFrom": "string",
"validTo": "string",
"cert": "string",
"fingerprint": "string",
"serialNumber": "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. |