Ein SSL/TLS-Zertifikat zu einer Domain hinzufügen¶

Note

Wenn die optionalen Attribute nicht gesetzt sind, setzt das System einen Standardwert ein.

Note

Der Body enthält die Attribute id, created und modified nicht. Die Werte dieser Attribute werden vom System nach dem Erstellen des Zertifikats gesetzt.

Note

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

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

Beschreibung¶

Mit der Add-SSL-Certificate-Anfrage fügen Sie einer Domain der Organisation ein oder mehrere SSL/TLS-Zertifikate hinzu.

Voraussetzungen¶

Werte der Anfrage: Domain-ID {domainId}

Objekte: SslCertVO, SslIntermediateVO

Anfrage¶

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

Für eine detaillierte Spezifikation, welche Informationen zum Hinzufügen 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
`cert`	Das Attribut `cert` enthält das Zertifikat.
`key`	Der verschlüsselte private Schlüssel.
`subdomains`	Ein Array aller im Zertifikat enthaltenen Subdomains.
`intermediates`	Ein oder mehrere Objekte `SslIntermediateVO`.

SslIntermediateVO¶

Attribut	Beschreibung	Werte
`cert`	Das Attribut `cert` enthält das Zertifikat.
`issuer`	Der Name des Zertifikatsausstellers.

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.
`fingerprint`	Der Fingerprint des Zertifikats.
`serialNumber`	Die Seriennummer des Zertifikats.
`subjectAlternatives`	Ein Array aller Subdomains, für die das Zertifikat gültig ist.
`certToRefresh`	Die ID des Zertifikats, um ein vorhandenes Zertifikat zu aktualisieren. Dieser Wert muss gesetzt werden, wenn Sie eine alte Version des Zertifikats durch eine neuere ersetzen möchten.
`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`
`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.
`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`

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`

Refresh a certificate

Um ein vorhandenes Zertifikat unter Beibehaltung der aktuellen IP-Adressen zu erneuern, verwenden Sie die Add-SSL-Certificate-Anfrage. Geben Sie als Wert für das Attribut certToRefresh nur die ID des Zertifikats an, das Sie erneuern möchten.

Das System gibt als Antwort die Objekte SslCertVO und SslIntermediateVO mit den Informationen zum neuen Eintrag 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
201	Die Anfrage war erfolgreich und ein neues Objekt wurde erstellt.
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.