Logo
Akamai APIs API Documentation

Enrollments

Number of APIs: 7


1. Create an enrollment

POST https://{{host}}/cps/v2/enrollments?contractId={{contractId}}

Creates an enrollment that contains all the information about the process that your certificate goes through from the time you request it, through renewal, and as you obtain subsequent versions.



2. List enrollments

GET https://{{host}}/cps/v2/enrollments?contractId={{contractId}}

A list of the names of each enrollment.



3. Get an enrollment

GET https://{{host}}/cps/v2/enrollments/:enrollmentId

Gets an enrollment.



4. Update an enrollment

PUT https://{{host}}/cps/v2/enrollments/:enrollmentId

Updates an enrollment with changes. Response type varies depending on the type and impact of change. For example, changing SANs list may return HTTP 202 Accepted since the operation requires a new certificate and network deployment operations, and thus can't be completed without a change. On the contrary, for example a Technical Contact name change may return HTTP 200 OK assuming there are no active change and when the operation does not require a new certificate.

Note that fipsMode requires that TLS 1.2, TLS 1.3, or both are enabled on the certificate. You can’t list these TLS versions as disabled in the disallowedTlsVersions deployment object. When fipsMode is enabled, you need to use an active (non-deprecated) cipher profile for both mustHaveCiphers and preferredCiphers. For details, see Update SSL/TLS cipher profiles.



5. Remove an enrollment

DELETE https://{{host}}/cps/v2/enrollments/:enrollmentId

Removes an enrollment from CPS. The response code varies depending on the state of the enrollment. Deleting an enrollment in the future, or deleting when the enrollment has a certificate deployed to the network, may result in a 202 response. Deleting an enrollment that hasn't yet deployed any certificate to the network responds immediately with a 200 code.



6. Get DV history

GET https://{{host}}/cps/v2/enrollments/:enrollmentId/dv-history

Domain name Validation history for the enrollment.



7. Get certificate history

GET https://{{host}}/cps/v2/enrollments/:enrollmentId/history/certificates

View the certificate history.



ENDPOINTS