To allow new features to roll out flexibly, the CPS API supports a system of versioned objects that uses Content-Type
and Accept
headers. For a client to successfully get a resource via HTTP request, the version header (or version header pair if both Content-Type
and Accept
are required) in the request needs to match exactly any of the versioned resources. Otherwise the API call fails to map to an allowed resource.
The format of a typical CPS versioning header is:
application/vnd.akamai.cps.${ENTITY_NAME}.${VERSION}+${MEDIA_TYPE}
For example:
application/vnd.akamai.cps.enrollment.v4+json
Starting with application/vnd.akamai.cps.enrollment.v10+json
version, the CPS API supports Dual Stacking Third-Party certificates. To take advantage of this Beta, create an enrollment using the application/vnd.akamai.cps.enrollment.v10+json
object where you can specify a CSR signature algorithm. In Beta, you can also add a second certificate to your enrollment once the initial certificate has been deployed. You can add this additional certificate by providing the allow-missing-certificate-addition
query parameter when updating a standard Enrollment using the v9 object.
The Beta supports these features:
Version | Details |
---|---|
Update a change | |
vnd.akamai.cps.certificate-and-trust-chain.v2+json | This version includes both certificate types (RSA and ECDSA) and chains information. |
Certificate history | |
vnd.akamai.cps.certificate-history.v2+json | This version includes both certificate types (RSA and ECDSA) information. |
Get a change | |
vnd.akamai.cps.csr.v2+json | This version includes a list of CSRs. |
Get production deployment, Get staging deployment | |
vnd.akamai.cps.deployment.v7+json | This version includes both certificate types (RSA and ECDSA) and chains information. |
List deployments | |
vnd.akamai.cps.deployments.v7+json | This version includes both certificate types (RSA and ECDSA) and chains information. |
Create an enrollment | |
vnd.akamai.cps.enrollment.v10+json | This version provides detailed information about an enrollment. |
List enrollments | |
vnd.akamai.cps.enrollments.v10+json | This version provides a list of enrollments. |