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.

Request Params

KeyDatatypeRequiredDescription
allow-cancel-pending-changesstring(Optional) Cancels all pending changes when updating an enrollment.
deploy-not-afterstring(Optional) Don't deploy after this date (UTC).
deploy-not-beforestring(Optional) Don't deploy before this date (UTC).
accountSwitchKeystring(Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"changes":["/cps/v2/enrollments/10002/changes/10002"],"enrollment":"/cps/v2/enrollments/10002"}