Device certificates
Device certificates API overview
The Device certificates API allows integrators to manage device certificates within SCM.
The API supports listing and updating certificates, performing lifecycle actions (enroll, renew, replace, revoke), managing deployment locations, and working with device certificate profiles and custom fields.
Device certificates API endpoints
The following tables group the device 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 device certificates | GET | /api/device/v1 | List device certificates with optional filters. |
| Get device certificate details | GET | /api/device/v1/{deviceCertId} | Retrieve details of a specific device certificate. |
| Update device certificate details | PUT | /api/device/v1/{certId} | Update device certificate details. |
2. Enrollment & import
| Action | Method | Path | Description |
|---|---|---|---|
| Request a device certificate | POST | /api/device/v1/enroll | Request a new device certificate using a CSR and profile details. |
| Import device certificates | POST | /api/device/v1/import | Import existing device certificates into SCM for management. |
3. Certificate lifecycle actions
| Action | Method | Path | Description |
|---|---|---|---|
| Approve a device certificate | POST | /api/device/v1/approve/{deviceCertId} | Approve a pending device certificate request. |
| Decline a device certificate | POST | /api/device/v1/decline/{deviceCertId} | Decline a pending device certificate request. |
| Revoke device certificate by ID | POST | /api/device/v1/revoke/order/{deviceCertId} | Revoke a device certificate using its certificate ID. |
| Revoke device certificate by serial number | POST | /api/device/v1/revoke/serial/{serialNumber} | Revoke a device certificate using its serial number. |
| Mark device certificate as revoked (ID or SN plus issuer) | POST | /api/device/v1/revoke/manual | Mark a device certificate as revoked in SCM using ID or serial number plus issuer. |
| Replace device certificate by ID | POST | /api/device/v1/replace/order/{deviceCertId} | Replace a device certificate with a CSR while keeping the same profile and validity. |
| Renew device certificate by ID | POST | /api/device/v1/renew/order/{deviceCertId} | Renew a device certificate using its ID. |
| Renew device certificate by serial number | POST | /api/device/v1/renew/serial/{serialNumber} | Renew a device certificate using its serial number. |
4. Certificate download
| Action | Method | Path | Description |
|---|---|---|---|
| Collect device certificate | GET | /api/device/v1/collect/{deviceCertId} | Download the issued device certificate. |
5. Certificate locations
| Action | Method | Path | Description |
|---|---|---|---|
| List locations | GET | /api/device/v1/{certId}/location | List deployment locations associated with a device certificate. |
| Get location details | GET | /v1/{certId}/location/{locationId} | Retrieve details of a specific certificate location. |
| Create a custom location | POST | /api/device/v1/{certId}/location | Add a custom deployment location for a device certificate. |
| Update a custom location | PUT | /api/device/v1/{certId}/location/{locationId} | Update a custom deployment location. |
| Delete a custom location | DELETE | /api/device/v1/{certId}/location/{locationId} | Remove a certificate's custom deployment location. |
6. Device certificate profiles & custom fields
| Action | Method | Path | Description |
|---|---|---|---|
| List device certificate profiles | GET | /api/device/v1/types | Retrieve available device certificate profiles. |
| List device certificate custom fields | GET | /api/device/v1/customFields | List custom fields associated with device certificates. |
Updated about 14 hours ago