TLS-Zertifikat bestellen oder verlängern
POST /tls/certificateLegt eine neue TLS-Zertifikatsbestellung an oder verlängert ein bestehendes Zertifikat. Ist renewal_of_certificate_id gesetzt, beschreibt validity_days weiterhin die gekaufte Grundlaufzeit. Akzeptiert der Provider die Verlängerung, kann die Restlaufzeit des bisherigen Zertifikats nach der Ausstellung hinzukommen. Produkte vom Typ OV und EV können action_required=true zusammen mit einer completion_url zurückgeben, wenn vor dem Einreichen weitere Organisations- oder Validierungsangaben nötig sind.
Request Body
Abschnitt betitelt „Request Body“| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
sku |
tlsCertificateProduct | ja | Bezeichner des regfish-TLS-Zertifikatsprodukts. (RapidSSL, RapidSSLWildcard, QuickSSLPremium, SSL123, TrueBusinessID, SecureSite, SSLWebServer) |
common_name |
fqdn_relaxed | ja | Fully Qualified Domain Name. |
dns_names |
fqdn_relaxed[] | nein | — |
csr |
csr | ja | PEM-kodierter Certificate Signing Request (CSR). |
dcv_method |
tlsCertificateDcvMethod | ja | (dns-cname-token, email) |
dcv_emails |
string[] |
nein | — |
org_id |
tlsOrganizationId | nein | Öffentliche TLS-Organisations-ID |
renewal_of_certificate_id |
tlsCertificateId | nein | Öffentliche TLS-Zertifikats-ID |
validity_days |
integer |
nein | Gekaufte Grundlaufzeit der Bestellung in Tagen. Bei Verlängerungen wird dieser Wert nicht um eine erwartete Gutschrift aus der Restlaufzeit des bisherigen Zertifikats gekürzt. Schreibt der Provider die Restlaufzeit gut, kann das ausgestellte Zertifikat effektiv länger gültig sein als hier angegeben. |
Antworten
Abschnitt betitelt „Antworten“| Status | Typ | Beschreibung |
|---|---|---|
200 |
tlsCertificateResponse |
TLS-Zertifikatsbestellung angelegt |
400 |
Error |
Ungültige Anfragedaten, ungültiges TLS-Produkt oder ungültiger CSR |
401 |
Error |
Nicht autorisiert |
404 |
Error |
Quellzertifikat der Verlängerung nicht gefunden |
409 |
Error |
Die TLS-Zertifikatsbestellung kann in ihrem aktuellen Zustand nicht eingereicht werden, etwa weil die Verlängerung ungültig ist oder eine nutzbare CA-Organisation fehlt |
500 |
Error |
Unerwarteter Fehler |
502 |
Error |
Fehler beim vorgelagerten TLS-Provider |
Antwortkörper
Abschnitt betitelt „Antwortkörper“| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
success |
boolean |
ja | Erfolgskennzeichen |
code |
integer |
nein | Antwort-/Fehlercode |
response |
tlsCertificateResponse | nein | — |
Beispiel
Abschnitt betitelt „Beispiel“curl -X POST "https://api.regfish.com/tls/certificate" \ -H "x-api-key: $REGFISH_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "sku": "RapidSSL", "common_name": "www.example.com", "dns_names": [ "www.example.com" ], "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC...\n-----END CERTIFICATE REQUEST-----", "dcv_method": "dns-cname-token", "dcv_emails": [ "string" ], "org_id": "hdl_7K9QW3M2ZT8HJ", "renewal_of_certificate_id": "7K9QW3M2ZT8HJ", "validity_days": 199 }'Anfrage zusammenstellen
Abschnitt betitelt „Anfrage zusammenstellen“Werte eintragen — der Aufruf unten passt sich an. Es wird nichts abgeschickt: die API gibt Browser-Anfragen von dieser Domain aus derzeit nicht frei (CORS). Der API-Key wird nicht gespeichert.