Akamai APIs API Documentation
List change requests
GET https://{{host}}/hapi/v1/change-requests
Get the list of pending change requests for the logged-in account and context.
Body
PARAM
| Key | Datatype | Required | Description |
status
|
string | (Optional) __Enum__ Status of change requests to retrieve. The only currently available value is `PENDING`. | |
includeEdgeHostnames
|
string | (Optional) Whether to include edge hostname data in the response, `false` by default. | |
includeMappingBehaviors
|
string | (Optional) Whether to include edge hostnames' mapping behaviors in the response, `false` by default. | |
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
| {
"changeRequests": [
{
"action": "EDIT",
"changeId": 2,
"comments": "Editing CNAME",
"edgeHostnames": [
{
"comments": "Created for site",
"dnsZone": "edgesuite.net",
"edgeHostnameId": 2,
"ipVersionBehavior": "IPV4",
"map": "a;g.akamai.net",
"productId": "DSA",
"recordName": "www.examples.com",
"securityType": "STANDARD-TLS",
"serialNumber": 140,
"ttl": 21600,
"useDefaultMap": true,
"useDefaultTtl": true
}
],
"status": "PENDING",
"statusMessage": "File uploaded and awaiting validation",
"statusUpdateDate": "2018-10-17T20:21:17.0Z",
"statusUpdateEmail": "nobody@akamai.com",
"submitDate": "2018-10-17T20:21:12.0Z",
"submitter": "nobody",
"submitterEmail": "nobody@akamai.com"
},
{
"action": "CREATE",
"changeId": 1,
"comments": "Created for example.com",
"edgeHostnames": [
{
"comments": "Edited for Super Bowl",
"dnsZone": "edgekey.net",
"edgeHostnameId": 1,
"ipVersionBehavior": "IPV4",
"map": "e;b.akamaiedge.net",
"recordName": "www.example.com",
"securityType": "ENHANCED-TLS",
"slotNumber": 11838,
"ttl": 21600,
"useDefaultMap": false,
"useDefaultTtl": false
}
],
"status": "PENDING",
"statusMessage": "File uploaded and awaiting validation",
"statusUpdateDate": "2018-10-17T20:21:17.0Z",
"statusUpdateEmail": "nobody@akamai.com",
"submitDate": "2018-10-17T20:21:12.0Z",
"submitter": "nobody",
"submitterEmail": "nobody@akamai.com"
}
]
} |
Curl
curl -X GET 'https://undefined/hapi/v1/change-requests?status=&includeEdgeHostnames=&includeMappingBehaviors=&accountSwitchKey=' -H 'Accept: application/json'
ENDPOINTS