SSL certificates
SSL certificates API overview
The SSL certificates API allows integrators to manage SSL certificates within SCM.
The API supports the following actions:
- Listing certificates
- Updating certificates
- Performing certificate lifecycle operations (enroll, renew, replace, revoke)
- Managing deployment locations for certificates
- Working with certificate profiles and custom fields
SSL certificates API endpoints
The following tables group the v2 SSL certificates API endpoints by functionality.
Click any action in the first column to open its API reference page.
1. Certificate listing & details
| Action | Method | Path | Description |
|---|---|---|---|
| List SSL certificates | GET | /api/ssl/v2 | List SSL certificates with optional filters. |
| Update SSL certificate details | PUT | /api/ssl/v2 | Update SSL certificate details. |
| Get SSL certificate details | GET | /api/ssl/v2/{sslId} | Retrieve details of a specific SSL certificate. |
2. Enrollment & import
| Action | Method | Path | Description |
|---|---|---|---|
| Request an SSL Certificate | POST | /api/ssl/v2/enroll | Request a new SSL certificate using a CSR and profile details. |
| Request an SSL certificate with key and CSR generation | POST | /api/ssl/v2/enroll-keygen | Request a certificate with server-side key and CSR generation. |
| Import SSL certificates | POST | /api/ssl/v2/import | Import existing SSL certificates into SCM for management. |
3. Certificate lifecycle actions
| Action | Method | Path | Description |
|---|---|---|---|
| Approve a certificate | POST | /api/ssl/v2/approve/{id} | Approve a pending SSL certificate request. |
| Decline a certificate | POST | /api/ssl/v2/decline/{id} | Decline a pending SSL certificate request. |
| Renew a certificate by ID | POST | /api/ssl/v2/renewById/{sslId} | Renew a certificate using its ID. |
| Renew a certificate by renew ID | POST | /api/ssl/v2/renew/{renewId} | Renew a certificate using the renewId. |
| Mark renewal as completed (manual) | POST | /api/ssl/v2/renew/manual/{id} | Mark a certificate as renewed in SCM based on an external renewal. |
| Replace a certificate | POST | /api/ssl/v2/replace/{sslId} | Replace a certificate with a new CSR while keeping the same profile and validity period. |
| Revoke a certificate by ID | POST | /api/ssl/v2/revoke/{id} | Revoke a certificate using its SCM certificate ID. |
| Revoke a certificate by serial number | POST | /api/ssl/v2/revoke/serial/{serialNumber} | Revoke a certificate using its serial number. |
| Mark a certificate as revoked by ID or serial number plus issuer | POST | /api/ssl/v2/revoke/manual | Mark a certificate as revoked in SCM by ID or serial number plus issuer. |
| Delete an SSL certificate | DELETE | /api/ssl/v2/{sslId} | Delete an SSL certificate by ID. |
4. Certificate download & key management
| Action | Method | Path | Description |
|---|---|---|---|
| Collect an SSL certificate | GET | /api/ssl/v2/collect/{sslId} | Download the issued certificate. |
| Download a private key from a private key agent | POST | /api/ssl/v2/keystore/{sslId}/{formatType} | Generate a link to download a private key from a private key agent. |
5. DCV information
NOTE: DCV information is available only when DCV pre-validation is disabled for the customer.
| Action | Method | Path | Description |
|---|---|---|---|
| Check DCV process information | GET | /api/ssl/v2/{sslId}/dcv | Retrieve Domain Control Validation (DCV) status for a certificate. |
| Recheck DCV process information | POST | /api/ssl/v2/{sslId}/dcv/recheck | Initiate a SSL certificate revalidation using sslId. |
6. Certificate locations
| Action | Method | Path | Description |
|---|---|---|---|
| List certificate locations | GET | /api/ssl/v2/{sslId}/location | List locations associated with a certificate. |
| Create a custom location | POST | /api/ssl/v2/{sslId}/location | Add a custom deployment location for a certificate. |
| Get a certificate location | GET | /api/ssl/v2/{sslId}/location/{locationId} | Retrieve details of a specific deployment location. |
| Update a certificate location | PUT | /api/ssl/v2/{sslId}/location/{locationId} | Update a custom deployment location. |
| Delete a certificate location | DELETE | /api/ssl/v2/{sslId}/location/{locationId} | Remove a certificate's deployment location. |
7. Certificate profiles & custom fields
| Action | Method | Path | Description |
|---|---|---|---|
| List SSL certificate profiles | GET | /api/ssl/v2/types | Retrieve available SSL certificate product profiles. |
| List SSL certificate custom fields | GET | /api/ssl/v2/customFields | List SSL certificate custom fields. |
Updated about 1 month ago