Skip to content

SSL certificates

SSL is the most order-sensitive part of the API. Calling these endpoints out of sequence is the commonest source of errors, so this section is laid out in the order you must call them.

generate-csr (optional — or bring your own CSR)
│
▼
initialize ─────────────► WaitingForInstall ← you are charged here
│ │ returns the certificateId
│ │ 15-day configuration window
▼ ▼
configure ──────────► ConfigurationStarted
│
├──► WaitingForValidation / ConfirmationSent ← prove domain control
│ │
▼ ▼
check-status (poll) ─────────► Active ← issued
│
├──► certificate-content download and install
├──► reissue new key or new approver
├──► revoke cancel
└──► renew new one-year certificate, charged; then configure it
Step Endpoint Charges?
0a POST /ssls/generate-csr — generate a CSR and key no
0b POST /ssls/check-csr — inspect a CSR you hold no
0c GET /ssls/approvers — valid approver e-mail addresses no
1 POST /ssls/initialize — buy the certificate yes
2 PUT /ssls/configure — submit CSR, contact, validation method no
3 PUT /ssls/check-status — poll until issued no
4 GET /ssls/certificate — full detail no
5 GET /ssls/certificate-content — download the certificate no
— POST /ssls/renew — renew a certificate yes
— GET /ssls — list your certificates and find a certificateId no

Every call after the purchase takes a certificateId

Section titled “Every call after the purchase takes a certificateId”

One domain can have more than one certificate: several purchases, a renewal next to the certificate it renews, old cancelled ones. So every endpoint that acts on a certificate you already bought identifies it by certificateId, and only by certificateId — none of them looks a certificate up by domain name:

configure, check-status, certificate, certificate-content, reissue, revoke, renew.

domainName is still what you send where no certificate exists yet: generate-csr, initialize, and approvers before a purchase.

Situation Result
certificateId missing HTTP 400 validation error. Sending domainName instead does not work; it is ignored.
certificateId unknown, or it belongs to another reseller Ssl:10026

Package metadata comes from GET /api/v1/products/ssls. Two things drive the choice.

Value Validation What the CA checks Typical wait
1 DV Domain control only 5–30 minutes
2 OV Organisation documents verified 1–3 business days
3 EV Extended legal verification 3–10 business days

Package shape decides which configure fields are mandatory:

Package covers sanList wildcardList
One domain forbidden forbidden
Multiple domains required forbidden
Wildcard forbidden required