Certificate Provisioning System API v2

Number of APIs: 18

Use the Certificate Provisioning System (CPS) API to manage the full lifecycle of SSL/TLS certificates for your Akamai Secure Delivery Network applications. CPS ensures secure delivery of content to and from your website. CPS generates and stores a private key for each certificate, which then authenticates the browser's secure connection when delivering content.

With this API, you can: - Request new certificates. - Modify existing certificates. - Renew certificates automatically. - Delete certificates.

Authentication

Create an authentication credential that contains the client token and client secret required to authenticate Akamai API requests.

Note: Only Akamai customers can create credentials. If you aren't an Akamai customer and wish to become one, you can sign up for our services.

  1. Navigate to the Identity and Access Management section of Akamai Control Center and click Create API Client.

Note: If you don't have access to the Identity and Access Management tool, contact your local Akamai Control Center admin or your Akamai account team for assistance.

  1. Click Quick and then Download in the Credentials section.

Note: If you need to refine access levels or permissions, see Create a client with custom permissions.

  1. Open the downloaded file with a text editor and add [default] as a header above all text.
  [default]
  client_secret = C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=
  host = akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net
  access_token = akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij
  client_token = akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj
  1. Fork the [Akamai Authentication] environment, populate the variables, and [set it for your workspace]

Dependencies

To use this API, make sure you have your contract and group IDs configured. To get them, run the List contracts or List groups operation via the Property Manager API.

Integration methods

You can use this API collection in these integration methods: - API - Powershell - CLI - Terraform

  1. Changes - Get a deployment schedule GET https://{{host}}/cps/v2/enrollments/:enrollmentId/changes/:changeId/deployment-schedule

  2. Enrollments - List enrollments GET https://{{host}}/cps/v2/enrollments?contractId={{contractId}}

  3. Changes - Get a change GET https://{{host}}/cps/v2/enrollments/:enrollmentId/changes/:changeId/input/info/:allowedInputTypeParam

  4. Enrollments - Create an enrollment POST https://{{host}}/cps/v2/enrollments?contractId={{contractId}}

  5. Enrollments - Get an enrollment GET https://{{host}}/cps/v2/enrollments/:enrollmentId

  6. Enrollments - Update an enrollment PUT https://{{host}}/cps/v2/enrollments/:enrollmentId

  7. Enrollments - Remove an enrollment DELETE https://{{host}}/cps/v2/enrollments/:enrollmentId

  8. Enrollments - Get DV history GET https://{{host}}/cps/v2/enrollments/:enrollmentId/dv-history

  9. Enrollments - Get certificate history GET https://{{host}}/cps/v2/enrollments/:enrollmentId/history/certificates

  10. Deployments - Update a deployment schedule PUT https://{{host}}/cps/v2/enrollments/:enrollmentId/changes/:changeId/deployment-schedule