Akamai APIs API Documentation
Check a GREP request status
GET https://{{host}}/edge-diagnostics/v1/grep/requests/:requestId
Returns the status of the asynchronous Launch a GREP request request. Operations with the SUCCESS status include also the grep logs.
Body
PARAM
| Key | Datatype | Required | Description |
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
| {
"completedTime": "2021-04-15T07:49:15Z",
"createdBy": "jkowalski",
"createdTime": "2021-04-15T07:48:30Z",
"edgeIpLocation": {
"asNumber": 9498,
"city": "BANGALORE",
"countryCode": "IN",
"regionCode": "KA"
},
"executionStatus": "SUCCESS",
"logLinesCount": 2,
"request": {
"arls": {
"comparison": "CONTAINS",
"value": [
"freeflow.mdt.akamai.com/TopLevel.incr.idx"
]
},
"clientIps": [
"192.0.2.9"
],
"cpCodes": [
1234567
],
"edgeIp": "192.0.2.0",
"end": "2022-03-15T06:08:43.000Z",
"httpStatusCodes": {
"comparison": "EQUALS",
"value": [
"200",
"201"
]
},
"logType": "BOTH",
"start": "2022-03-15T06:08:40.000Z",
"userAgents": [
"firefox"
]
},
"requestId": 365,
"result": {
"legend": {
"fObjectStatus": {
"W": "The object TTL was set in response headers."
},
"fObjectStatus2": {},
"fObjectStatus3": {},
"logType": {
"f": "(f) going forward to forward hostname",
"r": "(r) response to client"
},
"rObjectStatus": {
"W": "The object TTL was set in response headers."
},
"rObjectStatus2": {
"N": "The request was processed over an anycast VIP and is marked as zero rated billing request.",
"o": "The origin server was contacted for the request.",
"x": "Either 'no-store' is turned on by metadata and not disabled by \"!no-store\" in the response or the downstream TTL was set by metadata and not by the response header."
},
"rObjectStatus3": {}
},
"logs": [
{
"arl": "/D/1682/1234567/000/example.com./ERR_READ_TIMEOUT",
"bytesReceived": "-",
"bytesServed": "568",
"clientIp": "192.0.2.6",
"contentBytesServed": "250",
"contentType": "text/html",
"cookie": "-",
"cpCode": "1234567",
"dateTime": "2021-08-24T10:14:09.306Z",
"edgeIp": "192.0.2.10",
"error": "ERR_READ_TIMEOUT|before_resp_hdrs",
"forwardIp": "-",
"hostHeader": "etranslator.edgesuite.net",
"httpMethod": "GET",
"httpStatus": "504",
"logType": "r",
"objectSize": "250",
"objectStatus": "W",
"objectStatus2": "xNo",
"objectStatus3": "-",
"referer": "-",
"sslVersion": "TLSv1.2",
"timeTaken": "0",
"turnaroundTime": "598",
"userAgent": "Mozilla/5.0%20(Macintosh;%20Intel%20Mac%20OS%20X%2010_15_7)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/92.0.4515.159%20Safari/537.36"
},
{
"arl": "/D/1682/1234567/000/example.com./ERR_READ_TIMEOUT",
"bytesReceived": "0",
"bytesServed": "-",
"clientIp": "192.0.2.6",
"contentBytesServed": "-",
"contentType": "-",
"cookie": "-",
"cpCode": "1234567",
"dateTime": "2021-08-24T10:14:09.356Z",
"edgeIp": "192.0.2.10",
"error": "-",
"forwardIp": "192.0.2.11",
"hostHeader": "-",
"httpMethod": "GET",
"httpStatus": "0",
"logType": "f",
"objectSize": "-",
"objectStatus": "W",
"objectStatus2": "-",
"objectStatus3": "-",
"referer": "-",
"sslVersion": "TLSv1.2",
"timeTaken": "0",
"turnaroundTime": "0",
"userAgent": "-"
}
]
},
"suggestedActions": [
"Check for long times.",
"Check content length/bytes served."
]
} |
Curl
curl -X GET 'https://undefined/edge-diagnostics/v1/grep/requests/:requestId?accountSwitchKey=' -H 'Accept: application/json'
ENDPOINTS