Akamai: Certificate Provisioning System API
Get full life cycle management of SSL certificates for your Akamai CDN applications.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Get full life cycle management of SSL certificates for your
Akamai CDN applications.
Endpoints 18
Enrollments
- GETList enrollments
/enrollments?contractId={{contractId}}&accountSwitchKey={{accountSwitchKey}}A list of the names of each enrollment. - POSTCreate an enrollment
/enrollments?contractId={{contractId}}&deploy-not-after={{deploy-not-after}}&deploy-not-before={{deploy-not-before}}&accountSwitchKey={{accountSwitchKey}}Creates an enrollment that contains all the information about the process that your certificate goes through from the time you request it, through renewal,… - GETGet an enrollment
/enrollments/:enrollmentId?accountSwitchKey={{accountSwitchKey}}Gets an enrollment. - PUTUpdate an enrollment
/enrollments/:enrollmentId?allow-cancel-pending-changes={{allow-cancel-pending-changes}}&allow-staging-bypass={{allow-staging-bypass}}&deploy-not-after={{deploy-not-after}}&deploy-not-before={{deploy-not-before}}&force-renewal={{force-renewal}}&renewal-date-check-override={{renewal-date-check-override}}&allow-missing-certificate-addition={{allow-missing-certificate-addition}}&accountSwitchKey={{accountSwitchKey}}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… - DELETERemove an enrollment
/enrollments/:enrollmentId?allow-cancel-pending-changes={{allow-cancel-pending-changes}}&deploy-not-after={{deploy-not-after}}&deploy-not-before={{deploy-not-before}}&accountSwitchKey={{accountSwitchKey}}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… - GETGet DV history
/enrollments/:enrollmentId/dv-history?accountSwitchKey={{accountSwitchKey}}Domain name Validation history for the enrollment. - GETGet certificate history
/enrollments/:enrollmentId/history/certificates?includeAll={{includeAll}}&accountSwitchKey={{accountSwitchKey}}View the certificate history. To view deployed certificates and their expiration dates, run the Get production deployment operation. Note that for enrollments…
Deployments
- PUTUpdate a deployment schedule
/enrollments/:enrollmentId/changes/:changeId/deployment-schedule?accountSwitchKey={{accountSwitchKey}}Updates the current deployment schedule. - GETList deployments
/enrollments/:enrollmentId/deployments?accountSwitchKey={{accountSwitchKey}}Lists the deployments for an enrollment. - GETGet production deployment
/enrollments/:enrollmentId/deployments/production?accountSwitchKey={{accountSwitchKey}}Gets the enrollments deployed on the production network. - GETGet staging deployment
/enrollments/:enrollmentId/deployments/staging?accountSwitchKey={{accountSwitchKey}}Gets the enrollments deployed on the staging network.
Changes
- GETGet change status
/enrollments/:enrollmentId/changes/:changeId?accountSwitchKey={{accountSwitchKey}}Gets the status of a pending change. - DELETECancel a change
/enrollments/:enrollmentId/changes/:changeId?accountSwitchKey={{accountSwitchKey}}Cancels a pending change. This cancels the entire change. You can cancel any pending change you previously made to a certificate. - GETGet a deployment schedule
/enrollments/:enrollmentId/changes/:changeId/deployment-schedule?accountSwitchKey={{accountSwitchKey}}Gets the current deployment schedule settings describing when a change deploys to the network. - GETGet a change
/enrollments/:enrollmentId/changes/:changeId/input/info/:allowedInputTypeParam?accountSwitchKey={{accountSwitchKey}}Get detailed information of a pending change. Below is a sample where allowedInput[].type has the value third-party-csr. The acceptable Accept header depends… - POSTUpdate a change
/enrollments/:enrollmentId/changes/:changeId/input/update/:allowedInputTypeParam?accountSwitchKey={{accountSwitchKey}}Updates a pending change. Below is a sample where allowedInput[].type has the value third-party-cert-and-trust-chain. The acceptable Content-Type and Accept… - GETGet change history
/enrollments/:enrollmentId/history/changes?includeAll={{includeAll}}&accountSwitchKey={{accountSwitchKey}}Change history of an enrollment.
Certificates
- GETList active certificates
/active-certificates?contractId={{contractId}}&accountSwitchKey={{accountSwitchKey}}Lists enrollments with active certificates. Note that the rate limit for this operation is 10 requests per minute per account. For details, see Rate limiting.
API details
- Base URL
https://{hostname}/cps/v2- Authentication
- None declared in the description
- Operations
- 18 operations on 13 pathsGET 12PUT 2POST 2DELETE 2
- Main resources
- Enrollments 7Changes 6Deployments 4Certificates 1
- Response formats
application/vnd.akamai.cps.enrollment-status.v1+jsonapplication/vnd.akamai.cps.change-id.v1+jsonapplication/vnd.akamai.cps.active-certificates.v2+jsonapplication/vnd.akamai.cps.change-management-info.v1+json- Description format
- OpenAPI 3.0.0, API version
v2 - Links
- Documentation · OpenAPI document
- Listed from
- Akamai's published OpenAPI description (akamai/akamai-apis) (Apache-2.0)
How to test the Akamai: Certificate Provisioning System API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Certificate Provisioning System API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List enrollments” (GET /enrollments?contractId={{contractId}}&accountSwitchKey={{accountSwitchKey}}), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Akamai: Certificate Provisioning System API?
Get full life cycle management of SSL certificates for your Akamai CDN applications. It is listed under Developer tools and has 18 endpoints.
Who publishes the Akamai: Certificate Provisioning System API?
It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Akamai: Certificate Provisioning System API?
Requests go to https://{hostname}/cps/v2. Endpoint paths are added to this base URL.
How do I authenticate with the Akamai: Certificate Provisioning System API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Akamai: Certificate Provisioning System API have?
18 operations on 13 paths (12 GET, 2 PUT, 2 POST, 2 DELETE). The largest groups are Enrollments, Changes, Deployments, Certificates.
Is forking the Akamai: Certificate Provisioning System API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.