List enrollments

get

https://{hostname}/cps/v2/enrollments

A list of the names of each enrollment.

Response

Response body

object

Provides a list of enrollments.

enrollments

array of objects

required

length ≥ 0

The actual list of enrollments.

enrollments*

object

An enrollment displays all the information about the process that your certificate goes through from the time you request it, through renewal, and as you obtain subsequent versions. CPS is a certificate life cycle management tool. Once you obtain a certificate, you use it until it expires, in most cases a year from the date the CA issued the certificate. CPS automatically starts the renewal process 90 days before the old certificate expires. It then automatically deploys the renewed certificate when it receives it from the CA.

adminContact

object | null

Contact information for the certificate administrator that you want to use as a contact at your company.

assignedSlots

array of integers | null

Slots where the certificate is either deployed or is already deployed.

autoRenewalStartTime

string | null

The specific date on which an automatic renewal starts for the enrollment. If a renewal is scheduled but has not started yet, the field specifies that date. If a renewal is already queued or running, the field is null.

certificateChainType

string | null

enum

The kind of certificate trust chain. This is either default or symantec1kroot.

default symantec1kroot

certificateType

string

enum

required

Specifies the kind of certificate in the enrollment. Either san, single, wildcard, wildcard-san, or third-party. For details, see validationType in the Enrollment object's versioned schema members.

san single wildcard wildcard-san third-party

changeManagement

boolean

required

Setting this to true for an enrollment stops CPS from deploying the certificate to the network until you acknowledge you're ready to deploy the certificate. You can test the certificate outside of CPS, on the Edge Staging Network (ESN), to make sure it works in your environment, and then deploy the certificate. The ESN is a small network of Akamai edge servers built to simulate Akamai's production network to test most of your site or application functionality with current production version configuration options and functions. For more information on the ESN, see the Edge Staging Network User Guide. You can also contact your account representative with questions or issues with your service on the ESN.

csr

object

required

When you create an enrollment, you also generate a certificate signing request (CSR) using CPS. CPS signs the CSR with the private key. The CSR contains all the information the CA needs to issue your certificate.

enableMultiStackedCertificates

boolean

required

Enable Dual-Stacked certificate deployment for this enrollment. The next renewal includes the change. Note that this value is only returned for third-party certificates. Otherwise it's omitted from the response.

string | null

The unique identifier of the enrollment.

location

string | null

The URI path to the enrollment. The last segment of the URI path serves as a unique identifier for the enrollment.

maxAllowedSanNames

integer | null

≥ 0

Maximum number of SAN names supported for this enrollment type.

maxAllowedWildcardSanNames

integer | null

≥ 0

Maximum number of Wildcard SAN names supported for this enrollment type.

networkConfiguration

object

required

Settings that specify any network information and TLS Metadata you want CPS to use to push the completed certificate to the network.

org

object | null

Your organization information.

orgId

integer | null

≥ 0

The Digicert unique identifier for the organization. If you use this value in a PUT or POST request, you can set the org, techContact, and adminContact values to null.

pendingChanges

array of objects | null

Returns the Changes currently pending in CPS. The last item in the array is the most recent change.

pendingChanges

object

changeType

string | null

enum

Indicates the certificate's pending change action. This is either new-certificate, modify-certificate, modify-san, or renewal.

new-certificate modify-certificate modify-san renewal

location

string

required

length ≥ 1

Location to fetch related change information.

productionSlots

array of integers | null

Slots where the certificate is deployed on the production network.

string

enum

required

The registration authority or certificate authority (CA) you want to use to obtain a certificate. A CA is a trusted entity that signs certificates and can vouch for the identity of a website. This is either symantec, lets-encrypt, or third-party.

symantec lets-encrypt third-party

signatureAlgorithm

string | null

enum

Identifies the SHA (Secure Hash Algorithm) function. The NSA (National Security Agency) designed this function to produce a hash of certificate contents, for use in a digital signature. This is either SHA-1 for a 160-bit (20-byte) hash or SHA-256 for a 256-bit (32-byte) hash. To ensure a secure hash function, use SHA-256.

SHA-1 SHA-256

stagingSlots

array of integers | null

Slots where the certificate is deployed on the staging network.

techContact

object | null

Contact information for an administrator at Akamai.

thirdParty

object | null

Specifies that you want to use a third party certificate. This is any certificate that is not issued through CPS.

validationType

string

enum

required

CPS supports several types of validation: dv, ev, ov, or third-party. Domain Validation (dv) offers the lowest level of validation. The CA validates that you have control of the domain. CPS supports DV certificates issued by Let's Encrypt, a free, automated, and open CA, run for public benefit. Organization Validation (ov) offers the next level of validation. The CA validates that you have control of the domain. Extended Validation (ev) offers the highest level of validation, in which you need to have signed letters and notaries sent to the CA before signing. You can also specify third-party if you want to use a signed certificate you obtain from a CA that CPS doesn't directly support.

dv ev ov third-party

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/cps/v2/enrollments \
3
     --header 'accept: application/vnd.akamai.cps.enrollments.v11+json'


xxxxxxxxxx
119
}
1
{
2
  "enrollments": [
3
    {
4
      "adminContact": {
5
        "addressLineOne": "150 Broadway",
6
        "addressLineTwo": null,
7
        "city": "Cambridge",
8
        "country": "US",
9
        "email": "hgildong@akamai.com",
10
        "firstName": "R1",
11
        "lastName": "D1",
12
        "organizationName": "Akamai",
13
        "phone": "617-555-0111",
14
        "postalCode": "02142",
15
        "region": "MA",
16
        "title": "Administrator"
17
      },
18
      "assignedSlots": [
19
        1234
20
      ],
21
      "autoRenewalStartTime": null,
22
      "certificateChainType": "default",
23
      "certificateType": "third-party",
24
      "changeManagement": true,
25
      "csr": {
26
        "c": "US",
27
        "cn": "www.example.com",
28
        "l": "Cambridge",
29
        "o": "Akamai",
30
        "ou": "WebEx",
31
        "preferredTrustChain": null,
32
        "sans": [
33
          "san1.example.com",
34
          "san2.example.com",
35
          "san3.example.com",
36
          "www.example.com"
37
        ],
38
        "st": "MA"
39
      },
40
      "enableMultiStackedCertificates": false,
41
      "id": "10001",
42
      "location": "/cps-api/enrollments/10001",
43
      "maxAllowedSanNames": 100,
44
      "maxAllowedWildcardSanNames": 100,
45
      "networkConfiguration": {
46
        "clientMutualAuthentication": {
47
          "authenticationOptions": {
48
            "ocsp": {
49
              "enabled": false

200The response reflects the enrollments.