Neue SSL-Anfrage erstellen¶
Note
Jeder Eintrag von subjectAlternativeNames muss sich einer der Plattform bekannten Domain zuordnen lassen, andernfalls wird die Anfrage mit einer 400-Antwort abgelehnt. renewalInterval und signatureAlgorithm werden nur für die Anbieter SECTIGO und DTRUST akzeptiert, und die Algorithmen RSA4096 und RSA8192 erfordern ebenfalls einen dieser beiden Anbieter.
Senden einer POST-Anfrage an den Endpunkt /ssl/requests.
Beschreibung¶
Mit der CreateSslRequest-Anfrage fordern Sie ein neues verwaltetes SSL/TLS-Zertifikat für eine oder mehrere Domains der Organisation an. Das Zertifikat wird nach dem Erstellen der Anfrage asynchron vom konfigurierten Anbieter ausgestellt.
Voraussetzungen¶
Werte der Anfrage: keine Objekte: SslCertRequestVO
Anfrage¶
Um eine SSL-Anfrage zu erstellen, fügen Sie das Objekt SslCertRequestVO dem Body der Anfrage hinzu. Die folgenden Attribute sind erforderlich:
| Attribut | Beschreibung | Werte |
|---|---|---|
algorithm |
Der für das Zertifikat verwendete Schlüsselalgorithmus. |
|
provider |
Der SSL/TLS-Anbieter, der das Zertifikat ausstellt. |
|
subjectAlternativeNames |
Ein Array von SslCertRequestSanVO-Objekten, jeweils mit dem Attribut name (string), dem vollqualifizierten Domainnamen, der vom Zertifikat abgedeckt werden soll. Mindestens ein Eintrag ist erforderlich, maximal 100 Einträge sind zulässig. |
array |
Die folgenden Attribute sind optional:
| Attribut | Beschreibung | Werte |
|---|---|---|
assignments |
Ein Array von SslCertRequestAssignmentVO-Objekten, jeweils mit dem Attribut subDomainName (string), der Subdomain, der die Anfrage das resultierende Zertifikat zuweist. |
array |
sslProviderCredentialsId |
Die ID des SslProviderCredentials-Objekts, das zum Ausstellen des Zertifikats verwendet werden soll. |
integer |
renewalInterval |
Die Anzahl der Tage vor Ablauf des Zertifikats, zu der das Zertifikat erneuert wird. Nur verfügbar für die Anbieter SECTIGO und DTRUST. |
integer |
signatureAlgorithm |
Der für das Zertifikat verwendete Signaturalgorithmus. Nur verfügbar für die Anbieter SECTIGO und DTRUST. |
|
Die folgenden Attribute werden vom System gesetzt und können nicht von Ihnen angegeben werden: id, status, multiDomain, created, modified.
Beispiel¶
Beispiel-Request-Body:
{
"algorithm": "RSA2048",
"provider": "LETS_ENCRYPT",
"subjectAlternativeNames": [
{
"name": "www.example.com"
}
],
"assignments": [
{
"subDomainName": "www.example.com"
}
],
"sslProviderCredentialsId": 1,
"renewalInterval": 30,
"signatureAlgorithm": "SHA256"
}
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. |