Logo
Akamai APIs API Documentation

List enrollments

GET https://{{host}}/cps/v2/enrollments?contractId={{contractId}}

A list of the names of each enrollment.

 

Body PARAM

Key Datatype Required Description 
contractId
string (Required) Specify the contract on which to operate or view.
accountSwitchKey
string (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "enrollments": [ { "adminContact": { "addressLineOne": "150 Broadway", "addressLineTwo": null, "city": "Cambridge", "country": "US", "email": "hgildong@akamai.com", "firstName": "R1", "lastName": "D1", "organizationName": "Akamai", "phone": "617-555-0111", "postalCode": "02142", "region": "MA", "title": "Adminstrator" }, "assignedSlots": [ 1234 ], "autoRenewalStartTime": null, "certificateChainType": "default", "certificateType": "third-party", "changeManagement": true, "csr": { "c": "US", "cn": "www.example.com", "l": "Cambridge", "o": "Akamai", "ou": "WebEx", "preferredTrustChain": "dst-root-ca-x3", "sans": [ "san1.example.com", "san2.example.com", "san3.example.com", "www.example.com" ], "st": "MA" }, "enableMultiStackedCertificates": false, "id": "10001", "location": "/cps-api/enrollments/10001", "maxAllowedSanNames": 100, "maxAllowedWildcardSanNames": 100, "networkConfiguration": { "clientMutualAuthentication": { "authenticationOptions": { "ocsp": { "enabled": false }, "sendCaListToClient": false }, "setId": "Custom_CPS-6134b_B-3-1AHBENT.xml" }, "disallowedTlsVersions": [ "TLSv1", "TLSv1_1" ], "dnsNameSettings": { "cloneDnsNames": false, "dnsNames": [ "san2.example.com", "san1.example.com" ] }, "geography": "core", "mustHaveCiphers": "ak-akamai-2020q1", "ocspStapling": "on", "preferredCiphers": "ak-akamai-2020q1", "quicEnabled": false, "secureNetwork": "enhanced-tls", "sniOnly": true }, "org": { "addressLineOne": "150 Broadway", "addressLineTwo": null, "city": "Cambridge", "country": "US", "name": "Akamai Technologies", "phone": "617-555-0111", "postalCode": "02142", "region": "MA" }, "orgId": 645263546, "pendingChanges": [ { "changeType": "new-certificate", "location": "/cps-api/enrollments/10001/changes/10002" } ], "productionSlots": [ 1234 ], "ra": "third-party", "signatureAlgorithm": null, "stagingSlots": [ 1234 ], "techContact": { "addressLineOne": "150 Broadway", "addressLineTwo": null, "city": "Cambridge", "country": "US", "email": "jperez@akamai.com", "firstName": "R2", "lastName": "D2", "organizationName": "Akamai", "phone": "617-555-0111", "postalCode": "02142", "region": "MA", "title": "Technical Engineer" }, "thirdParty": { "excludeSans": false }, "validationType": "third-party" } ] }



Curl
curl -X GET 'https://undefined/cps/v2/enrollments?contractId=?contractId=&accountSwitchKey=' -H 'Accept: application/vnd.akamai.cps.enrollments.v11+json'

ENDPOINTS