Akamai APIs API Documentation
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.
Body
PARAM
| Key | Datatype | Required | Description |
allow-cancel-pending-changes
|
string | (Optional) Cancels all pending changes when updating an enrollment. | |
allow-staging-bypass
|
string | (Optional) Bypass staging and push metadata updates directly to the production network. The current change also updates with the same changes. | |
deploy-not-after
|
string | (Optional) Don't deploy after this date (UTC). | |
deploy-not-before
|
string | (Optional) Don't deploy before this date (UTC). | |
force-renewal
|
string | (Optional) Force certificate renewal for Enrollment. | |
renewal-date-check-override
|
string | (Optional) CPS automatically starts a change to renew certificates in time before they expire. This automatic change starts when the certificate's expiration is within a renewal window. CPS prevents other changes from starting during this renewal window. Setting `renewal-date-check-override=true` allows changes during the renewal window, potentially running the risk of an expired certificate on the network. | |
allow-missing-certificate-addition
|
string | (Optional) Applicable for Third Party Dual Stack Enrollments, allows to update missing certificate. Option supported from v10. | |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status OK
| {
"changes": [
"/cps/v2/enrollments/10002/changes/10002"
],
"enrollment": "/cps/v2/enrollments/10002"
} |
Curl
curl -X PUT 'https://undefined/cps/v2/enrollments/:enrollmentId?allow-cancel-pending-changes=&allow-staging-bypass=&deploy-not-after=&deploy-not-before=&force-renewal=&renewal-date-check-override=&allow-missing-certificate-addition=&accountSwitchKey=' -H 'Content-Type: application/vnd.akamai.cps.enrollment.v12+json' -H 'Accept: application/vnd.akamai.cps.enrollment-status.v1+json' -d '{"adminContact":{"addressLineOne":"150 Broadway","addressLineTwo":null,"city":"Cambridge","country":"US","email":"afero@akamai.com","firstName":"R1","lastName":"D1","organizationName":"Akamai","phone":"617-555-0111","postalCode":"02142","region":"MA","title":"Adminstrator"},"assignedSlots":[1234],"autoRenewalStartTime":null,"certificateChainType":"default","certificateType":"third-party","changeManagement":true,"csr":{"c":"US","cn":"www.example.com","l":"Cambridge","o":"Akamai","ou":"WebEx","preferredTrustChain":"dst-root-ca-x3","sans":["san1.example.com","san2.example.com","san3.example.com","www.example.com"],"st":"MA"},"enableMultiStackedCertificates":false,"id":"10001","location":"/cps-api/enrollments/10001","maxAllowedSanNames":100,"maxAllowedWildcardSanNames":100,"networkConfiguration":{"clientMutualAuthentication":{"authenticationOptions":{"ocsp":{"enabled":false},"sendCaListToClient":false},"setId":"Custom_CPS-6134b_B-3-1AHBENT.xml"},"disallowedTlsVersions":["TLSv1","TLSv1_1"],"dnsNameSettings":{"cloneDnsNames":false,"dnsNames":["san2.example.com","san1.example.com"]},"fipsMode":true,"geography":"core","mustHaveCiphers":"ak-akamai-2020q1","ocspStapling":"on","preferredCiphers":"ak-akamai-2020q1","quicEnabled":false,"secureNetwork":"enhanced-tls","sniOnly":true},"org":{"addressLineOne":"150 Broadway","addressLineTwo":null,"city":"Cambridge","country":"US","name":"Akamai Technologies","phone":"617-555-0111","postalCode":"02142","region":"MA"},"orgId":645263546,"pendingChanges":[{"changeType":"new-certificate","location":"/cps-api/enrollments/10001/changes/10002"}],"productionSlots":[1234],"ra":"third-party","signatureAlgorithm":null,"stagingSlots":[1234],"techContact":{"addressLineOne":"150 Broadway","addressLineTwo":null,"city":"Cambridge","country":"US","email":"jsmith@akamai.com","firstName":"R2","lastName":"D2","organizationName":"Akamai","phone":"617-555-0111","postalCode":"02142","region":"MA","title":"Technical Engineer"},"thirdParty":{"excludeSans":false},"validationType":"third-party"}'
ENDPOINTS