A Change may allow for, or require updates to be made under certain conditions. The type of updates allowed is internal to the system, and is determined by the state of the change as well as the specific enrollment type. Clients have to inspect the allowedInput[].type returned by Get change status operation to determine actions and headers supported, then use the Accept and Content-Type headers for the respective allowedInput value to inspect or perform updates to the Change. The following table presents an overview of the different types and corresponding headers. The table helps you identify which headers you can use when performing the Get a change and Update a change operations.
| allowedInput[].type | API type | Description | Content-Type header | Accept header |
|---|---|---|---|---|
| Change-Management | ||||
change-management-info | info / GET | Change Management information provides acknowledgement status, and may include warnings about potential conflicts that may occur if you proceed with acknowledgement. | N/A | application/vnd.akamai.cps.change-management-info.v4+json |
change-management-info | info / GET | The Deployment currently deployed to the staging network. Acknowledging change-management continues deploying this configuration to the production network. | N/A | application/vnd.akamai.cps.deployment.v8+json |
change-management-ack | update / POST | Acknowledge Change Management is required to proceed deploying the certificate to the production network. | application/vnd.akamai.cps.acknowledgement-with-hash.v1+json | application/vnd.akamai.cps.change-id.v1+json |
| Let's Encrypt | ||||
lets-encrypt-challenges | info/ GET | Get Let's Encrypt DvChallenges for a given change. | N/A | application/vnd.akamai.cps.dv-challenges.v2+json |
lets-encrypt-challenges-completed | update / POST | Submit an acknowledgement after you place the HTTP or DNS tokens to inform CPS that Let's Encrypt challenges have been made available and are ready for validation. You can also wait for CPS to check for the tokens, which it does on a regular schedule. | application/vnd.akamai.cps.acknowledgement.v1+json | application/vnd.akamai.cps.change-id.v1+json |
| Post-Verification | ||||
post-verification-warnings | info / GET | Post-verification Warnings generated for a given change. Produced after CPS retrieves a certificate from a CA or when a client uploads a certificate. You must acknowledge post-verification warnings for the change to continue processing. | N/A | application/vnd.akamai.cps.warnings.v1+json |
post-verification-warnings-ack | update / POST | You must acknowledge post-verification warnings by submitting an acknowledgement. | application/vnd.akamai.cps.acknowledgement.v1+json | application/vnd.akamai.cps.change-id.v1+json |
| Pre-Verification | ||||
pre-verification-warnings | info / GET | Pre-verification Warnings can generate for a given change. CPS produces these after it retrieves a certificate from a CA or after a client uploads the certificate. Post-verification Warnings must be acknowledged for the change to continue processing. | N/A | application/vnd.akamai.cps.warnings.v1+json |
pre-verification-warnings-ack | update / POST | You must acknowledge pre-Verification warnings by submitting an acknowledgement. | application/vnd.akamai.cps.acknowledgement.v1+json | application/vnd.akamai.cps.change-id.v1+json |
| Third-Party | ||||
third-party-csr | info / GET | Get Certificate Signing Request (CSR) for a Third-Party certificate. | N/A | application/vnd.akamai.cps.csr.v1+json |
third-party-cert-and-trust-chain | update / POST | Upload Third Party Certificate and Trust Chain. | application/vnd.akamai.cps.certificate-and-trust-chain.v1+json | application/vnd.akamai.cps.change-id.v1+json |