Akamai APIs API Documentation
Get diagnostic data for an end user group
GET https://{{host}}/edge-diagnostics/v1/user-diagnostic-data/groups/:groupId/records
Returns collected diagnostic data for a specific group. You can also request additional cURL, DIG, and MTR data. To get the groupId value, run the List groups operation first.
Body
PARAM
| Key | Datatype | Required | Description |
includeCurl
|
string | (Optional) Includes `curl` results in the response. | |
includeDig
|
string | (Optional) Includes `dig` results in the response. | |
includeMtr
|
string | (Optional) Includes MTR results in the response. | |
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
| {
"createdBy": "szhang",
"createdTime": "2021-07-24T04:25:40Z",
"diagnosticLink": "www.t1info.net/623b8c",
"diagnosticLinkStatus": "ACTIVE",
"expiryTime": "2021-07-31T04:25:40Z",
"groupId": "623b8c",
"note": "Diagnostic group",
"records": [
{
"cipher": "tls1.3/TLS_AES_256_GCM_SHA384",
"clientDnsIpv4": {
"id": 1357,
"ip": "2001.db8..3/33",
"ipLocation": {
"asNumber": 9498,
"city": "BANGALORE",
"countryCode": "IN",
"regionCode": "KA"
},
"ipType": "DNS_IPV4"
},
"clientDnsIpv6": {
"ecs": "192.0.2.196/24",
"id": 1359,
"ip": "2001:db8::1",
"ipLocation": {
"asNumber": 20940,
"city": "CHENNAI",
"countryCode": "IN",
"regionCode": "TN"
},
"ipType": "DNS_IPV6"
},
"clientIpv4": {
"associatedDnsId": 1362,
"id": 1363,
"ip": "192.0.2.6",
"ipLocation": {
"asNumber": 9583,
"city": "BANGALORE",
"countryCode": "IN",
"regionCode": "KA"
},
"ipType": "CLIENT_IPV4"
},
"clientIpv6": {
"associatedDnsId": 1362,
"id": 1364,
"ip": "2001:db8::2",
"ipLocation": {
"asNumber": 9583,
"city": "BANGALORE",
"countryCode": "IN",
"regionCode": "KA"
},
"ipType": "CLIENT_IPV6"
},
"cookie": true,
"createdEpoch": 1625652686,
"createdTime": "2021-07-24T04:25:40Z",
"curlResults": [
{
"createdBy": "jkowalski",
"createdTime": "2021-07-07T10:11:36Z",
"executionStatus": "SUCCESS",
"internalIp": "192.0.2.3",
"regionId": 24958,
"request": {
"edgeIds": [
1358
],
"ipVersion": "IPV4",
"requestHeaders": [
"User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36"
],
"url": "https://www.example.com"
},
"requestId": 164,
"result": {
"httpStatusCode": 200,
"httpVersion": "HTTP/2",
"reasonPhrase": "",
"responseBody": "\n\n\n <!DOCTYPE HTML>\n <html class=\"spectrum--medium\" lang=\"en\">\n <head>\n <title>Diagnostic: Creative, marketing and document management solutions</title>\n <link rel=\"canonical\" href=\"https://www.example.com/\"/>",
"responseHeaderList": [
"x-adobe-source: 130.109",
"date: Wed, 07 Jul 2021 10:11:53 GMT",
"server: Apache"
],
"timing": {
"dnsLookupTime": 1.509502,
"sslConnectionTime": 0,
"tcpConnectionTime": 1.524193,
"timeToFirstByte": 1.555875,
"totalTime": 2.091051
}
}
}
],
"digResults": [
{
"createdBy": "alfulani",
"createdTime": "2021-07-07T10:11:36Z",
"executionStatus": "SUCCESS",
"internalIp": "192.0.2.3",
"regionId": 24958,
"request": {
"edgeIds": [
1358
],
"hostname": "www.example.com",
"queryType": "A"
},
"requestId": 164,
"result": {
"answerSection": [
{
"hostname": "www.example.com.",
"preferenceValue": null,
"recordClass": "IN",
"recordType": "CNAME",
"ttl": 300,
"value": "stls.adobe.com-cn.edgesuite.net."
}
],
"result": "\n; <<>> DiG 9.11.3-1ubuntu1.13aka10.0.7-Ubuntu <<>> www.example.com -t A\n;; global options: +cmd\n;; Got answer:\n;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 20305\n;; flags: qr rd ra; QUERY: 1, ANSWER: 5, AUTHORITY: 0, ADDITIONAL: 1\n\n;; OPT PSEUDOSECTION:\n; EDNS: version: 0, flags:; udp: 4096\n; COOKIE: f63246c34028a86a76559c2960e57de371eed2a32f03954b (good)\n;; QUESTION SECTION:\n;www.example.com.\t\t\tIN\tA\n\n;; ANSWER SECTION:\nwww.example.com.\t\t300\tIN\tCNAME\tstls.adobe.com-cn.edgesuite.net.\nstls.adobe.com-cn.edgesuite.net. 300 IN\tCNAME\tstls.adobe.com-cn.edgesuite.net.globalredir.akadns.net.\nstls.adobe.com-cn.edgesuite.net.globalredir.akadns.net.\t900 IN CNAME a1815.dscr.akamai.net.\na1815.dscr.akamai.net.\t20\tIN\tA\t23.3.70.145\na1815.dscr.akamai.net.\t20\tIN\tA\t23.3.70.174\n\n;; Query time: 358 msec\n;; SERVER: 127.0.0.1#53(127.0.0.1)\n;; WHEN: Wed Jul 07 10:11:47 UTC 2021\n;; MSG SIZE rcvd: 250\n"
}
}
],
"edgeIps": [
{
"associatedDnsId": 1357,
"id": 1358,
"ip": "192.0.2.4",
"ipLocation": {
"asNumber": 9498,
"city": "BANGALORE",
"countryCode": "IN",
"regionCode": "KA"
},
"ipType": "EDGE_IP",
"regionId": 24958
}
],
"mtrResults": [
{
"createdBy": "tyamada",
"createdTime": "2021-07-07T10:11:36Z",
"executionStatus": "SUCCESS",
"regionId": 24958,
"request": {
"destinationId": 1360,
"ipVersion": "IPV6",
"packetType": "TCP",
"port": 80,
"sourceIds": [
1358
]
},
"requestId": 164,
"result": {
"averageLatency": 0,
"hops": [
{
"averageLatency": 2.6,
"bestRtt": 0.3,
"host": "g2600-1417-0053-0000-0000-0000-0000-0001.deploy.static.akamaitechnologies.com",
"lastPacketLatency": 0.4,
"number": 1,
"packetLoss": 0,
"sentPackets": 10,
"standardDeviation": 5.5,
"worstRtt": 18
}
],
"host": "a23-3-70-164.deploy.akamaitechnologies.com",
"packetLoss": 100,
"result": "Start: 2021-07-07T10:11:47+0000\nHOST: a23-3-70-164.deploy.akamaitechnologies.com Loss% Snt Last Avg Best Wrst StDev\n 1.|-- g2600-1417-0053-0000-0000-0000-0000-0001.deploy.static.akamaitechnologies.com (2 0.0% 10 0.4 2.6 0.3 18.0 5.5\n 2.|-- 2404:a800::60 0.0% 10 1.2 3.4 0.9 24.4 7.4\n 3.|-- 2404:a800:3a00::1ba 0.0% 10 1.9 1.9 1.7 2.0 0.1\n 4.|-- ??? 100.0 10 0.0 0.0 0.0 0.0 0.0",
"startTime": 1625652707
},
"sourceInternalIp": "192.0.2.3"
}
],
"preferredClientIp": {
"associatedDnsId": 1359,
"id": 1360,
"ip": "2001:db8::2",
"ipLocation": {
"asNumber": 9583,
"city": "BANGALORE",
"countryCode": "IN",
"regionCode": "KA"
},
"ipType": "PREFERRED_CLIENT_IP"
},
"protocol": "HTTP/2",
"uniqueId": 1,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36"
}
],
"submissionsRemaining": 49,
"url": "https://www.example.com"
} |
Curl
curl -X GET 'https://undefined/edge-diagnostics/v1/user-diagnostic-data/groups/:groupId/records?includeCurl=&includeDig=&includeMtr=&accountSwitchKey=' -H 'Accept: application/json'
ENDPOINTS