API
Start typing to search…

List enrollments

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

A list of the names of each enrollment.

Query Params
string
required

Specify the contract on which to operate or view.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Response

Response body
object
enrollments
array of objects
required
length ≥ 0

The actual list of enrollments.

enrollments*
object
object | null

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

array of integers | null

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

assignedSlots
string | null

The specific date on which the renewal automatically starts for the enrollment.

string | null

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

default symantec1kroot

string
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

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.

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.

string | null

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

integer | null
≥ 0

Maximum number of SAN names supported for this enrollment type.

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.

object | null

Your organization information.

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.

array of objects | null

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

pendingChanges
object
string | null

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

string
required
length ≥ 1

Location to fetch related change information.

array of integers | null

Slots where the certificate is deployed on the production network.

productionSlots
string
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

string | null

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

array of integers | null

Slots where the certificate is deployed on the staging network.

stagingSlots
object | null

Contact information for an administrator at Akamai.

object | null

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

string
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

Updated 7 months ago

Did this page help you?
Language
Authentication
Remember to add your authentication credentials to run this code.
URL

Updated 7 months ago

Did this page help you?